PHP | CachingIterator getInnerIterator() Function

The CachingIterator::getInnerIterator() function is an inbuilt function in PHP which is used to return the iterator sent to the constructor.

Syntax:

Iterator CachingIterator::getInnerIterator( void )

Parameters: This function does not accept any parameters.

Return Value: This function returns an object implementing the Iterator interface.

Below programs illustrate the CachingIterator::getInnerIterator() function in PHP:

Program 1:

<?php

// Declare an array
$arr = array('G', 'e', 'e', 'k', 's');

// Create a new CachingIterator
$cachIt = new CachingIterator(
    new ArrayIterator($arr),
    CachingIterator::FULL_CACHE
);

foreach($cachIt as $element) {

    echo $element;

    if($cachIt->hasNext()) {
        echo ", ";
    }
}

?>

Output:

G, e, e, k, s

Program 2:

<?php

// Declare an ArrayIterator
$arr = array(
    "a" => "Geeks",
    "b" => "for",
    "c" => "Geeks",
    "d" => "Computer",
    "e" => "Science",
    "f" => "Portal"
);

// Create a new CachingIterator
$cachIt = new CachingIterator(
    new ArrayIterator($arr),
    CachingIterator::FULL_CACHE
);

foreach($cachIt as $key => $value) {

    echo $key . " => " . $value;

    if($cachIt->hasNext()) {
        echo "\n";
    }
}

?>

Output:

a => Geeks
b => for
c => Geeks
d => Computer
e => Science
f => Portal