Class EagerLoader

Properties summary

• $_aliasList protected
  array
  Contains a list of the association names that are to be eagerly loaded
• $_autoFields 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.

• $_containOptions protected
  array

  List of options accepted by associations in contain() index by key for faster access

• $_containments protected
  array

  Nested array describing the association to be fetched and the options to apply for each of them, if any

• $_joinsMap protected
  array

  A map of table aliases pointing to the association objects they represent for the query.

• $_loadExternal protected
  Cake\ORM\EagerLoadable[]
  A list of associations that should be loaded with a separate query
• $_matching protected
  Cake\ORM\EagerLoader
  Another EagerLoader instance that will be used for 'matching' associations.
• $_normalized 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.

Method Summary

• __clone() public

  Clone hook implementation

• _buildAssociationsMap() protected

  An internal method to build a map which is used for the return value of the associationsMap() method.

• _collectKeys() protected

  Helper function used to return the keys from the query records that will be used to eagerly load associations.

• _correctStrategy() protected

  Changes the association fetching strategy if required because of duplicate under the same direct associations chain

• _fixStrategies() protected

  Iterates over the joinable aliases list and corrects the fetching strategies in order to avoid aliases collision in the generated queries.

• _groupKeys() protected

  Helper function used to iterate a statement and extract the columns defined in $collectKeys

• _normalizeContain() protected

  Auxiliary function responsible for fully normalizing deep associations defined using contain()

• _reformatContain() protected

  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

• _resolveJoins() protected

  Helper function used to compile a list of all associations that can be joined in the query.

• addToJoinsMap() public

  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.

• associationsMap() public

  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

• attachAssociations() public

  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.

• attachableAssociations() public

  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.

• autoFields() public

  Sets/Gets whether or not contained associations will load fields automatically.

• clearContain() public

  Remove any existing non-matching based containments.

• contain() public

  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.

• disableAutoFields() public

  Disable auto loading fields of contained associations.

• enableAutoFields() public

  Sets whether or not contained associations will load fields automatically.

• externalAssociations() public

  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.

• getContain() public

  Gets 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.

• getMatching() public

  Returns the current tree of associations to be matched.

• isAutoFieldsEnabled() public

  Gets whether or not contained associations will load fields automatically.

• loadExternal() public

  Decorates the passed statement object in order to inject data from associations that cannot be joined directly.

• matching() public

  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.

• normalized() public

  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.

• setMatching() public

  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.

Method Detail

Properties detail

[]

true

[
    'associations' => 1,
    'foreignKey' => 1,
    'conditions' => 1,
    'fields' => 1,
    'sort' => 1,
    'matching' => 1,
    'queryBuilder' => 1,
    'finder' => 1,
    'joinType' => 1,
    'strategy' => 1,
    'negateMatch' => 1
]

[]

[]

[]