Represents an N - 1 relationship where the target side of the relationship will have one or multiple records per each one in the source side.
An example of a HasMany association would be Author has many Articles.
Cake\ORM\Association\HasMany uses Cake\ORM\Association\DependentDeleteTrait, Cake\ORM\Association\ExternalAssociationTrait _foreignKeyAcceptsNull( Cake\ORM\Table $table , array $properties )
Checks the nullable flag of the foreign key
Cake\ORM\Table $table $properties boolean_linkField( mixed $options )
_options( array $opts )
Parse extra options passed in the constructor.
$opts Cake\ORM\Association::_options() _unlink( array $foreignKey , Cake\ORM\Table $target , array $conditions [] , array $options [] )
Deletes/sets null the related objects matching $conditions. The action which is taken depends on the dependency between source and targets and also on foreign key nullability
$foreignKey Cake\ORM\Table $target $conditions optional [] $options optional [] Table::delete()
boolean_unlinkAssociated( array $properties , Cake\Datasource\EntityInterface $entity , Cake\ORM\Table $target , array $remainingEntities [] , array $options [] )
Deletes/sets null the related objects according to the dependency between source and targets and foreign key nullability Skips deleting records present in $remainingEntities
$properties Cake\Datasource\EntityInterface $entity Cake\ORM\Table $target $remainingEntities optional [] $options optional [] Table::delete()
booleanisOwningSide( 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 booleanlink( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities , array $options [] )
Associates the source entity to each of the target entities provided. When using this method, all entities in $targetEntities will be appended to the source entity's property corresponding to this association object.
This method does not check link uniqueness. Changes are persisted in the database and also in the source entity.
$user = $users->get(1); $allArticles = $articles->find('all')->execute(); $users->Articles->link($user, $allArticles);
$user->get('articles') will contain all articles in $allArticles after linking
Cake\Datasource\EntityInterface $sourceEntity source side of this association$targetEntities target side of this association$options optional [] save callbooleanreplace( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities , array $options [] )
Replaces existing association links between the source entity and the target with the ones passed. This method does a smart cleanup, links that are already persisted and present in $targetEntities will not be deleted, new links will be created for the passed target entities that are not already in the database and the rest will be removed.
For example, if an author has many articles, such as 'article1','article 2' and 'article 3' and you pass to this method an array containing the entities for articles 'article 1' and 'article 4', only the link for 'article 1' will be kept in database, the links for 'article 2' and 'article 3' will be deleted and the link for 'article 4' will be created.
Existing links are not deleted and created again, they are either left untouched or updated.
This method does not check link uniqueness.
On success, the passed $sourceEntity will contain $targetEntities as value in the corresponding property for this association.
Additional options for new links to be saved can be passed in the third argument, check Table::save() for information on the accepted options.
$author->articles = [$article1, $article2, $article3, $article4]; $authors->save($author); $articles = [$article1, $article3]; $authors->association('articles')->replaceLinks($author, $articles);
$author->get('articles') will contain only [$article1, $article3] at the end
Cake\Datasource\EntityInterface $sourceEntity $targetEntities $options optional [] save/delete calls when persisting/updating new links, or deleting existing onesbooleanInvalidArgumentExceptionsaveAssociated( Cake\Datasource\EntityInterface $entity , array $options [] )
Takes an entity from the source table and looks if there is a field matching the property name for this association. The found entity will be saved on the target table for this association by passing supplied $options
Cake\Datasource\EntityInterface $entity $options optional [] boolean|Cake\Datasource\EntityInterfaceInvalidArgumentExceptionsaveStrategy( string|null $strategy null )
Sets the strategy that should be used for saving. If called with no arguments, it will return the currently configured strategy
$strategy optional null stringInvalidArgumentExceptionunlink( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities , array $options [] )
Removes all links between the passed source entity and each of the provided target entities. This method assumes that all passed objects are already persisted in the database and that each of them contain a primary key value.
Additionally to the default options accepted by Table::delete(), the following keys are supported:
$targetEntities thatare stored in $sourceEntity (default: true)
By default this method will unset each of the entity objects stored inside the source entity.
Changes are persisted in the database and also in the source entity.
$user = $users->get(1); $user->articles = [$article1, $article2, $article3, $article4]; $users->save($user, ['Associated' => ['Articles']]); $allArticles = [$article1, $article2, $article3]; $users->Articles->unlink($user, $allArticles);
$article->get('articles') will contain only [$article4] after deleting in the database
Cake\Datasource\EntityInterface $sourceEntity $targetEntities $options optional [] delete callInvalidArgumentException__call( string $method , array $argument )
Proxies method calls to the target table.
$method $argument mixedBadMethodCallException__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\AssociationRuntimeException__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 arrayRuntimeExceptionattachTo( 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 [] RuntimeExceptionbindingKey( 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|arraycanBeJoined( array $options [] )
Whether this association can be expressed directly in a query join
$options optional [] booleancascadeCallbacks( 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 booleancascadeDelete( 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 [] booleanconditions( 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 arraydefaultRowValue( 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 arraydeleteAll( mixed $conditions )
Proxies the delete operation to the target table's deleteAll method
$conditions booleanCake\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 booleaneagerLoader( 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 Closurefind( 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\QueryCake\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 stringforeignKey( 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|arrayjoinType( 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 stringname( 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 stringproperty( 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 stringsource( 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\Tablestrategy( 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 stringInvalidArgumentExceptiontarget( 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\TabletransformRow( 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 arrayupdateAll( array $fields , mixed $conditions )
Proxies the update operation to the target table's updateAll method
$fields $conditions booleanCake\ORM\Table::updateAll()cascadeDelete( Cake\Datasource\EntityInterface $entity , array $options [] )
Cascade a delete to remove dependent records.
This method does nothing if the association is not dependent.
Cake\Datasource\EntityInterface $entity $options optional [] boolean_buildResultMap( mixed $fetchQuery , mixed $options )
_defaultOptions( )
Returns the default options to use for the eagerLoader
array_externalOptions( array $opts )
Parse extra options passed in the constructor.
$opts canBeJoined( array $options [] )
Whether this association can be expressed directly in a query join
$options optional [] booleanCake\ORM\Association::canBeJoined() defaultRowValue( mixed $row , mixed $joined )
Cake\ORM\Association::defaultRowValue() foreignKey( string|null $key null )
Sets the name of the field representing the foreign key to the source table. If no parameters are passed current field is returned
$key optional null stringCake\ORM\Association::foreignKey() sort( mixed $sort null )
Sets the sort order in which target records should be returned. If no arguments are passed the currently configured value is returned
$sort optional null mixed_addFilteringCondition( Cake\ORM\Query $query , string|array $key , mixed $filter )
Appends any conditions required to load the relevant set of records in the target table query given a filter key and some filtering values.
Cake\ORM\Query $query $key $filter Cake\ORM\Query_addFilteringJoin( Cake\ORM\Query $query , string $key , Cake\ORM\Query $subquery )
Appends any conditions required to load the relevant set of records in the target table query given a filter key and some filtering values when the filtering needs to be done using a subquery.
Cake\ORM\Query $query $key Cake\ORM\Query $subquery Cake\ORM\Query_buildQuery( array $options )
Auxiliary function to construct a new Query object to return all the records in the target table that are associated to those specified in $options from the source table
$options Cake\ORM\QueryInvalidArgumentException_buildSubquery( Cake\ORM\Query $query )
Builds a query to be used as a condition for filtering records in the target table, it is constructed by cloning the original query that was used to load records in the source table.
Cake\ORM\Query $query Cake\ORM\Query_createTupleCondition( Cake\ORM\Query $query , array $keys , mixed $filter , string $operator )
Returns a TupleComparison object that can be used for matching all the fields from $keys with the tuple values in $filter using the provided operator.
Cake\ORM\Query $query $keys $filter $operator Cake\Database\Expression\TupleComparison_multiKeysInjector( array $resultMap , array $sourceKeys , string $nestKey )
Returns a callable to be used for each row in a query result set for injecting the eager loaded rows when the matching needs to be done with multiple foreign keys
$resultMap $sourceKeys $nestKey Closure_resultInjector( Cake\ORM\Query $fetchQuery , array $resultMap , array $options )
Returns a callable to be used for each row in a query result set for injecting the eager loaded rows
Cake\ORM\Query $fetchQuery $resultMap $options Closure_subqueryFields( Cake\ORM\Query $query )
Calculate the fields that need to participate in a subquery.
Normally this includes the binding key columns. If there is a an ORDER BY, those columns are also included as the fields may be calculated or constant values, that need to be present to ensure the correct association data is loaded.
Cake\ORM\Query $query arrayeagerLoader( array $options )
requiresKeys( array $options [] )
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.
$options optional [] boolean_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 stringtableLocator( 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\LocatorInterfacestring | SAVE_APPEND Saving strategy that will only append to the links set | 'append' |
string | SAVE_REPLACE Saving strategy that will replace the links with the provided set | 'replace' |
MANY_TO_MANY, MANY_TO_ONE, ONE_TO_MANY, ONE_TO_ONE, STRATEGY_JOIN, STRATEGY_SELECT, STRATEGY_SUBQUERY |
protected string|array
The field name in the owning side table that is used to match with the foreignKey
protected string
Whether or not cascaded deletes should also fire callbacks.
false protected array
A list of conditions to be always included when fetching records from the target association
[]
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.
false protected string
The default finder name to use for fetching rows from the target table
'all' protected string|array
The name of the field representing the foreign key to the table to load
protected string
Name given to the association, it usually represents the alias assigned to the target associated table
protected string
The property name that should be filled with data from the target table in the source table record.
© 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.HasMany.html