Class BufferedIterator

Creates an iterator from another iterator that will keep the results of the inner iterator in memory, so that results don't have to be re-calculated.

IteratorIterator implements Iterator, Traversable, OuterIterator

Cake\Collection\Collection implements Cake\Collection\CollectionInterface, Serializable uses Cake\Collection\CollectionTrait

Cake\Collection\Iterator\BufferedIterator implements Countable, Serializable

Namespace: Cake\Collection\Iterator
Location: Collection/Iterator/BufferedIterator.php

Properties summary

$_buffer protected

SplDoublyLinkedList

The in-memory cache containing results from previous iterators
$_current protected

mixed

Last record fetched from the inner iterator
$_finished protected

boolean

Whether or not the internal iterator has reached its end.
$_index protected

integer

Points to the next record number that should be fetched
$_key protected

mixed

Last key obtained from the inner iterator
$_started protected

boolean

Whether or not the internal iterator's rewind method was already called

Method Summary

__construct() public

Maintains an in-memory cache of the results yielded by the internal iterator.
count() public

Returns the number or items in this collection
current() public

Returns the current record in the iterator
key() public

Returns the current key in the iterator
next() public

Advances the iterator pointer to the next element
rewind() public

Rewinds the collection
serialize() public

Returns a string representation of this object that can be used to reconstruct it
unserialize() public

Unserializes the passed string and rebuilds the BufferedIterator instance
valid() public

Returns whether or not the iterator has more elements

Method Detail

__construct() public ¶

__construct( array|Traversable $items )

Maintains an in-memory cache of the results yielded by the internal iterator.

Parameters

array|Traversable $items: The items to be filtered.

Throws

InvalidArgumentException
If passed incorrect type for items.

Overrides

Cake\Collection\Collection::__construct()

count() public ¶

count( )

Returns the number or items in this collection

Returns

integer

Overrides

Cake\Collection\Collection::count()

Implementation of

Countable::count()

current() public ¶

current( )

Returns the current record in the iterator

Returns

mixed

Overrides

IteratorIterator::current()

key() public ¶

key( )

Returns the current key in the iterator

Returns

mixed

Overrides

IteratorIterator::key()

next() public ¶

next( )

Advances the iterator pointer to the next element

Overrides

IteratorIterator::next()

rewind() public ¶

rewind( )

Rewinds the collection

Overrides

IteratorIterator::rewind()

serialize() public ¶

serialize( )

Returns a string representation of this object that can be used to reconstruct it

Returns

string

Overrides

Cake\Collection\Collection::serialize()

Implementation of

Serializable::serialize()

unserialize() public ¶

unserialize( string $buffer )

Unserializes the passed string and rebuilds the BufferedIterator instance

Parameters

string $buffer: The serialized buffer iterator

Overrides

Cake\Collection\Collection::unserialize()

Implementation of

Serializable::unserialize()

valid() public ¶

valid( )

Returns whether or not the iterator has more elements

Returns

boolean

Overrides

IteratorIterator::valid()

Methods inherited from Cake\Collection\Collection

__debugInfo() public ¶

__debugInfo( )

Returns an array that can be used to describe the internal state of this object.

Returns

array

countKeys() public ¶

countKeys( )

Returns the number of unique keys in this iterator. This is, the number of elements the collection will contain after calling toArray()

Returns

integer

Implementation of

Cake\Collection\CollectionInterface::countKeys()

Methods used from Cake\Collection\CollectionTrait

_unwrap() public ¶

_unwrap( )

append() public ¶

append( $items )

appendItem() public ¶

appendItem( $item , $key null )

avg() public ¶

avg( $matcher null )

buffered() public ¶

buffered( )

Returns

Cake\Collection\Iterator\BufferedIterator

cartesianProduct() public ¶

cartesianProduct( callable $operation null , callable $filter null )

Parameters

callable $operation optional null: Operation
callable $filter optional null: Filter

Returns

Cake\Collection\CollectionInterface

Throws

LogicException

chunk() public ¶

chunk( $chunkSize )

chunkWithKeys() public ¶

chunkWithKeys( $chunkSize , $preserveKeys true )

combine() public ¶

combine( $keyPath , $valuePath , $groupPath null )

compile() public ¶

compile( $preserveKeys true )

contains() public ¶

contains( $value )

countBy() public ¶

countBy( $callback )

each() public ¶

each( callable $c )

every() public ¶

every( callable $c )

extract() public ¶

extract( $matcher )

filter() public ¶

filter( callable $c null )

Returns

Cake\Collection\Iterator\FilterIterator

first() public ¶

first( )

firstMatch() public ¶

firstMatch( array $conditions )

groupBy() public ¶

groupBy( $callback )

indexBy() public ¶

indexBy( $callback )

insert() public ¶

insert( $path , $values )

Returns

Cake\Collection\Iterator\InsertIterator

isEmpty() public ¶

isEmpty( )

jsonSerialize() public ¶

jsonSerialize( )

last() public ¶

last( )

lazy() public ¶

lazy( )

listNested() public ¶

listNested( $dir 'desc' , $nestingKey 'children' )

Returns

Cake\Collection\Iterator\TreeIterator

map() public ¶

map( callable $c )

Returns

Cake\Collection\Iterator\ReplaceIterator

match() public ¶

match( array $conditions )

max() public ¶

max( $callback , $type \SORT_NUMERIC )

median() public ¶

median( $matcher null )

min() public ¶

min( $callback , $type \SORT_NUMERIC )

nest() public ¶

nest( $idPath , $parentPath , $nestingKey 'children' )

optimizeUnwrap() protected ¶

optimizeUnwrap( )

Unwraps this iterator and returns the simplest traversable that can be used for getting the data out

Returns

Traversable|array

prepend() public ¶

prepend( $items )

prependItem() public ¶

prependItem( $item , $key null )

reduce() public ¶

reduce( callable $c , $zero null )

reject() public ¶

reject( callable $c )

Returns

Cake\Collection\Iterator\FilterIterator

sample() public ¶

sample( $size 10 )

shuffle() public ¶

shuffle( )

skip() public ¶

skip( $howMany )

some() public ¶

some( callable $c )

sortBy() public ¶

sortBy( $callback , $dir \SORT_DESC , $type \SORT_NUMERIC )

stopWhen() public ¶

stopWhen( $condition )

Returns

Cake\Collection\Iterator\StoppableIterator

sumOf() public ¶

sumOf( $matcher null )

take() public ¶

take( $size 1 , $from 0 )

takeLast() public ¶

takeLast( $howMany )

through() public ¶

through( callable $handler )

toArray() public ¶

toArray( $preserveKeys true )

toList() public ¶

toList( )

transpose() public ¶

transpose( )

Returns

Cake\Collection\CollectionInterface

Throws

LogicException

unfold() public ¶

unfold( callable $transformer null )

unwrap() public ¶

unwrap( )

zip() public ¶

zip( $items )

zipWith() public ¶

zipWith( $items , $callable )

Magic methods inherited from Cake\Collection\CollectionInterface


				cartesianProduct()

Properties detail

`$_buffer` ¶

protected SplDoublyLinkedList

The in-memory cache containing results from previous iterators

`$_current` ¶

protected mixed

Last record fetched from the inner iterator

`$_finished` ¶

protected boolean

Whether or not the internal iterator has reached its end.

false

`$_index` ¶

protected integer

Points to the next record number that should be fetched

`$_key` ¶

protected mixed

Last key obtained from the inner iterator

`$_started` ¶

protected boolean

Whether or not the internal iterator's rewind method was already called

false

Namespaces

Classes

Class BufferedIterator

Properties summary

Method Summary

__construct() public

count() public

current() public

key() public

next() public

rewind() public

serialize() public

unserialize() public

valid() public

Method Detail

__construct() public ¶

Parameters

Throws

Overrides

count() public ¶

Returns

Overrides

Implementation of

current() public ¶

Returns

Overrides

key() public ¶

Returns

Overrides

next() public ¶

Overrides

rewind() public ¶

Overrides

serialize() public ¶

Returns

Overrides

Implementation of

unserialize() public ¶

Parameters

Overrides

Implementation of

valid() public ¶

Returns

Overrides

Methods inherited from Cake\Collection\Collection

__debugInfo() public ¶

Returns

countKeys() public ¶

Returns

Implementation of

Methods used from Cake\Collection\CollectionTrait

_unwrap() public ¶

append() public ¶

appendItem() public ¶

avg() public ¶

buffered() public ¶

Returns

cartesianProduct() public ¶

Parameters

Returns

Throws

chunk() public ¶

chunkWithKeys() public ¶

combine() public ¶

compile() public ¶

contains() public ¶

countBy() public ¶

each() public ¶

every() public ¶

extract() public ¶

filter() public ¶

Returns

first() public ¶

firstMatch() public ¶

groupBy() public ¶

indexBy() public ¶

insert() public ¶

Returns

isEmpty() public ¶

jsonSerialize() public ¶

`$_buffer` ¶

`$_current` ¶

`$_finished` ¶

`$_index` ¶

`$_key` ¶

`$_started` ¶