An Association is a relationship established between two tables and is used to configure and customize the way interconnected records are retrieved.
__call( string $method , array $argument )
Proxies method calls to the target table.
$method
$argument
mixed
BadMethodCallException
__construct( string $alias , array $options [] )
Constructor. Subclasses can override _options function to get the original list of passed options if expecting any other special key
$alias
$options
optional [] __get( string $property )
Proxies property retrieval to the target table. This is handy for getting this association's associations
$property
Cake\ORM\Association
RuntimeException
__isset( string $property )
Proxies the isset call to the target table. This is handy to check if the target table has another association with the passed name
$property
boolean
_appendFields( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )
Helper function used to conditionally append fields to the select clause of a query from the fields found in another query object.
Cake\ORM\Query
$query
Cake\ORM\Query
$surrogate
$options
attachTo
_appendNotMatching( Cake\Database\Query $query , array $options )
Conditionally adds a condition to the passed Query that will make it find records where there is no match with this association.
Cake\Database\Query
$query
$options
negateMatch
key._bindNewAssociations( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )
Applies all attachable associations to $query
out of the containments found in the $surrogate
query.
Copies all contained associations from the $surrogate
query into the passed $query
. Containments are altered so that they respect the associations chain from which they originated.
Cake\ORM\Query
$query
Cake\ORM\Query
$surrogate
$options
attachTo
_dispatchBeforeFind( Cake\ORM\Query $query )
Triggers beforeFind on the target table for the query this association is attaching to
Cake\ORM\Query
$query
_extractFinder( string|array $finderData )
Helper method to infer the requested finder and its options.
Returns the inferred options from the finder $type.
The following will call the finder 'translations' with the value of the finder as its options: $query->contain(['Comments' => ['finder' => ['translations']]]); $query->contain(['Comments' => ['finder' => ['translations' => []]]]); $query->contain(['Comments' => ['finder' => ['translations' => ['locales' => ['en_US']]]]]);
$finderData
array
_formatAssociationResults( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )
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.
Cake\ORM\Query
$query
Cake\ORM\Query
$surrogate
$options
attachTo
_joinCondition( array $options )
Returns a single or multiple conditions to be appended to the generated join clause for getting the results on the target table.
$options
array
RuntimeException
_options( array $options )
Override this function to initialize any concrete association class, it will get passed the original list of options used in the constructor
$options
attachTo( Cake\ORM\Query $query , array $options [] )
Alters a Query object to include the associated target table data in the final result
The options array accept the following keys:
Cake\ORM\Query
$query
$options
optional [] RuntimeException
bindingKey( string|null $key null )
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.
If no parameters are passed the current field is returned
$key
optional null string|array
canBeJoined( array $options [] )
Whether this association can be expressed directly in a query join
$options
optional [] boolean
cascadeCallbacks( boolean|null $cascadeCallbacks null )
Sets whether or not cascaded deletes should also fire callbacks. If no arguments are passed, the current configured value is returned
$cascadeCallbacks
optional null boolean
cascadeDelete( Cake\Datasource\EntityInterface $entity , array $options [] )
Handles cascading a delete from an associated model.
Each implementing class should handle the cascaded delete as required.
Cake\Datasource\EntityInterface
$entity
$options
optional [] boolean
conditions( array|null $conditions null )
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
$conditions
optional null array
defaultRowValue( array $row , boolean $joined )
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.
$row
$joined
array
deleteAll( mixed $conditions )
Proxies the delete operation to the target table's deleteAll method
$conditions
boolean
Cake\ORM\Table::deleteAll()
dependent( boolean|null $dependent null )
Sets whether the records on the target table are dependent on the source table.
This is primarily used to indicate that records should be removed if the owning record in the source table is deleted.
If no parameters are passed the current setting is returned.
$dependent
optional null boolean
eagerLoader( array $options )
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.
The required way of passing related source records is controlled by "strategy" When the subquery strategy is used it will require a query on the source table. When using the select strategy, the list of primary keys will be used.
Returns a closure that should be run for each record returned in a specific Query. This callable will be responsible for injecting the fields that are related to each specific passed row.
Options array accepts the following keys:
$options
Closure
find( string|array $type null , array $options [] )
Proxies the finding operation to the target table's find method and modifies the query accordingly based of this association configuration
$type
optional null $options
parameter$options
optional [] Cake\ORM\Query
Cake\ORM\Table::find()
finder( string|null $finder null )
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.
$finder
optional null string
foreignKey( string|null $key null )
Sets the name of the field representing the foreign key to the target table. If no parameters are passed the current field is returned
$key
optional null string|array
isOwningSide( Cake\ORM\Table $side )
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.
Cake\ORM\Table
$side
boolean
joinType( string $type null )
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.
$type
optional null string
name( string|null $name null )
Sets the name for this association. If no argument is passed then the current configured name will be returned
$name
optional null string
property( string|null $name null )
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.
$name
optional null string
saveAssociated( Cake\Datasource\EntityInterface $entity , array $options [] )
Extract the target's association data our from the passed entity and proxies the saving operation to the target table.
Cake\Datasource\EntityInterface
$entity
$options
optional [] boolean|Cake\Datasource\EntityInterface
Cake\ORM\Table::save()
source( Cake\ORM\Table $table null )
Sets the table instance for the source side of the association. If no arguments are passed, the current configured table instance is returned
Cake\ORM\Table
$table
optional null Cake\ORM\Table
strategy( string|null $name null )
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.
$name
optional null string
InvalidArgumentException
target( Cake\ORM\Table $table null )
Sets the table instance for the target side of the association. If no arguments are passed, the current configured table instance is returned
Cake\ORM\Table
$table
optional null Cake\ORM\Table
transformRow( array $row , string $nestKey , boolean $joined )
Correctly nests a result row associated values into the correct array keys inside the source results.
$row
$nestKey
$joined
array
type( )
Get the relationship type.
string
updateAll( array $fields , mixed $conditions )
Proxies the update operation to the target table's updateAll method
$fields
$conditions
boolean
Cake\ORM\Table::updateAll()
_camelize( string $name )
Creates a camelized version of $name
$name
string
_entityName( string $name )
Creates the proper entity name (singular) for the specified name
$name
string
_fixtureName( string $name )
Creates a fixture name
$name
string
_modelKey( string $name )
Creates the proper underscored model key for associations
If the input contains a dot, assume that the right side is the real table name.
$name
string
_modelNameFromKey( string $key )
Creates the proper model name from a foreign key
$key
string
_pluginNamespace( string $pluginName )
Return plugin's namespace
$pluginName
string
_pluginPath( string $pluginName )
Find the correct path for a plugin. Scans $pluginPaths for the plugin you want.
$pluginName
string
_pluralHumanName( string $name )
Creates the plural human name used in views
$name
string
_singularHumanName( string $name )
Creates the singular human name used in views
$name
string
_singularName( string $name )
Creates the singular name for use in views.
$name
string
_variableName( string $name )
Creates the plural variable name for views
$name
string
tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator null )
Sets the table locator. If no parameters are passed, it will return the currently used locator.
Cake\ORM\Locator\LocatorInterface
$tableLocator
optional null Cake\ORM\Locator\LocatorInterface
string | MANY_TO_MANY Association type for many to many associations. | 'manyToMany' |
string | MANY_TO_ONE Association type for many to one associations. | 'manyToOne' |
string | ONE_TO_MANY Association type for one to many associations. | 'oneToMany' |
string | ONE_TO_ONE Association type for one to one associations. | 'oneToOne' |
string | STRATEGY_JOIN Strategy name to use joins for fetching associated records | 'join' |
string | STRATEGY_SELECT Strategy name to use a select for fetching associated records | 'select' |
string | STRATEGY_SUBQUERY Strategy name to use a subquery for fetching associated records | 'subquery' |
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.ORM.Association.html