\Cake\ORMResultSet

each()

each(callable  $c) 

{@inheritDoc}

Parameters

filter()

filter(callable  $c = null) : \Cake\Collection\Iterator\FilterIterator

{@inheritDoc}

Parameters

Returns

reject()

reject(callable  $c) : \Cake\Collection\Iterator\FilterIterator

{@inheritDoc}

Parameters

Returns

every()

every(callable  $c) 

{@inheritDoc}

Parameters

some()

some(callable  $c) 

{@inheritDoc}

Parameters

contains()

contains(  $value) 

{@inheritDoc}

Parameters

map()

map(callable  $c) : \Cake\Collection\Iterator\ReplaceIterator

{@inheritDoc}

Parameters

Returns

reduce()

reduce(callable  $c,   $zero = null) 

{@inheritDoc}

Parameters

extract()

extract(  $matcher) 

{@inheritDoc}

Parameters

max()

max(  $callback,   $type = \SORT_NUMERIC) 

{@inheritDoc}

Parameters

min()

min(  $callback,   $type = \SORT_NUMERIC) 

{@inheritDoc}

Parameters

avg()

avg(  $matcher = null) 

{@inheritDoc}

Parameters

median()

median(  $matcher = null) 

{@inheritDoc}

Parameters

sortBy()

sortBy(  $callback,   $dir = \SORT_DESC,   $type = \SORT_NUMERIC) 

{@inheritDoc}

Parameters

groupBy()

groupBy(  $callback) 

{@inheritDoc}

Parameters

indexBy()

indexBy(  $callback) 

{@inheritDoc}

Parameters

countBy()

countBy(  $callback) 

{@inheritDoc}

Parameters

sumOf()

sumOf(  $matcher = null) 

{@inheritDoc}

Parameters

shuffle()

shuffle() 

{@inheritDoc}

sample()

sample(  $size = 10) 

{@inheritDoc}

Parameters

take()

take(  $size = 1,   $from) 

{@inheritDoc}

Parameters

skip()

skip(  $howMany) 

{@inheritDoc}

Parameters

match()

match(array  $conditions) 

{@inheritDoc}

Parameters

firstMatch()

firstMatch(array  $conditions) 

{@inheritDoc}

Parameters

first()

first() : array|object

Get the first record from a result set.

This method will also close the underlying statement cursor.

Returns

last()

last() 

{@inheritDoc}

takeLast()

takeLast(  $howMany) 

{@inheritDoc}

Parameters

append()

append(  $items) 

{@inheritDoc}

Parameters

appendItem()

appendItem(  $item,   $key = null) 

{@inheritDoc}

Parameters

prepend()

prepend(  $items) 

{@inheritDoc}

Parameters

prependItem()

prependItem(  $item,   $key = null) 

{@inheritDoc}

Parameters

combine()

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

{@inheritDoc}

Parameters

nest()

nest(  $idPath,   $parentPath,   $nestingKey = 'children') 

{@inheritDoc}

Parameters

insert()

insert(  $path,   $values) : \Cake\Collection\Iterator\InsertIterator

{@inheritDoc}

Parameters

Returns

toArray()

toArray(  $preserveKeys = true) 

{@inheritDoc}

Parameters

toList()

toList() 

{@inheritDoc}

jsonSerialize()

jsonSerialize() 

{@inheritDoc}

compile()

compile(  $preserveKeys = true) 

{@inheritDoc}

Parameters

lazy()

lazy() 

{@inheritDoc}

buffered()

buffered() : \Cake\Collection\Iterator\BufferedIterator

{@inheritDoc}

Returns

listNested()

listNested(  $dir = 'desc',   $nestingKey = 'children') : \Cake\Collection\Iterator\TreeIterator

{@inheritDoc}

Parameters

Returns

stopWhen()

stopWhen(  $condition) : \Cake\Collection\Iterator\StoppableIterator

{@inheritDoc}

Parameters

Returns

unfold()

unfold(callable  $transformer = null) 

{@inheritDoc}

Parameters

through()

through(callable  $handler) 

{@inheritDoc}

Parameters

zip()

zip(  $items) 

{@inheritDoc}

Parameters

zipWith()

zipWith(  $items,   $callable) 

{@inheritDoc}

Parameters

chunk()

chunk(  $chunkSize) 

{@inheritDoc}

Parameters

chunkWithKeys()

chunkWithKeys(  $chunkSize,   $preserveKeys = true) 

{@inheritDoc}

Parameters

isEmpty()

isEmpty() 

{@inheritDoc}

unwrap()

unwrap() 

{@inheritDoc}

_unwrap()

_unwrap() 

cartesianProduct()

cartesianProduct(callable|null  $operation = null, callable|null  $filter = null) : \Cake\Collection\CollectionInterface

Parameters

Throws

\LogicException

Returns

transpose()

transpose() : \Cake\Collection\CollectionInterface

{@inheritDoc}

Throws

\LogicException

Returns

count()

count() : integer

Gives the number of rows in the result set.

Part of the Countable interface.

Returns

countKeys()

countKeys() : integer

{@inheritDoc}

Returns

__construct()

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

Constructor

Parameters

current()

current() : array|object

Returns the current record in the result iterator

Part of Iterator interface.

Returns

key()

key() : integer

Returns the key of the current record in the iterator

Part of Iterator interface.

Returns

next()

next() : void

Advances the iterator pointer to the next record

Part of Iterator interface.

rewind()

rewind() : void

Rewinds a ResultSet.

Part of Iterator interface.

Throws

\Cake\Database\Exception

valid()

valid() : boolean

Whether there are more results to be fetched from the iterator

Part of Iterator interface.

Returns

serialize()

serialize() : string

Serializes a resultset.

Part of Serializable interface.

Returns

Serialized object

unserialize()

unserialize(string  $serialized) : void

Unserializes a resultset.

Part of Serializable interface.

Parameters

__debugInfo()

__debugInfo() : array

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

Returns

optimizeUnwrap()

optimizeUnwrap() : \Traversable|array

Unwraps this iterator and returns the simplest traversable that can be used for getting the data out

Returns

_calculateAssociationMap()

_calculateAssociationMap(\Cake\ORM\Query  $query) : void

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

Parameters

_calculateColumnMap()

_calculateColumnMap(\Cake\ORM\Query  $query) : void

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

Parameters

_calculateTypeMap()

_calculateTypeMap() : void

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

_getTypes()

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

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

Parameters

Returns

_fetchResult()

_fetchResult() : mixed

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

Returns

_groupResult()

_groupResult(array  $row) : array

Correctly nests results keys including those coming from associations

Parameters

Returns

Results

_castValues()

_castValues(string  $alias, array  $values) : array

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

Parameters

Returns