Class LazyEagerLoader
Contains methods that are capable of injecting eagerly loaded associations into entities or lists of entities by using the same syntax as the EagerLoader.
Namespace: Cake\ORM
Method Summary
-
_getPropertyMap() protected
Returns a map of property names where the association results should be injected in the top level entities.
-
_getQuery() protected
Builds a query for loading the passed list of entity objects along with the associations specified in $contain.
-
_injectResults() protected
Injects the results of the eager loader query into the original list of entities.
-
loadInto() public
Loads the specified associations in the passed entity or list of entities by executing extra queries in the database and merging the results in the appropriate properties.
Method Detail
_getPropertyMap() protected
_getPropertyMap(mixed $source, mixed $associations)Returns a map of property names where the association results should be injected in the top level entities.
Parameters
\Cake\ORM\Table$source-
The table having the top level associations
string[]$associations-
The name of the top level associations
Returns
array_getQuery() protected
_getQuery(mixed $objects, mixed $contain, mixed $source)Builds a query for loading the passed list of entity objects along with the associations specified in $contain.
Parameters
\Cake\Collection\CollectionInterface$objects-
The original entities
array$contain-
The associations to be loaded
\Cake\ORM\Table$source-
The table to use for fetching the top level entities
Returns
\Cake\ORM\Query_injectResults() protected
_injectResults(mixed $objects, mixed $results, mixed $associations, mixed $source)Injects the results of the eager loader query into the original list of entities.
Parameters
\Cake\Datasource\EntityInterface[]|\Traversable$objects-
The original list of entities
\Cake\Collection\CollectionInterface|\Cake\Database\Query$results-
The loaded results
string[]$associations-
The top level associations that were loaded
\Cake\ORM\Table$source-
The table where the entities came from
Returns
arrayloadInto() public
loadInto(mixed $entities, array $contain, \Cake\ORM\Table $source)Loads the specified associations in the passed entity or list of entities by executing extra queries in the database and merging the results in the appropriate properties.
The properties for the associations to be loaded will be overwritten on each entity.
Parameters
\Cake\Datasource\EntityInterface|array$entities-
a single entity or list of entities
array$contain-
A
contain()compatible array. \Cake\ORM\Table$source-
The table to use for fetching the top level entities
Returns
\Cake\Datasource\EntityInterface|arraySee Also
\Cake\ORM\Query::contain()
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/class-Cake.ORM.LazyEagerLoader.html