Class SortIterator

An iterator that will return the passed items in order. The order is given by the value returned in a callback function that maps each of the elements.

Example:

$items = [$user1, $user2, $user3];
$sorted = new SortIterator($items, function ($user) {
 return $user->age;
});

// output all user name order by their age in descending order
foreach ($sorted as $user) {
 echo $user->name;
}

This iterator does not preserve the keys passed in the original elements.

IteratorIterator implements Iterator, Traversable, OuterIterator

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

Cake\Collection\Iterator\SortIterator

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

Method Summary

__construct() public

Wraps this iterator around the passed items so when iterated they are returned in order.

Method Detail

__construct() public ¶

__construct( array|Traversable $items , callable|string $callback , integer $dir = SORT_DESC , integer $type = SORT_NUMERIC )

Wraps this iterator around the passed items so when iterated they are returned in order.

The callback will receive as first argument each of the elements in $items, the value returned in the callback will be used as the value for sorting such element. Please note that the callback function could be called more than once per element.

Parameters

array|Traversable $items: The values to sort
callable|string $callback: A function used to return the actual value to be compared. It can also be a string representing the path to use to fetch a column or property in each element
integer $dir optional SORT_DESC: either SORT_DESC or SORT_ASC
integer $type optional SORT_NUMERIC: the type of comparison to perform, either SORT_STRING SORT_NUMERIC or SORT_NATURAL

Throws

InvalidArgumentException
If passed incorrect type for items.

Overrides

Cake\Collection\Collection::__construct()

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

Throws an exception.

Issuing a count on a Collection can have many side effects, some making the Collection unusable after the count operation.

Throws

LogicException

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 deprecated ¶

_unwrap( )

Backwards compatible wrapper for unwrap()

Deprecated

Returns

Iterator

append() public ¶

append( $items )

buffered() public ¶

buffered( )

Returns

Cake\Collection\Iterator\BufferedIterator

chunk() public ¶

chunk( $chunkSize )

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

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 )

min() public ¶

min( $callback , $type = SORT_NUMERIC )

nest() public ¶

nest( $idPath , $parentPath )

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 )

through() public ¶

through( callable $handler )

toArray() public ¶

toArray( $preserveKeys = true )

toList() public ¶

toList( )

unfold() public ¶

unfold( callable $transformer = null )

unwrap() public ¶

unwrap( )

zip() public ¶

zip( $items )

zipWith() public ¶

zipWith( $items , $callable )

Namespaces

Classes

Class SortIterator

Example:

Method Summary

__construct() public

Method Detail

__construct() public ¶

Parameters

Throws

Overrides

Methods inherited from Cake\Collection\Collection

__debugInfo() public ¶

Returns

count() public ¶

Throws

serialize() public ¶

Returns

Implementation of

unserialize() public ¶

Parameters

Implementation of

Methods used from Cake\Collection\CollectionTrait

_unwrap() public deprecated ¶

Deprecated

Returns

append() public ¶

buffered() public ¶

Returns

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

listNested() public ¶

Returns

map() public ¶

Returns

match() public ¶

max() public ¶

min() public ¶

nest() public ¶

reduce() public ¶

reject() public ¶

Returns

sample() public ¶

shuffle() public ¶

skip() public ¶

some() public ¶

sortBy() public ¶

stopWhen() public ¶

Returns

sumOf() public ¶

take() public ¶

through() public ¶

toArray() public ¶

toList() public ¶

unfold() public ¶

unwrap() public ¶

zip() public ¶

zipWith() public ¶