Spec-Zone.ru › CakePHP 3.5

Класс AssociationCollection

Контейнер/коллекция для ассоциативных классов.

Содержит методы для управления ассоциациями и упорядочивания операций сохранения и удаления.

Cake\ORM\AssociationCollection реализует IteratorAggregate использует Cake\ORM\AssociationsNormalizerTrait
Пространство имен: Cake\ORM
Расположение: ORM/AssociationCollection.php

Краткое описание свойств

  • $_items protected
    Cake\ORM\Association[]
    Сохранённые ассоциации

Краткое описание методов

  • _getNoCascadeItems() protected
    Возвращает элементы без обратного вызова каскадирования.
  • _save() protected
    Вспомогательный метод для сохранения данных ассоциации.
  • _saveAssociations() protected
    Вспомогательный метод для сохранения данных ассоциации.
  • add() public
    Добавить ассоциацию в коллекцию
  • cascadeDelete() public

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

  • get() public
    Получить присоединённую ассоциацию по имени.
  • getByProperty() public
    Получить ассоциацию по имени свойства.
  • getByType() 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.

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 )

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

Параметры

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

Возвращает

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

keys()source public

keys( )

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

Возвращает

array
END_OF_DOCUMENT_MARKER

normalizeKeys()source public

normalizeKeys( boolean|array $keys )

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

Параметры

boolean|array $keys
список имён ассоциаций для нормализации

Возвращает

array

remove()source public

remove( string $alias )

Удаляет ассоциацию.

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

Параметры

string $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
Сущность для сохранения связанных данных.
array $associations

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

array $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
Сущность для сохранения связанных данных.
array $associations

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

array $options optional []
Параметры для операции сохранения.

Возвращает

boolean
Успех

type()source public

type( string|array $class )

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

Устарело

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

Параметры

string|array $class

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

Возвращает

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

Методы, используемые из Cake\ORM\AssociationsNormalizerTrait

_normalizeAssociations()source protected

_normalizeAssociations( array $associations )

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

Параметры

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

Возвращает

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

Подробное описание свойств

$_itemssource

protected Cake\ORM\Association[]

Хранение ассоциаций

[]

© 2005–2018 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.5/class-Cake.ORM.AssociationCollection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API