Class Association

Constants summary

• string
  MANY_TO_MANY ¶
  'manyToMany'
• string
  MANY_TO_ONE ¶
  'manyToOne'
• string
  ONE_TO_MANY ¶
  'oneToMany'
• string
  ONE_TO_ONE ¶
  'oneToOne'
• string
  STRATEGY_JOIN ¶
  'join'
• string
  STRATEGY_SELECT ¶
  'select'
• string
  STRATEGY_SUBQUERY ¶
  'subquery'

Properties summary

• $_bindingKey protected
  string|string[]
  The field name in the owning side table that is used to match with the foreignKey
• $_cascadeCallbacks protected
  boolean
  Whether or not cascaded deletes should also fire callbacks.
• $_className protected
  string
  The class name of the target table object
• $_conditions protected
  array|callable

  A list of conditions to be always included when fetching records from the target association

• $_dependent protected
  boolean

  Whether the records on the target table are dependent on the source table, often used to indicate that records should be removed if the owning record in the source table is deleted.

• $_finder protected
  string|array

  The default finder name to use for fetching rows from the target table With array value, finder name and default options are allowed.

• $_foreignKey protected
  string|string[]
  The name of the field representing the foreign key to the table to load
• $_joinType protected
  string
  The type of join to be used when adding the association to a query
• $_name protected
  string

  Name given to the association, it usually represents the alias assigned to the target associated table

• $_propertyName protected
  string

  The property name that should be filled with data from the target table in the source table record.

• $_sourceTable protected
  Cake\ORM\Table
  Source table instance
• $_strategy protected
  string

  The strategy name to be used to fetch associated records. Some association types might not implement but one strategy to fetch records.

• $_targetTable protected
  Cake\ORM\Table
  Target table instance
• $_validStrategies protected
  array
  Valid strategies for this association. Subclasses can narrow this down.

Inherited Properties

• _tableLocator

Method Summary

• __call() public

  Proxies method calls to the target table.

• __construct() public

  Constructor. Subclasses can override _options function to get the original list of passed options if expecting any other special key

• __get() public

  Proxies property retrieval to the target table. This is handy for getting this association's associations

• __isset() public

  Proxies the isset call to the target table. This is handy to check if the target table has another association with the passed name

• _appendFields() protected

  Helper function used to conditionally append fields to the select clause of a query from the fields found in another query object.

• _appendNotMatching() protected

  Conditionally adds a condition to the passed Query that will make it find records where there is no match with this association.

• _bindNewAssociations() protected

  Applies all attachable associations to $query out of the containments found in the $surrogate query.

• _dispatchBeforeFind() protected

  Triggers beforeFind on the target table for the query this association is attaching to

• _extractFinder() protected

  Helper method to infer the requested finder and its options.

• _formatAssociationResults() protected

  Adds a formatter function to the passed $query if the $surrogate query declares any other formatter. Since the $surrogate query correspond to the associated target table, the resulting formatter will be the result of applying the surrogate formatters to only the property corresponding to such table.

• _getClassName() protected

  Gets the table class name.

• _joinCondition() protected

  Returns a single or multiple conditions to be appended to the generated join clause for getting the results on the target table.

• _options() protected

  Override this function to initialize any concrete association class, it will get passed the original list of options used in the constructor

• _propertyName() protected

  Returns default property name based on association name.

• attachTo() public

  Alters a Query object to include the associated target table data in the final result

• bindingKey() public deprecated

  Sets the name of the field representing the binding field with the target table. When not manually specified the primary key of the owning side table is used.

• canBeJoined() public

  Whether this association can be expressed directly in a query join

• cascadeCallbacks() public deprecated

  Sets whether or not cascaded deletes should also fire callbacks. If no arguments are passed, the current configured value is returned

• cascadeDelete() abstract public

  Handles cascading a delete from an associated model.

• className() public deprecated

  The class name of the target table object

• conditions() public deprecated

  Sets a list of conditions to be always included when fetching records from the target association. If no parameters are passed the current list is returned

• defaultRowValue() public

  Returns a modified row after appending a property for this association with the default empty value according to whether the association was joined or fetched externally.

• deleteAll() public

  Proxies the delete operation to the target table's deleteAll method

• dependent() public deprecated

  Sets whether the records on the target table are dependent on the source table.

• eagerLoader() abstract public

  Eager loads a list of records in the target table that are related to another set of records in the source table. Source records can specified in two ways: first one is by passing a Query object setup to find on the source table and the other way is by explicitly passing an array of primary key values from the source table.

• exists() public

  Proxies the operation to the target table's exists method after appending the default conditions for this association

• find() public

  Proxies the finding operation to the target table's find method and modifies the query accordingly based of this association configuration

• finder() public deprecated

  Sets the default finder to use for fetching rows from the target table. If no parameters are passed, it will return the currently configured finder name.

• foreignKey() public deprecated

  Sets the name of the field representing the foreign key to the target table. If no parameters are passed the current field is returned

• getBindingKey() public

  Gets the name of the field representing the binding field with the target table. When not manually specified the primary key of the owning side table is used.

• getCascadeCallbacks() public

  Gets whether or not cascaded deletes should also fire callbacks.

• getClassName() public

  Gets the class name of the target table object.

• getConditions() public

  Gets a list of conditions to be always included when fetching records from the target association.

• getDependent() public

  Sets whether the records on the target table are dependent on the source table.

• getFinder() public

  Gets the default finder to use for fetching rows from the target table.

• getForeignKey() public

  Gets the name of the field representing the foreign key to the target table.

• getJoinType() public

  Gets the type of join to be used when adding the association to a query.

• getName() public

  Gets the name for this association, usually the alias assigned to the target associated table

• getProperty() public

  Gets the property name that should be filled with data from the target table in the source table record.

• getSource() public

  Gets the table instance for the source side of the association.

• getStrategy() public

  Gets the strategy name to be used to fetch associated records. Keep in mind that some association types might not implement but a default strategy, rendering any changes to this setting void.

• getTarget() public

  Gets the table instance for the target side of the association.

• isOwningSide() abstract public

  Returns whether or not the passed table is the owning side for this association. This means that rows in the 'target' table would miss important or required information if the row in 'source' did not exist.

• joinType() public deprecated

  Sets the type of join to be used when adding the association to a query. If no arguments are passed, the currently configured type is returned.

• name() public deprecated

  Sets the name for this association.

• property() public deprecated

  Sets the property name that should be filled with data from the target table in the source table record. If no arguments are passed, the currently configured type is returned.

• requiresKeys() public

  Returns true if the eager loading process will require a set of the owning table's binding keys in order to use them as a filter in the finder query.

• saveAssociated() abstract public

  Extract the target's association data our from the passed entity and proxies the saving operation to the target table.

• setBindingKey() public

  Sets the name of the field representing the binding field with the target table. When not manually specified the primary key of the owning side table is used.

• setCascadeCallbacks() public

  Sets whether or not cascaded deletes should also fire callbacks.

• setClassName() public

  Sets the class name of the target table object.

• setConditions() public

  Sets a list of conditions to be always included when fetching records from the target association.

• setDependent() public

  Sets whether the records on the target table are dependent on the source table.

• setFinder() public

  Sets the default finder to use for fetching rows from the target table.

• setForeignKey() public

  Sets the name of the field representing the foreign key to the target table.

• setJoinType() public

  Sets the type of join to be used when adding the association to a query.

• setName() public

  Sets the name for this association, usually the alias assigned to the target associated table

• setProperty() public

  Sets the property name that should be filled with data from the target table in the source table record.

• setSource() public

  Sets the table instance for the source side of the association.

• setStrategy() public

  Sets the strategy name to be used to fetch associated records. Keep in mind that some association types might not implement but a default strategy, rendering any changes to this setting void.

• setTarget() public

  Sets the table instance for the target side of the association.

• source() public deprecated

  Sets the table instance for the source side of the association. If no arguments are passed, the current configured table instance is returned

• strategy() public deprecated

  Sets the strategy name to be used to fetch associated records. Keep in mind that some association types might not implement but a default strategy, rendering any changes to this setting void. If no arguments are passed, the currently configured strategy is returned.

• target() public deprecated

  Sets the table instance for the target side of the association. If no arguments are passed, the current configured table instance is returned

• transformRow() public

  Correctly nests a result row associated values into the correct array keys inside the source results.

• type() abstract public

  Get the relationship type.

• updateAll() public

  Proxies the update operation to the target table's updateAll method

Method Detail

Methods used from Cake\Core\ConventionsTrait

Methods used from Cake\ORM\Locator\LocatorAwareTrait

Properties detail

false

[]

false

'all'

Cake\ORM\QueryInterface::JOIN_TYPE_LEFT

self::STRATEGY_JOIN

[
    self::STRATEGY_JOIN,
    self::STRATEGY_SELECT,
    self::STRATEGY_SUBQUERY
]