Class ResultSetFactory
Factory class for generating ResulSet instances.
It is responsible for correctly nesting result keys reported from the query and hydrating entities.
Property Summary
-
$resultSetClass protected
class-stringCake\Datasource\ResultSetInterface>
Method Summary
-
collectData() protected
Get repository and it's associations data for nesting results key and entity hydration.
-
createResultSet() public
Create a resultset instance.
-
getResultSetClass() public
Get the ResultSet class to use.
-
groupResult() protected
Correctly nests results keys including those coming from associations.
-
setResultSetClass() public
Set the ResultSet class to use.
Method Detail
collectData() ¶ protected
collectData(Cake\ORM\Query\SelectQuery $query): arrayGet repository and it's associations data for nesting results key and entity hydration.
Parameters
-
Cake\ORM\Query\SelectQuery$query The query from where to derive the data.
Returns
arraycreateResultSet() ¶ public
createResultSet(iterable $results, Cake\ORM\Query\SelectQuery<T>|null $query = null): Cake\Datasource\ResultSetInterfaceCreate a resultset instance.
Parameters
-
iterable$results Results.
-
Cake\ORM\Query\SelectQuery<T>|null$query optional Query from where results came.
Returns
Cake\Datasource\ResultSetInterfacegetResultSetClass() ¶ public
getResultSetClass(): class-stringCake\Datasource\ResultSetInterface>Get the ResultSet class to use.
Returns
class-stringCake\Datasource\ResultSetInterface>groupResult() ¶ protected
groupResult(array $row, array $data): Cake\Datasource\EntityInterface|arrayCorrectly nests results keys including those coming from associations.
Hydrate row array into entity if hydration is enabled.
Parameters
-
array$row Array containing columns and values.
-
array$data Array containing table and query metadata
Returns
Cake\Datasource\EntityInterface|arraysetResultSetClass() ¶ public
setResultSetClass(class-stringCake\Datasource\ResultSetInterface> $resultSetClass): $thisSet the ResultSet class to use.
Parameters
-
class-stringCake\Datasource\ResultSetInterface>$resultSetClass Class name.
Returns
$this