CachingIterator (class)

The CachingIterator class

Introduction

(PHP 5, PHP 7)

This object supports cached iteration over another iterator.

Class synopsis

CachingIterator extends IteratorIterator implements OuterIterator , ArrayAccess , Countable {

/* Constants */

const integer CALL_TOSTRING = 1 ;

const integer CATCH_GET_CHILD = 16 ;

const integer TOSTRING_USE_KEY = 2 ;

const integer TOSTRING_USE_CURRENT = 4 ;

const integer TOSTRING_USE_INNER = 8 ;

const integer FULL_CACHE = 256 ;

/* Methods */

public __construct ( Iterator $iterator [, int $flags = self::CALL_TOSTRING ] )

public int count ( void )

public void current ( void )

public array getCache ( void )

public int getFlags ( void )

public Iterator getInnerIterator ( void )

public void hasNext ( void )

public scalar key ( void )

public void next ( void )

public void offsetExists ( string $index )

public void offsetGet ( string $index )

public void offsetSet ( string $index , string $newval )

public void offsetUnset ( string $index )

public void rewind ( void )

public void setFlags ( int $flags )

public void __toString ( void )

public void valid ( void )

}

Predefined Constants

CachingIterator::CALL_TOSTRING

Convert every element to string.

CachingIterator::CATCH_GET_CHILD

Don't throw exception in accessing children.

CachingIterator::TOSTRING_USE_KEY

Use key for conversion to string.

CachingIterator::TOSTRING_USE_CURRENT

Use current for conversion to string.

CachingIterator::TOSTRING_USE_INNER

Use inner for conversion to string.

CachingIterator::FULL_CACHE

Cache all read data.

Table of Contents

• CachingIterator::__construct — Construct a new CachingIterator object for the iterator.

• CachingIterator::count — The number of elements in the iterator

• CachingIterator::current — Return the current element

• CachingIterator::getCache — Retrieve the contents of the cache

• CachingIterator::getFlags — Get flags used

• CachingIterator::getInnerIterator — Returns the inner iterator

• CachingIterator::hasNext — Check whether the inner iterator has a valid next element

• CachingIterator::key — Return the key for the current element

• CachingIterator::next — Move the iterator forward

• CachingIterator::offsetExists — The offsetExists purpose

• CachingIterator::offsetGet — The offsetGet purpose

• CachingIterator::offsetSet — The offsetSet purpose

• CachingIterator::offsetUnset — The offsetUnset purpose

• CachingIterator::rewind — Rewind the iterator

• CachingIterator::setFlags — The setFlags purpose

• CachingIterator::__toString — Return the string representation of the current element

• CachingIterator::valid — Check whether the current element is valid

← ArrayIterator::valid

CachingIterator::__construct →

 © 1997–2017 The PHP Documentation Group

Licensed under the Creative Commons Attribution License v3.0 or later.

https://secure.php.net/manual/en/class.cachingiterator.php