Класс AssociationCollection
Контейнер/коллекция для ассоциативных классов.
Содержит методы для управления ассоциациями и операций по сохранению и удалению.
- Cake\ORM\AssociationCollection реализует IteratorAggregate использует Cake\ORM\AssociationsNormalizerTrait
Краткое описание свойств
- Сохранённые ассоциации
$_itemsprotected
Краткое описание методов
- _getNoCascadeItems() protectedВозвращает элементы без обратного вызова каскадирования.
- _save() protectedВспомогательный метод для сохранения данных ассоциации.
- _saveAssociations() protectedВспомогательный метод для сохранения данных ассоциации.
- add() publicДобавление ассоциации в коллекцию
- cascadeDelete() public
Каскадное удаление по различным ассоциациям. Сначала каскадируется по ассоциациям, для которых cascadeCallbacks равно true.
- get() publicПолучение присоединённой ассоциации по имени.
- getByProperty() publicПолучение ассоциации по имени свойства.
- getIterator() publicПозволяет итерироваться по ассоциациям
- has() publicПроверка наличия присоединённой ассоциации по имени.
- keys() publicПолучение имён всех ассоциаций в коллекции.
- normalizeKeys() public
Возвращает ассоциативный массив имён ассоциаций из смешанного массива. Если передано значение true, возвращает все имена ассоциаций в этой коллекции.
- remove() publicУдаление ассоциации.
- removeAll() publicУдаление всех зарегистрированных ассоциаций.
- saveChildren() publicСохранение всех ассоциаций, являющихся дочерними для данного сущности.
- saveParents() publicСохранение всех ассоциаций, являющихся родительскими для данной сущности.
- type() publicПолучение массива ассоциаций, соответствующих определённому типу.
Подробное описание методов
_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 равно true.
Параметры
-
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.
getIterator()source public
getIterator( )
Позволяет итерироваться по ассоциациям
Возвращает
ArrayIteratorРеализация
IteratorAggregate::getIterator() has()source public
has( string $alias )
Проверка наличия присоединённой ассоциации по имени.
Параметры
- string
$alias - Псевдоним ассоциации для получения.
Возвращает
booleanСуществует ли ассоциация.
normalizeKeys()source public
normalizeKeys( boolean|array $keys )
Возвращает ассоциативный массив имён ассоциаций из смешанного массива. Если передано значение true, возвращает все имена ассоциаций в этой коллекции.
Параметры
- boolean|array
$keys - список имён ассоциаций для нормализации
Возвращает
arrayremove()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 )
Получить массив ассоциаций, соответствующих определенному типу.
Параметры
- строка|массив
$class Тип ассоциаций, которые вы хотите получить. Например, 'BelongsTo' или массив ['BelongsTo', 'HasOne']
Возвращаемое значение
массивМассив объектов Association.
Методы, используемые из Cake\ORM\AssociationsNormalizerTrait
_normalizeAssociations()source protected
_normalizeAssociations( array $associations )
Возвращает массив из исходного переданного списка ассоциаций, где обозначение точек преобразуется во вложенные массивы, чтобы они могли быть обработаны другими процедурами.
Параметры
- массив
$associations - Массив включенных ассоциаций.
Возвращаемое значение
массивМассив, в котором обозначение точек преобразовано во вложенные массивы
Подробности свойств
© 2005–2017 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.
https://api.cakephp.org/3.4/class-Cake.ORM.AssociationCollection.html