Class ResultSet

__constructsource public

__construct( Cake\ORM\Query $query , Cake\Database\StatementInterface $statement )

Constructor

Parameters

Cake\ORM\Query $query

Query from where results come

Cake\Database\StatementInterface $statement

The statement to fetch from

__debugInfosource public

__debugInfo( )

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

Returns

_calculateAssociationMapsource protected

_calculateAssociationMap( Cake\ORM\Query $query )

Calculates the list of associations that should get eager loaded when fetching each record

Parameters

Cake\ORM\Query $query

The query from where to derive the associations

_calculateColumnMapsource protected

_calculateColumnMap( Cake\ORM\Query $query )

Creates a map of row keys out of the query select clause that can be used to hydrate nested result sets more quickly.

Parameters

Cake\ORM\Query $query

The query from where to derive the column map

_calculateTypeMapsource protected

_calculateTypeMap( )

Creates a map of Type converter classes for each of the columns that should be fetched by this object.

_castValuessource protected

_castValues( string $alias , array $values )

Casts all values from a row brought from a table to the correct PHP type.

Parameters

string $alias

The table object alias

array $values

The values to cast

Returns

_fetchResultsource protected

_fetchResult( )

Helper function to fetch the next result from the statement or seeded results.

Returns

_getTypessource protected

_getTypes( Cake\ORM\Table $table , array $fields )

Returns the Type classes for each of the passed fields belonging to the table.

Parameters

Cake\ORM\Table $table

The table from which to get the schema

array $fields

The fields whitelist to use for fields in the schema.

Returns

_groupResultsource protected

_groupResult( mixed $row )

Correctly nests results keys including those coming from associations

Parameters

mixed $row

Array containing columns and values or false if there is no results

Returns

countsource public

count( )

Gives the number of rows in the result set.

Part of the Countable interface.

Returns

currentsource public

current( )

Returns the current record in the result iterator

Part of Iterator interface.

Returns

firstsource public

first( )

Get the first record from a result set.

This method will also close the underlying statement cursor.

Returns

Implementation of

keysource public

key( )

Returns the key of the current record in the iterator

Part of Iterator interface.

Returns

nextsource public

next( )

Advances the iterator pointer to the next record

Part of Iterator interface.

rewindsource public

rewind( )

Rewinds a ResultSet.

Part of Iterator interface.

Throws

serializesource public

serialize( )

Serializes a resultset.

Part of Serializable interface.

Returns

unserializesource public

unserialize( string $serialized )

Unserializes a resultset.

Part of Serializable interface.

Parameters

string $serialized

Serialized object

validsource public

valid( )

Whether there are more results to be fetched from the iterator

Part of Iterator interface.

Returns

_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

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