Класс AssociationCollection

__construct()source public

__construct( Cake\ORM\Locator\LocatorInterface $tableLocator = null )

Конструктор.

Устанавливает локатор таблицы по умолчанию для ассоциаций. Если локатор не указан, будет использован глобальный.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator optional null

Экземпляр локатора таблиц.

_getNoCascadeItems()source protected

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

Возвращает элементы, у которых нет обратного вызова каскадирования.

Параметры

Cake\Datasource\EntityInterface $entity

Сущность, для которой удаляются ассоциации.

array $options

Параметры, используемые в операции удаления.

Возвращает

Cake\ORM\Association[]

_save()source protected

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

Вспомогательный метод для сохранения данных ассоциации.

Параметры

Cake\ORM\Association $association

Объект ассоциации для сохранения.

Cake\Datasource\EntityInterface $entity

Сущность для сохранения

array $nested

Параметры для глубоких ассоциаций

array $options

Исходные параметры

Возвращает

boolean
Успех

_saveAssociations()source protected

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

Вспомогательный метод для сохранения данных ассоциации.

Параметры

Cake\ORM\Table $table

Таблица, над которой в данный момент выполняется сохранение

Cake\Datasource\EntityInterface $entity

Сущность для сохранения

array $associations

Массив ассоциаций для сохранения.

array $options

Исходные параметры

boolean $owningSide

Сравнивается с методом isOwningSide ассоциативных классов.

Возвращает

boolean
Успех

Исключения

InvalidArgumentException
При использовании неизвестного псевдонима.

add()source public

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

Добавить ассоциацию в коллекцию

Если добавленный псевдоним содержит ., часть перед . будет удалена. Это упрощает использование плагинов, так как синтаксис Plugin.Class часто используется.

Параметры

string $alias

Псевдоним ассоциации

Cake\ORM\Association $association

Добавляемая ассоциация.

Возвращает

Cake\ORM\Association
Объект добавляемой ассоциации.

cascadeDelete()source public

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

Каскадное удаление по различным ассоциациям. Сначала каскадное удаление по ассоциациям, для которых cascadeCallbacks истинно.

Параметры

Cake\Datasource\EntityInterface $entity

Сущность, для которой удаляются ассоциации.

array $options

Параметры, используемые в операции удаления.

get()source public

get( string $alias )

Получить присоединённую ассоциацию по имени.

Параметры

string $alias

Псевдоним ассоциации для получения.

Возвращает

Cake\ORM\Association|null
Ассоциация или null.

getByProperty()source public

getByProperty( string $prop )

Получить ассоциацию по имени свойства.

Параметры

string $prop

Свойство для поиска ассоциации.

Возвращает

Cake\ORM\Association|null
Ассоциация или null.

getByType()source public

getByType( string|array $class )

Получить массив ассоциаций, соответствующих определённому типу.

Параметры

string|array $class

Тип ассоциаций, которые вы хотите получить. Например, 'BelongsTo' или массив, подобный ['BelongsTo', 'HasOne']

Возвращает

array
Массив объектов Association.

С момента

3.5.3

getIterator()source public

getIterator( )

Разрешить итерацию по ассоциациям

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $alias )

Проверить наличие присоединённой ассоциации по имени.

Параметры

строка $alias

Псевдоним ассоциации для получения.

Возвращает

boolean
Существует ли ассоциация.

keys()source public

keys( )

Получить имена всех ассоциаций в коллекции.

Возвращает

массив

load()source public

load( string $className , string $associated , array $options = [] )

Создаёт и добавляет объект Association в эту коллекцию.

Параметры

строка $className

Имя класса ассоциации.

строка $associated

Псевдоним целевой таблицы.

массив $options необязательно []

Список параметров для конфигурации определения ассоциации.

Возвращает

Cake\ORM\Association

Выбрасывает

InvalidArgumentException

normalizeKeys()source public

normalizeKeys( boolean|array $keys )

Возвращает ассоциативный массив имён ассоциаций из смешанного массива. Если передано true, возвращает все имена ассоциаций в этой коллекции.

Параметры

boolean|массив $keys

список имён ассоциаций для нормализации

Возвращает

массив

remove()source public

remove( string $alias )

Удаление ассоциации.

После удаления ассоциация больше недоступна

Параметры

строка $alias

Псевдоним.

removeAll()source public

removeAll( )

Удаляет все зарегистрированные ассоциации.

После удаления ассоциации больше недоступны

saveChildren()source public

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

Сохраняет все ассоциации, являющиеся дочерними для данного сущности.

Дочерние ассоциации включают любые ассоциации, где данная таблица не является стороной владения.

Параметры

Cake\ORM\Table $table

Сущность таблицы.

Cake\Datasource\EntityInterface $entity

Сущность для сохранения связанных данных.

массив $associations

Список ассоциаций для сохранения дочерних данных. Ассоциации, не входящие в этот список, не будут сохранены.

массив $options

Параметры операции сохранения.

Возвращает

boolean
Успех

saveParents()source public

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

Сохраняет все ассоциации, являющиеся родительскими для данной сущности.

Родительские ассоциации включают любые ассоциации, где данная таблица является стороной владения.

Параметры

Cake\ORM\Table $table

Сущность таблицы.

Cake\Datasource\EntityInterface $entity

Сущность для сохранения связанных данных.

массив $associations

Список ассоциаций для сохранения родительских данных. Ассоциации, не входящие в этот список, не будут сохранены.

массив $options необязательно []

Параметры операции сохранения.

Возвращает

boolean
Успех

type()source public устарело

type( string|array $class )

Получить массив ассоциаций, соответствующих определённому типу.

Устарело

3.5.3 Используйте getByType() вместо этого.

Параметры

строка|массив $class

Тип ассоциаций, который вы хотите. Например, 'BelongsTo' или массив, например ['BelongsTo', 'HasOne']

Возвращает

массив
Массив объектов Association.

_normalizeAssociations()source protected

_normalizeAssociations( array $associations )

Возвращает массив из исходного списка ассоциаций, где нотация точек преобразуется во вложенные массивы, чтобы их можно было обработать другими процедурами.

Параметры

массив $associations

Массив включённых ассоциаций.

Возвращает

массив
Массив, в котором нотация точек преобразована во вложенные массивы

getTableLocator()source public

getTableLocator( )

Получает локатор таблиц.

Возвращает

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )

Устанавливает локатор таблиц.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Возвращает

$this

tableLocator()source public устарело

tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )

Устанавливает локатор таблиц. Если параметры не переданы, возвращает текущий используемый локатор.

Устарело

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательно null

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

[]