Php/docs/class.cachingiterator

From Get docs

(PHP 5, PHP 7)

Introduction

This object supports cached iteration over another iterator.


Class synopsis


CachingIterator extends IteratorIterator implements OuterIterator , ArrayAccess , Countable {

/* Constants */

const int CALL_TOSTRING = 1

const int CATCH_GET_CHILD = 16

const int TOSTRING_USE_KEY = 2

const int TOSTRING_USE_CURRENT = 4

const int TOSTRING_USE_INNER = 8

const int FULL_CACHE = 256

/* Methods */

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

public count ( ) : int

public current ( ) : mixed

public getCache ( ) : array

public getFlags ( ) : int

public getInnerIterator ( ) : Iterator

public hasNext ( ) : void

public key ( ) : scalar

public next ( ) : void

public offsetExists ( mixed $index ) : void

public offsetGet ( string $index ) : void

public offsetSet ( mixed $index , mixed $newval ) : void

public offsetUnset ( string $index ) : void

public rewind ( ) : void

public setFlags ( int $flags ) : void

public __toString ( ) : void

public 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