The CachingIterator class

(PHP 5, PHP 7, PHP 8)

Introduction

This object supports cached iteration over another iterator.

Class synopsis

class CachingIterator extends IteratorIterator implements ArrayAccess, Countable, Stringable {
/* 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 = CachingIterator::CALL_TOSTRING)
public count(): int
public current(): mixed
public getCache(): array
public getFlags(): int
public getInnerIterator(): Iterator
public hasNext(): bool
public key(): scalar
public next(): void
public offsetExists(string $key): bool
public offsetGet(string $key): mixed
public offsetSet(string $key, mixed $value): void
public offsetUnset(string $key): void
public rewind(): void
public setFlags(int $flags): void
public __toString(): string
public valid(): bool
/* Inherited methods */
public IteratorIterator::current(): mixed
public IteratorIterator::getInnerIterator(): ?Iterator
public IteratorIterator::key(): mixed
public IteratorIterator::next(): void
public IteratorIterator::rewind(): void
public IteratorIterator::valid(): bool
}

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.

Changelog

Version Description
8.0.0 CachingIterator implements Stringable now.

Table of Contents