Class ExtractIterator

Creates an iterator from another iterator that extract the requested column or property based on a path

IteratorIterator implements Iterator, Traversable, OuterIterator

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

Cake\Collection\Iterator\ExtractIterator

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

Properties summary

$_extractor protected

callable

A callable responsible for extracting a single value for each item in the collection.

Method Summary

__construct() public

Creates the iterator that will return the requested property for each value in the collection expressed in $path
current() public

Returns the column value defined in $path or null if the path could not be followed
unwrap() public

Method Detail

__construct() public ¶

__construct( array|Traversable $items , string $path )

Creates the iterator that will return the requested property for each value in the collection expressed in $path

Example:

Extract the user name for all comments in the array:

$items = [
 ['comment' => ['body' => 'cool', 'user' => ['name' => 'Mark']],
 ['comment' => ['body' => 'very cool', 'user' => ['name' => 'Renan']]
];
$extractor = new ExtractIterator($items, 'comment.user.name'');

Parameters

array|Traversable $items: The list of values to iterate
string $path: a dot separated string symbolizing the path to follow inside the hierarchy of each value so that the column can be extracted.

Throws

InvalidArgumentException
If passed incorrect type for items.

Overrides

Cake\Collection\Collection::__construct()

current() public ¶

current( )

Returns the column value defined in $path or null if the path could not be followed

Returns

mixed

Overrides

IteratorIterator::current()

unwrap() public ¶

unwrap( )

We perform here some strictness analysis so that the iterator logic is bypassed entirely.

Returns

Iterator

Overrides

Cake\Collection\CollectionTrait::unwrap()

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

count() public ¶

count( )

Returns the amount of elements in the collection.

Returns

integer

Implementation of

Cake\Collection\CollectionInterface::count()

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()

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 $collection )

Unserializes the passed string and rebuilds the Collection instance

Parameters

string $collection: The serialized collection

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 )

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 )

zip() public ¶

zip( $items )

zipWith() public ¶

zipWith( $items , $callable )

Magic methods inherited from Cake\Collection\CollectionInterface


				cartesianProduct()

Properties detail

`$_extractor` ¶

protected callable

A callable responsible for extracting a single value for each item in the collection.

Namespaces

Classes

Class ExtractIterator

Properties summary

Method Summary

__construct() public

current() public

unwrap() public

Method Detail

__construct() public ¶

Example:

Parameters

Throws

Overrides

current() public ¶

Returns

Overrides

unwrap() public ¶

Returns

Overrides

Methods inherited from Cake\Collection\Collection

__debugInfo() public ¶

Returns

count() public ¶

Returns

Implementation of

countKeys() public ¶

Returns

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 ¶

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 ¶

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 ¶

`$_extractor` ¶