Class ZipIterator

Creates an iterator that returns elements grouped in pairs

Example

$iterator = new ZipIterator([[1, 2], [3, 4]]);
 $iterator->toList(); // Returns [[1, 3], [2, 4]]

You can also chose a custom function to zip the elements together, such as doing a sum by index:

Example

$iterator = new ZipIterator([[1, 2], [3, 4]], function ($a, $b) {
   return $a + $b;
 });
 $iterator->toList(); // Returns [4, 6]

MultipleIterator implements Iterator, Traversable

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

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

Inherited Constants

MIT_KEYS_ASSOC, MIT_KEYS_NUMERIC, MIT_NEED_ALL, MIT_NEED_ANY

Properties summary

$_callback protected

callable

The function to use for zipping items together
$_iterators protected

array

Contains the original iterator objects that were attached

Method Summary

__construct() public

Creates the iterator to merge together the values by for all the passed iterators by their corresponding index.
current() public

Returns the value resulting out of zipping all the elements for all the iterators with the same positional index.
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 ZipIterator instance

Method Detail

__construct() public ¶

__construct( array $sets , callable|null $callable null )

Creates the iterator to merge together the values by for all the passed iterators by their corresponding index.

Parameters

array $sets: The list of array or iterators to be zipped.
callable|null $callable optional null: The function to use for zipping the elements of each iterator.

Overrides

MultipleIterator::__construct()

current() public ¶

current( )

Returns the value resulting out of zipping all the elements for all the iterators with the same positional index.

Returns

mixed

Overrides

MultipleIterator::current()

Implementation of

Iterator::current()

serialize() public ¶

serialize( )

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

Returns

string

Implementation of

Serializable::serialize()

unserialize() public ¶

unserialize( string $iterators )

Unserializes the passed string and rebuilds the ZipIterator instance

Parameters

string $iterators: The serialized iterators

Implementation of

Serializable::unserialize()

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 )

count() public ¶

count( )

Returns

integer

countBy() public ¶

countBy( $callback )

countKeys() public ¶

countKeys( )

Returns

integer

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

`$_callback` ¶

protected callable

The function to use for zipping items together

`$_iterators` ¶

protected array

Contains the original iterator objects that were attached

[]

Namespaces

Classes

Class ZipIterator

Example

Example

Inherited Constants

Properties summary

Method Summary

__construct() public

current() public

serialize() public

unserialize() public

Method Detail

__construct() public ¶

Parameters

Overrides

current() public ¶

Returns

Overrides

Implementation of

serialize() public ¶

Returns

Implementation of

unserialize() public ¶

Parameters

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 ¶

count() public ¶

Returns

countBy() public ¶

countKeys() public ¶

Returns

each() public ¶

every() public ¶

extract() public ¶

filter() public ¶

Returns

first() public ¶

firstMatch() public ¶

groupBy() public ¶

indexBy() public ¶

insert() public ¶

Returns

isEmpty() public ¶

jsonSerialize() public ¶

last() public ¶

lazy() public ¶

listNested() public ¶

Returns

map() public ¶

Returns

match() public ¶

max() public ¶

median() public ¶

min() public ¶

nest() public ¶

optimizeUnwrap() protected ¶

Returns

prepend() public ¶

prependItem() public ¶

reduce() public ¶

reject() public ¶

Returns

sample() public ¶

shuffle() public ¶

`$_callback` ¶

`$_iterators` ¶