ArrayObject::setIteratorClass

    (PHP 5 >= 5.1.0, PHP 7, PHP 8)

    ArrayObject::setIteratorClass — Sets the iterator classname for the ArrayObject

    Description

    publicArrayObject::setIteratorClass(string$iteratorClass): void

    Sets the classname of the array iterator that is used by ArrayObject::getIterator().

    Parameters

    iteratorClass

    The classname of the array iterator to use when iterating over this object.

    Return Values

    No value is returned.

    Examples

    Example #1 ArrayObject::setIteratorClass() example

    <?php
    // Custom ArrayIterator (inherits from ArrayIterator)
    class MyArrayIterator extends ArrayIterator {
    // custom implementation
    }

    // Array of available fruits
    $fruits = array("lemons" => 1, "oranges" => 4, "bananas" => 5, "apples" => 10);

    $fruitsArrayObject = new ArrayObject($fruits);

    // Set the iterator classname to the newly
    $fruitsArrayObject->setIteratorClass('MyArrayIterator');
    print_r($fruitsArrayObject->getIterator());

    ?>

    The above example will output:

    MyArrayIterator Object ( [lemons] => 1 [oranges] => 4 [bananas] => 5 [apples] => 10 )
    To Top