countsource public

count( )

Make this object countable.

Part of the Countable interface. Calling this method will convert the underlying traversable object into an array and get the count of the underlying data.

Returns

Throws

Overrides

__constructsource public

__construct( array|Traversable $items )

Constructor. You can provide an array or any traversable object

Parameters

array|Traversable $items

Items.

Throws

Overrides

__debugInfosource public

__debugInfo( )

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

Returns

serializesource public

serialize( )

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

Returns

Implementation of

unserializesource public

unserialize( string $collection )

Unserializes the passed string and rebuilds the Collection instance

Parameters

string $collection

The serialized collection

Implementation of

_unwrapsource public

_unwrap( )

Backwards compatible wrapper for unwrap()

Deprecated

Returns

appendsource public

append( mixed $items )

Implementation of

bufferedsource public

buffered( )

Returns

Implementation of

chunksource public

chunk( mixed $chunkSize )

Implementation of

combinesource public

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

Implementation of

compilesource public

compile( mixed $preserveKeys true )

Implementation of

containssource public

contains( mixed $value )

Implementation of

countBysource public

countBy( mixed $callback )

Implementation of

eachsource public

each( callable $c )

Implementation of

everysource public

every( callable $c )

Implementation of

extractsource public

extract( mixed $matcher )

Implementation of

filtersource public

filter( callable $c null )

Returns

Implementation of

firstsource public

first( )

Implementation of

firstMatchsource public

firstMatch( array $conditions )

Implementation of

groupBysource public

groupBy( mixed $callback )

Implementation of

indexBysource public

indexBy( mixed $callback )

Implementation of

insertsource public

insert( mixed $path , mixed $values )

Returns

Implementation of

isEmptysource public

isEmpty( )

Implementation of

jsonSerializesource public

jsonSerialize( )

Implementation of

lastsource public

last( )

Implementation of

listNestedsource public

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

Returns

Implementation of

mapsource public

map( callable $c )

Returns

Implementation of

matchsource public

match( array $conditions )

Implementation of

maxsource public

max( mixed $callback , mixed $type SORT_NUMERIC )

Implementation of

minsource public

min( mixed $callback , mixed $type SORT_NUMERIC )

Implementation of

nestsource public

nest( mixed $idPath , mixed $parentPath )

Implementation of

reducesource public

reduce( callable $c , mixed $zero null )

Implementation of

rejectsource public

reject( callable $c )

Returns

Implementation of

samplesource public

sample( mixed $size 10 )

Implementation of

shufflesource public

shuffle( )

Implementation of

skipsource public

skip( mixed $howMany )

Implementation of

somesource public

some( callable $c )

Implementation of

sortBysource public

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

Implementation of

stopWhensource public

stopWhen( mixed $condition )

Returns

Implementation of

sumOfsource public

sumOf( mixed $matcher null )

Implementation of

takesource public

take( mixed $size 1 , mixed $from 0 )

Implementation of

throughsource public

through( callable $handler )

Implementation of

toArraysource public

toArray( mixed $preserveKeys true )

Implementation of

toListsource public

toList( )

Implementation of

unfoldsource public

unfold( callable $transformer null )

Implementation of

unwrapsource public

unwrap( )

Implementation of

zipsource public

zip( mixed $items )

Implementation of

zipWithsource public

zipWith( mixed $items , mixed $callable )

Implementation of

_createMatcherFiltersource protected

_createMatcherFilter( array $conditions )

Returns a callable that receives a value and will return whether or not it matches certain condition.

Parameters

array $conditions

A key-value list of conditions to match where the key is the property path to get from the current item and the value is the value to be compared the item with.

Returns

_extractsource protected

_extract( array|ArrayAccess $data , array $path )

Returns a column from $data that can be extracted by iterating over the column names contained in $path. It will return arrays for elements in represented with {*}

Parameters

array|ArrayAccess $data

Data.

array $path

Path to extract from.

Returns

_propertyExtractorsource protected

_propertyExtractor( string|callable $callback )

Returns a callable that can be used to extract a property or column from an array or object based on a dot separated path.

Parameters

string|callable $callback

A dot separated path of column to follow so that the final one can be returned or a callable that will take care of doing that.

Returns

_simpleExtractsource protected

_simpleExtract( array|ArrayAccess $data , array $path )

Returns a column from $data that can be extracted by iterating over the column names contained in $path

Parameters

array|ArrayAccess $data

Data.

array $path

Path to extract from.

Returns