Exposes the methods for storing the associations that should be eager loaded for a table once a query is provided and delegates the job of creating the required joins and decorating the results so that those associations can be part of the result set.
$_aliasList protected array$_autoFields protected booleanControls whether or not fields from associated tables will be eagerly loaded. When set to false, no fields will be loaded from associations.
$_containOptions protected arrayList of options accepted by associations in contain() index by key for faster access
$_containments protected arrayNested array describing the association to be fetched and the options to apply for each of them, if any
$_joinsMap protected arrayA map of table aliases pointing to the association objects they represent for the query.
$_loadExternal protected Cake\ORM\EagerLoadable[]$_matching protected $_normalized protected Cake\ORM\EagerLoadable[]|Cake\ORM\EagerLoadable|nullContains a nested array with the compiled containments tree This is a normalized version of the user provided containments array.
Helper function used to return the keys from the query records that will be used to eagerly load associations.
Changes the association fetching strategy if required because of duplicate under the same direct associations chain
Iterates over the joinable aliases list and corrects the fetching strategies in order to avoid aliases collision in the generated queries.
Helper function used to iterate a statement and extract the columns defined in $collectKeys
Auxiliary function responsible for fully normalizing deep associations defined using contain()
Formats the containments array so that associations are always set as keys in the array. This function merges the original associations array with the new associations provided
Helper function used to compile a list of all associations that can be joined in the query.
Registers a table alias, typically loaded as a join in a query, as belonging to an association. This helps hydrators know what to do with the columns coming from such joined table.
Returns an array having as keys a dotted path of associations that participate in this eager loader. The values of the array will contain the following keys
Modifies the passed query to apply joins or any other transformation required in order to eager load the associations described in the contain array. This method will not modify the query for loading external associations, i.e. those that cannot be loaded without executing a separate query.
Returns an array with the associations that can be fetched using a single query, the array keys are the association aliases and the values will contain an array with Cake\ORM\EagerLoadable objects.
Sets the list of associations that should be eagerly loaded along for a specific table using when a query is provided. The list of associated tables passed to this method must have been previously set as associations using the Table API.
Returns an array with the associations that need to be fetched using a separate query, each array value will contain a Cake\ORM\EagerLoadable object.
Decorates the passed statement object in order to inject data from associations that cannot be joined directly.
Adds a new association to the list that will be used to filter the results of any given query based on the results of finding records for that association. You can pass a dot separated path of associations to this method as its first parameter, this will translate in setting all those associations with the matching option.
Returns the fully normalized array of associations that should be eagerly loaded for a table. The normalized array will restructure the original array by sorting all associations under one key and special options under another.
Adds a new association to the list that will be used to filter the results of any given query based on the results of finding records for that association. You can pass a dot separated path of associations to this method as its first parameter, this will translate in setting all those associations with the matching option.
_collectKeys( array $external , Cake\ORM\Query $query , Cake\Database\Statement\BufferedStatement $statement )
Helper function used to return the keys from the query records that will be used to eagerly load associations.
$external Cake\ORM\Query $query Cake\Database\Statement\BufferedStatement $statement _correctStrategy( Cake\ORM\EagerLoadable $loadable )
Changes the association fetching strategy if required because of duplicate under the same direct associations chain
$loadable _fixStrategies( )
Iterates over the joinable aliases list and corrects the fetching strategies in order to avoid aliases collision in the generated queries.
This function operates on the array references that were generated by the _normalizeContain() function.
_groupKeys( Cake\Database\StatementInterface $statement , array $collectKeys )
Helper function used to iterate a statement and extract the columns defined in $collectKeys
Cake\Database\StatementInterface $statement $collectKeys _normalizeContain( Cake\ORM\Table $parent , string $alias , array $options , array $paths )
Auxiliary function responsible for fully normalizing deep associations defined using contain()
Cake\ORM\Table $parent $alias $options $paths An array with two values, the first one is a list of dot separated strings representing associations that lead to this $alias in the chain of associations to be loaded. The second value is the path to follow in entities' properties to fetch a record of the corresponding association.
_reformatContain( array $associations , array $original )
Formats the containments array so that associations are always set as keys in the array. This function merges the original associations array with the new associations provided
$associations $original The original containments array to merge with the new one
_resolveJoins( array $associations , array $matching [] )
Helper function used to compile a list of all associations that can be joined in the query.
$associations $matching optional [] addToJoinsMap( string $alias , Cake\ORM\Association $assoc , boolean $asMatching false , string $targetProperty null )
Registers a table alias, typically loaded as a join in a query, as belonging to an association. This helps hydrators know what to do with the columns coming from such joined table.
$alias Cake\ORM\Association $assoc The association object the alias represents; will be normalized
$asMatching optional false Whether or not this join results should be treated as a 'matching' association.
$targetProperty optional null The property name where the results of the join should be nested at. If not passed, the default property for the association will be used.
associationsMap( Cake\ORM\Table $table )
Returns an array having as keys a dotted path of associations that participate in this eager loader. The values of the array will contain the following keys
matching().Cake\ORM\Table $table The table containing the association that will be normalized
attachAssociations( Cake\ORM\Query $query , Cake\ORM\Table $repository , boolean $includeFields )
Modifies the passed query to apply joins or any other transformation required in order to eager load the associations described in the contain array. This method will not modify the query for loading external associations, i.e. those that cannot be loaded without executing a separate query.
Cake\ORM\Query $query Cake\ORM\Table $repository $includeFields whether to append all fields from the associations to the passed query. This can be overridden according to the settings defined per association in the containments array
attachableAssociations( Cake\ORM\Table $repository )
Returns an array with the associations that can be fetched using a single query, the array keys are the association aliases and the values will contain an array with Cake\ORM\EagerLoadable objects.
Cake\ORM\Table $repository The table containing the associations to be attached
autoFields( boolean|null $enable null )
Sets/Gets whether or not contained associations will load fields automatically.
$enable optional null clearContain( )
Remove any existing non-matching based containments.
This will reset/clear out any contained associations that were not added via matching().
contain( array|string $associations [] )
Sets the list of associations that should be eagerly loaded along for a specific table using when a query is provided. The list of associated tables passed to this method must have been previously set as associations using the Table API.
Associations can be arbitrarily nested using dot notation or nested arrays, this allows this object to calculate joins or any additional queries that must be executed to bring the required associated data.
Accepted options per passed association:
$associations optional [] list of table aliases to be queried. When this method is called multiple times it will merge previous list with the new one.
enableAutoFields( boolean $enable true )
Sets whether or not contained associations will load fields automatically.
$enable optional true externalAssociations( Cake\ORM\Table $repository )
Returns an array with the associations that need to be fetched using a separate query, each array value will contain a Cake\ORM\EagerLoadable object.
Cake\ORM\Table $repository The table containing the associations to be loaded
getMatching( )
Returns the current tree of associations to be matched.
isAutoFieldsEnabled( )
Gets whether or not contained associations will load fields automatically.
loadExternal( Cake\ORM\Query $query , Cake\Database\StatementInterface $statement )
Decorates the passed statement object in order to inject data from associations that cannot be joined directly.
Cake\ORM\Query $query The query for which to eager load external associations
Cake\Database\StatementInterface $statement Cake\Database\StatementInterfacematching( string|null $assoc null , callable $builder null , array $options [] )
Adds a new association to the list that will be used to filter the results of any given query based on the results of finding records for that association. You can pass a dot separated path of associations to this method as its first parameter, this will translate in setting all those associations with the matching option.
If called with no arguments it will return the current tree of associations to be matched.
$assoc optional null $builder optional null the callback function to be used for setting extra options to the filtering query
$options optional [] Extra options for the association matching, such as 'joinType' and 'fields'
normalized( Cake\ORM\Table $repository )
Returns the fully normalized array of associations that should be eagerly loaded for a table. The normalized array will restructure the original array by sorting all associations under one key and special options under another.
Each of the levels of the associations tree will converted to a Cake\ORM\EagerLoadable object, that contains all the information required for the association objects to load the information from the database.
Additionally it will set an 'instance' key per association containing the association instance from the corresponding source table
Cake\ORM\Table $repository The table containing the association that will be normalized
setMatching( string $assoc , callable $builder null , array $options [] )
Adds a new association to the list that will be used to filter the results of any given query based on the results of finding records for that association. You can pass a dot separated path of associations to this method as its first parameter, this will translate in setting all those associations with the matching option.
$assoc $builder optional null the callback function to be used for setting extra options to the filtering query
$options optional [] protected array
Contains a list of the association names that are to be eagerly loaded
[]
protected boolean
Controls whether or not fields from associated tables will be eagerly loaded. When set to false, no fields will be loaded from associations.
true
protected array
List of options accepted by associations in contain() index by key for faster access
[
'associations' => 1,
'foreignKey' => 1,
'conditions' => 1,
'fields' => 1,
'sort' => 1,
'matching' => 1,
'queryBuilder' => 1,
'finder' => 1,
'joinType' => 1,
'strategy' => 1,
'negateMatch' => 1
] protected array
Nested array describing the association to be fetched and the options to apply for each of them, if any
[]
protected array
A map of table aliases pointing to the association objects they represent for the query.
[]
protected Cake\ORM\EagerLoadable[]
A list of associations that should be loaded with a separate query
[]
protected Cake\ORM\EagerLoader
Another EagerLoader instance that will be used for 'matching' associations.
protected Cake\ORM\EagerLoadable[]|Cake\ORM\EagerLoadable|null
Contains a nested array with the compiled containments tree This is a normalized version of the user provided containments array.
null
© 2005–2017 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.4/class-Cake.ORM.EagerLoader.html