Class AssociationCollection

_getNoCascadeItems()source protected

_getNoCascadeItems( Cake\Datasource\EntityInterface $entity , array $options )

Returns items that have no cascade callback.

Parameters

Cake\Datasource\EntityInterface $entity

The entity to delete associations for.

array $options

The options used in the delete operation.

Returns

Cake\ORM\Association[]

_save()source protected

_save( Cake\ORM\Association $association , Cake\Datasource\EntityInterface $entity , array $nested , array $options )

Helper method for saving an association's data.

Parameters

Cake\ORM\Association $association

The association object to save with.

Cake\Datasource\EntityInterface $entity

The entity to save

array $nested

Options for deeper associations

array $options

Original options

Returns

boolean
Success

_saveAssociations()source protected

_saveAssociations( Cake\ORM\Table $table , Cake\Datasource\EntityInterface $entity , array $associations , array $options , boolean $owningSide )

Helper method for saving an association's data.

Parameters

Cake\ORM\Table $table

The table the save is currently operating on

Cake\Datasource\EntityInterface $entity

The entity to save

array $associations

Array of associations to save.

array $options

Original options

boolean $owningSide

Compared with association classes' isOwningSide method.

Returns

boolean
Success

Throws

InvalidArgumentException
When an unknown alias is used.

add()source public

add( string $alias , Cake\ORM\Association $association )

Add an association to the collection

If the alias added contains a . the part preceding the . will be dropped. This makes using plugins simpler as the Plugin.Class syntax is frequently used.

Parameters

string $alias

The association alias

Cake\ORM\Association $association

The association to add.

Returns

Cake\ORM\Association
The association object being added.

cascadeDelete()source public

cascadeDelete( Cake\Datasource\EntityInterface $entity , array $options )

Cascade a delete across the various associations. Cascade first across associations for which cascadeCallbacks is true.

Parameters

Cake\Datasource\EntityInterface $entity

The entity to delete associations for.

array $options

The options used in the delete operation.

get()source public

get( string $alias )

Fetch an attached association by name.

Parameters

string $alias

The association alias to get.

Returns

Cake\ORM\Association|null
Either the association or null.

getByProperty()source public

getByProperty( string $prop )

Fetch an association by property name.

Parameters

string $prop

The property to find an association by.

Returns

Cake\ORM\Association|null
Either the association or null.

getIterator()source public

getIterator( )

Allow looping through the associations

Returns

ArrayIterator

Implementation of

IteratorAggregate::getIterator()

has()source public

has( string $alias )

Check for an attached association by name.

Parameters

string $alias

The association alias to get.

Returns

boolean
Whether or not the association exists.

keys()source public

keys( )

Get the names of all the associations in the collection.

Returns

array

normalizeKeys()source public

normalizeKeys( boolean|array $keys )

Returns an associative array of association names out a mixed array. If true is passed, then it returns all association names in this collection.

Parameters

boolean|array $keys

the list of association names to normalize

Returns

array

remove()source public

remove( string $alias )

Drop/remove an association.

Once removed the association will not longer be reachable

Parameters

string $alias

The alias name.

removeAll()source public

removeAll( )

Remove all registered associations.

Once removed associations will not longer be reachable

saveChildren()source public

saveChildren( Cake\ORM\Table $table , Cake\Datasource\EntityInterface $entity , array $associations , array $options )

Save all the associations that are children of the given entity.

Child associations include any association where the given table is not the owning side.

Parameters

Cake\ORM\Table $table

The table entity is for.

Cake\Datasource\EntityInterface $entity

The entity to save associated data for.

array $associations

The list of associations to save children from. associations not in this list will not be saved.

array $options

The options for the save operation.

Returns

boolean
Success

saveParents()source public

saveParents( Cake\ORM\Table $table , Cake\Datasource\EntityInterface $entity , array $associations , array $options [] )

Save all the associations that are parents of the given entity.

Parent associations include any association where the given table is the owning side.

Parameters

Cake\ORM\Table $table

The table entity is for.

Cake\Datasource\EntityInterface $entity

The entity to save associated data for.

array $associations

The list of associations to save parents from. associations not in this list will not be saved.

array $options optional []

The options for the save operation.

Returns

boolean
Success

type()source public

type( string|array $class )

Get an array of associations matching a specific type.

Parameters

string|array $class

The type of associations you want. For example 'BelongsTo' or array like ['BelongsTo', 'HasOne']

Returns

array
An array of Association objects.

_normalizeAssociations()source protected

_normalizeAssociations( array $associations )

Returns an array out of the original passed associations list where dot notation is transformed into nested arrays so that they can be parsed by other routines

Parameters

array $associations

The array of included associations.

Returns

array
An array having dot notation transformed into nested arrays

[]