• Главная
• Cake
• ORM
• Association
• BelongsToMany

PHP Класс Cake\ORM\Association\BelongsToMany

An example of a BelongsToMany association would be Article belongs to many Tags. Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_dependent	boolean	Defaults to true for backwards compatibility.
$_joinType	string	The type of join to be used when adding the association to a query
$_junctionAssociationName	string	The name of the hasMany association from the target table to the junction table
$_junctionConditions	null | array	Filtered conditions that reference the junction table.
$_junctionProperty	string	The name of the property to be set containing data from the junction table once a record from the target table is hydrated
$_junctionTable	Cake\ORM\Table	Junction table instance
$_junctionTableName	string	Junction table name
$_saveStrategy	string	Saving strategy to be used by this association
$_strategy	string	The strategy name to be used to fetch associated records.
$_targetConditions	null | array	Filtered conditions that reference the target table.
$_targetForeignKey	string | array	The name of the field representing the foreign key to the target table
$_through	string | Cake\ORM\Table	The table instance for the junction relation.
$_validStrategies	array	Valid strategies for this type of association

Открытые методы

Метод	Описание
_buildBaseQuery ( )
_externalOptions ( )
attachTo ( Query $query, array $options = [] ) : void	Alters a Query object to include the associated target table data in the final result
cascadeDelete ( Cake\Datasource\EntityInterface $entity, array $options = [] ) : boolean	Clear out the data in the junction table for a given entity.
conditions ( $conditions = null )	{@inheritDoc}
find ( string | array | null $type = null, array $options = [] ) : Query	Proxies the finding operation to the target table's find method and modifies the query accordingly based of this association configuration.
isOwningSide ( Table $side ) : boolean	Returns boolean true, as both of the tables 'own' rows in the other side of the association via the joint table.
junction ( string | Table | null $table = null ) : Table	Sets the table instance for the junction relation. If no arguments are passed, the current configured table instance is returned
link ( Cake\Datasource\EntityInterface $sourceEntity, array $targetEntities, array $options = [] ) : boolean	Associates the source entity to each of the target entities provided by creating links in the junction table. Both the source entity and each of the target entities are assumed to be already persisted, if they are marked as new or their status is unknown then an exception will be thrown.
replaceLinks ( Cake\Datasource\EntityInterface $sourceEntity, array $targetEntities, array $options = [] ) : boolean	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.
saveAssociated ( Cake\Datasource\EntityInterface $entity, array $options = [] ) : boolean | Cake\Datasource\EntityInterface	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
saveStrategy ( string | null $strategy = null ) : string	Sets the strategy that should be used for saving. If called with no arguments, it will return the currently configured strategy
targetForeignKey ( string | null $key = null ) : string	Sets the name of the field representing the foreign key to the target table.
type ( ) : string	Get the relationship type.
unlink ( Cake\Datasource\EntityInterface $sourceEntity, array $targetEntities, array | boolean $options = [] ) : boolean	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.

Защищенные методы

Метод	Описание
_appendJunctionJoin ( Query $query, string | array $conditions ) : Query	Append a join to the junction table.
_appendNotMatching ( $query, $options )	{@inheritDoc}
_buildQuery ( array $options ) : Query	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.
_buildResultMap ( Query $fetchQuery, array $options ) : array	Builds an array containing the results from fetchQuery indexed by the foreignKey value corresponding to this association.
_checkPersistenceStatus ( Cake\Datasource\EntityInterface $sourceEntity, array $targetEntities ) : boolean	Throws an exception should any of the passed entities is not persisted.
_collectJointEntities ( Cake\Datasource\EntityInterface $sourceEntity, array $targetEntities ) : array	Returns the list of joint entities that exist between the source entity and each of the passed target entities
_diffLinks ( Query $existing, array $jointEntities, array $targetEntities, array $options = [] ) : array	Helper method used to delete the difference between the links passed in $existing and $jointEntities. This method will return the values from $targetEntities that were not deleted from calculating the difference.
_generateJunctionAssociations ( Table $junction, Table $source, Table $target ) : void	Generate associations on the junction table as necessary
_generateSourceAssociations ( Table $junction, Table $source ) : void	Generate additional source table associations as necessary.
_generateTargetAssociations ( Table $junction, Table $source, Table $target ) : void	Generate reciprocal associations as necessary.
_joinCondition ( array $options ) : boolean	Return false as join conditions are defined in the junction table
_junctionAssociationName ( ) : string	Returns the name of the association from the target table to the junction table, this name is used to generate alias in the query and to later on retrieve the results.
_junctionTableName ( string | null $name = null ) : string	Sets the name of the junction table.
_linkField ( array $options ) : string	Generates a string used as a table field that contains the values upon which the filter should be applied
_options ( array $opts ) : void	Parse extra options passed in the constructor.
_saveLinks ( Cake\Datasource\EntityInterface $sourceEntity, array $targetEntities, array $options ) : boolean	Creates links between the source entity and each of the passed target entities
_saveTarget ( Cake\Datasource\EntityInterface $parentEntity, array | Traversable $entities, array $options ) : Cake\Datasource\EntityInterface | boolean	Persists each of the entities into the target table and creates links between the parent entity and each one of the saved target entities.
junctionConditions ( ) : array	Returns filtered conditions that specifically reference the junction table.
targetConditions ( ) : mixed	Returns filtered conditions that reference the target table.

Описание методов

Описание свойств