Класс HasMany

_foreignKeyAcceptsNull()source protected

_foreignKeyAcceptsNull( Cake\ORM\Table $table , array $properties )

Проверяет флаг nullable внешнего ключа

Параметры

Cake\ORM\Table $table

таблица, содержащая внешний ключ

массив $properties

список полей, составляющих внешний ключ

Возвращает

boolean

_options()source protected

_options( array $opts )

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

Параметры

массив $opts

исходный список параметров, переданных в конструктор

Переопределяет

Cake\ORM\Association::_options()

_saveTarget()source protected

_saveTarget( array $foreignKeyReference , Cake\Datasource\EntityInterface $parentEntity , array|Traversable $entities , array $options )

Сохраняет каждый из сущностей в целевой таблице и создаёт связи между родительской сущностью и каждой из сохранённых целевых сущностей.

Параметры

массив $foreignKeyReference

Внешний ключ, определяющий связь между целевой сущностью и родительской сущностью.

Cake\Datasource\EntityInterface $parentEntity

Исходная сущность, содержащая целевые сущности, которые необходимо сохранить.

массив|Перечисляемый $entities

список сущностей для сохранения в целевой таблице и для создания связи с родительской сущностью

массив $options

список опций, принимаемых Table::save().

Возвращает

boolean
true при успехе, false в противном случае.

_unlink()source protected

_unlink( array $foreignKey , Cake\ORM\Table $target , array $conditions = [] , array $options = [] )

Удаляет/устанавливает null связанные объекты, соответствующие $conditions. Действие, которое выполняется, зависит от зависимости между исходной и целевыми сущностями, а также от возможности null для внешнего ключа

Параметры

массив $foreignKey

массив свойств внешнего ключа

Cake\ORM\Table $target

Связанная таблица

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

Условие, которое определяет, какие объекты должны быть разъединены

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

список опций, принимаемых Table::delete()

Возвращает

boolean
успех

_unlinkAssociated()source protected

_unlinkAssociated( array $foreignKeyReference , Cake\Datasource\EntityInterface $entity , Cake\ORM\Table $target , array $remainingEntities = [] , array $options = [] )

Удаляет/устанавливает null связанные объекты в соответствии с зависимостью между исходными и целевыми сущностями и возможностью null для внешнего ключа. Пропускает удаление записей, присутствующих в $remainingEntities

Параметры

массив $foreignKeyReference

Внешний ключ, определяющий связь между целевой сущностью и родительской сущностью.

Cake\Datasource\EntityInterface $entity

сущность, которой должны быть удалены связанные сущности

Cake\ORM\Table $target

Связанная таблица

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

Сущности, которые не должны быть удалены

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

список опций, принимаемых Table::delete()

Возвращает

boolean
успех

canBeJoined()source public

canBeJoined( array $options = [] )

Можно ли выразить эту связь непосредственно в соединении запроса

Параметры

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

настраиваемый ключ опций, который может изменить возвращаемое значение

Возвращает

boolean

если ключ 'matching' в $option равен true, то эта функция вернёт true, в противном случае - false

Переопределяет

Cake\ORM\Association::canBeJoined()

cascadeDelete()source public

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

Обрабатывает каскадное удаление из связанной модели.

Параметры

Cake\Datasource\EntityInterface $entity

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

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

Опции для исходного удаления.

Возвращает

boolean
Успех

defaultRowValue()source public

defaultRowValue( array $row , boolean $joined )

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

Параметры

массив $row

Строка, для которой нужно установить значение по умолчанию.

boolean $joined

Является ли строка результатом непосредственного соединения с этой ассоциацией

Возвращает

массив

Переопределяет

Cake\ORM\Association::defaultRowValue()

eagerLoader()source public

eagerLoader( array $options )

Загружает жадно список записей в целевой таблице, которые связаны с другим набором записей в исходной таблице. Исходные записи могут быть указаны двумя способами: первый — передать объект запроса, настроенный для поиска в исходной таблице, а второй — явно передать массив значений первичного ключа из исходной таблицы.

Параметры

массив $options

Опции для жадной загрузки.

Возвращает

Замыкание

getForeignKey()source public

getForeignKey( )

Получает имя поля, представляющего внешний ключ к исходной таблице.

Возвращает

строка

Переопределяет

Cake\ORM\Association::getForeignKey()

getSaveStrategy()source public

getSaveStrategy( )

Получает стратегию, которая должна быть использована для сохранения.

Возвращает

строка
используемая стратегия сохранения

getSort()source public

getSort( )

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

Возвращает

смешанное

isOwningSide()source public

isOwningSide( Cake\ORM\Table $side )

Возвращает, является ли переданная таблица стороной владения для этой ассоциации. Это означает, что строки в таблице «target» упустят важную или необходимую информацию, если строки в «source» не будет.

Параметры

Cake\ORM\Table $side

Возможная таблица с владением

Возвращает

boolean

link()source public

link( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities , array $options = [] )

Связывает исходную сущность с каждой из предоставленных целевых сущностей. При использовании этого метода все сущности в $targetEntities будут добавлены к свойству исходной сущности, соответствующему этому объекту ассоциации.

Этот метод не проверяет уникальность связи. Изменения сохраняются в базе данных, а также в исходной сущности.

Пример:

$user = $users->get(1);
$allArticles = $articles->find('all')->toArray();
$users->Articles->link($user, $allArticles);

$user->get('articles') будет содержать все статьи из $allArticles после связывания

Параметры

Cake\Datasource\EntityInterface $sourceEntity

строка, принадлежащая стороне source этой ассоциации

массив $targetEntities

список сущностей, принадлежащих стороне target этой ассоциации

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

список опций, которые будут переданы внутреннему вызову save

Возвращает

boolean
true при успехе, false в противном случае

replace()source public

replace( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities , array $options = [] )

Заменяет существующие ассоциативные связи между сущностью-источником и целевой сущностью на предоставленные. Этот метод выполняет умную очистку, связи, которые уже сохранены и присутствуют в $targetEntities не будут удалены, новые связи будут созданы для переданных целевых сущностей, которые ещё не находятся в базе данных, а остальные будут удалены.

Например, если у автора много статей, таких как 'статья1', 'статья 2' и 'статья 3', и вы передаете в этот метод массив, содержащий сущности для статей 'статья 1' и 'статья 4', только связь для 'статья 1' будет сохранена в базе данных, связи для 'статья 2' и 'статья 3' будут удалены, а связь для 'статья 4' будет создана.

Существующие связи не удаляются и не создаются заново, они либо остаются без изменений, либо обновляются.

Этот метод не проверяет уникальность связей.

При успешном выполнении переданный $sourceEntity будет содержать $targetEntities в качестве значения в соответствующем свойстве для этой ассоциации.

Дополнительные параметры для сохранения новых связей можно передать в третьем аргументе, см. Table::save() для информации о поддерживаемых параметрах.

Пример:

$author->articles = [$article1, $article2, $article3, $article4];
$authors->save($author);
$articles = [$article1, $article3];
$authors->getAssociation('articles')->replace($author, $articles);

$author->get('articles') будет содержать только [$article1, $article3] в конце

Параметры

Cake\Datasource\EntityInterface $sourceEntity

сущность, сохранённая в таблице-источнике для этой ассоциации

массив $targetEntities

список сущностей из целевой таблицы, которые нужно связать

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

список параметров, которые нужно передать внутренним вызовам save/delete при сохранении/обновлении новых связей или удалении существующих

Возвращает

boolean
успех

Выбрасывает

InvalidArgumentException

если переданы не сохранённые сущности или если какая-либо из них отсутствует значение первичного ключа

saveAssociated()source public

saveAssociated( Cake\Datasource\EntityInterface $entity , array $options = [] )

Принимает сущность из таблицы-источника и проверяет, есть ли поле, соответствующее имени свойства для этой ассоциации. Найденная сущность будет сохранена в целевой таблице для этой ассоциации, передав предоставленные $options

Параметры

Cake\Datasource\EntityInterface $entity

сущность из таблицы-источника

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

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

Возвращает

boolean|Cake\Datasource\EntityInterface

false, если $entity не удалось сохранить, в противном случае возвращает сохранённую сущность

Выбрасывает

InvalidArgumentException
при невозможности обработки данных ассоциации.

См. также

\Cake\ORM\Table::save()

saveStrategy()source public deprecated

saveStrategy( string|null $strategy = null )

Устанавливает стратегию, которая должна использоваться для сохранения. Если вызвана без аргументов, она вернёт текущую настроенную стратегию

Устарело

3.4.0 Используйте setSaveStrategy()/getSaveStrategy() вместо этого.

Параметры

строка|null $strategy необязательно null

имя стратегии, которая должна использоваться

Возвращает

строка
стратегия, которая будет использоваться для сохранения

Выбрасывает

InvalidArgumentException
если передано недопустимое имя стратегии

setSaveStrategy()source public

setSaveStrategy( string $strategy )

Устанавливает стратегию, которая должна использоваться для сохранения.

Параметры

строка $strategy

имя стратегии, которая должна использоваться

Возвращает

$this

Выбрасывает

InvalidArgumentException
если передано недопустимое имя стратегии

setSort()source public

setSort( mixed $sort )

Устанавливает порядок сортировки, в котором должны возвращаться целевые записи.

Параметры

смешанный $sort

запрос порядка сортировки, совместимый с find()

Возвращает

$this

sort()source public deprecated

sort( mixed $sort = null )

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

Устарело

3.4.0 Используйте setSort()/getSort() вместо этого.

Параметры

смешанный $sort необязательно null

запрос порядка сортировки, совместимый с find()

Возвращает

смешанный

type()source public

type( )

Получить тип отношения.

Возвращает

строка

unlink()source public

unlink( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities , array $options = [] )

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

Параметры

В дополнение к стандартным параметрам, принимаемым Table::delete(), поддерживаются следующие ключи:

• cleanProperty: Удалять или нет все объекты в $targetEntities, которые хранятся в $sourceEntity (по умолчанию: true)

По умолчанию этот метод удалит каждый из объектов сущностей, сохраненных внутри сущности-источника.

Изменения сохраняются в базе данных и также в сущности-источнике.

Пример:

$user = $users->get(1);
$user->articles = [$article1, $article2, $article3, $article4];
$users->save($user, ['Associated' => ['Articles']]);
$allArticles = [$article1, $article2, $article3];
$users->Articles->unlink($user, $allArticles);

$article->get('articles') будет содержать только [$article4] после удаления из базы данных

Параметры

Cake\Datasource\EntityInterface $sourceEntity

сущность, сохранённая в таблице-источнике для этой ассоциации

массив $targetEntities

список сохранённых в базе данных сущностей из целевой таблицы для этой ассоциации

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

список параметров, которые нужно передать внутреннему вызову delete

Выбрасывает

InvalidArgumentException

если переданы не сохранённые сущности или если какая-либо из них отсутствует значение первичного ключа

__call()source public

__call( string $method , array $argument )

Перенаправляет вызовы методов к целевой таблице.

Параметры

строка $method

имя метода, который нужно вызвать

массив $argument

список аргументов, переданных функции

Возвращает

смешанный

Выбрасывает

BadMethodCallException

__construct()source public

__construct( string $alias , array $options = [] )

Конструктор. Подклассы могут переопределить функцию _options, чтобы получить исходный список переданных параметров, если ожидаются какие-либо другие специальные ключи

Параметры

строка $alias

имя, присвоенное ассоциации

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

список свойств, которые нужно установить для этого объекта

__get()source public

__get( string $property )

Перенаправляет получение свойств к целевой таблице. Это удобно для получения ассоциаций этой ассоциации

Параметры

строка $property

имя свойства

Возвращает

Cake\ORM\Association

Выбрасывает

RuntimeException
если ассоциация с таким именем не существует

__isset()source public

__isset( string $property )

Перенаправляет вызов isset к целевой таблице. Это удобно для проверки, есть ли у целевой таблицы другая ассоциация с переданным именем

Параметры

строка $property

имя свойства

Возвращает

boolean
true, если свойство существует

_appendFields()source protected

_appendFields( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )

Вспомогательная функция для условного добавления полей в предложение SELECT запроса из полей другого объекта запроса.

Параметры

Cake\ORM\Query $query

запрос, к которому будут добавлены поля

Cake\ORM\Query $surrogate

запрос, поля которого будут скопированы

массив $options

параметры, передаваемые в метод attachTo

_appendNotMatching()source protected

_appendNotMatching( Cake\Datasource\QueryInterface $query , array $options )

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

Параметры

Cake\Datasource\QueryInterface $query

Запрос, который нужно изменить

массив $options

Массив параметров, содержащий ключ negateMatch.

_bindNewAssociations()source protected

_bindNewAssociations( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )

Применяет все присоединяемые ассоциации к $query из содержаний, найденных в запросе $surrogate.

Копирует все содержащиеся ассоциации из запроса $surrogate в переданный $query. Содержания изменены таким образом, что они соблюдают цепочку ассоциаций, из которой они произошли.

Параметры

Cake\ORM\Query $query

запрос, к которому будут прикреплены ассоциации

Cake\ORM\Query $surrogate

запрос, содержащий содержащиеся ассоциации, которые нужно прикрепить

массив $options

параметры, передаваемые в метод attachTo

_dispatchBeforeFind()source protected

_dispatchBeforeFind( Cake\ORM\Query $query )

Вызывает beforeFind для целевой таблицы запроса, к которому присоединяется эта ассоциация

Параметры

Cake\ORM\Query $query

запрос, к которому присоединяется эта ассоциация

_extractFinder()source protected

_extractFinder( string|array $finderData )

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

Возвращает определенные параметры из нахождения $type.

Примеры:

Следующее вызовет нахождение 'translations' со значением нахождения в качестве его параметров: $query->contain(['Comments' => ['finder' => ['translations']]]); $query->contain(['Comments' => ['finder' => ['translations' => []]]]); $query->contain(['Comments' => ['finder' => ['translations' => ['locales' => ['en_US']]]]]);

Параметры

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

Имя нахождения или массив с именем в качестве ключа и параметрами в качестве значения.

Возвращает

массив

_formatAssociationResults()source protected

_formatAssociationResults( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )

Добавляет функцию форматирования к переданному $query , если запрос $surrogate объявляет другую функцию форматирования. Поскольку запрос $surrogate соответствует целевой таблице ассоциации, результирующая функция форматирования будет результатом применения функций форматирования только к свойству, соответствующему данной таблице.

Параметры

Cake\ORM\Query $query

запрос, к которому будет применено форматирование

Cake\ORM\Query $surrogate

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

массив $options

параметры, передаваемые в метод attachTo

_getClassName()source protected

_getClassName( string $alias , array $options = [] )

Получает имя класса таблицы.

Параметры

строка $alias

Имя псевдонима, которое вы хотите получить.

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

Массив параметров таблицы.

Возвращает

строка

_joinCondition()source protected

_joinCondition( array $options )

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

Параметры

массив $options

список параметров, передаваемых методу attachTo

Возвращает

массив

Исключения

RuntimeException

если количество столбцов в foreignKey не соответствует количеству столбцов в первичном ключе исходной таблицы

_propertyName()source protected

_propertyName( )

Возвращает имя свойства по умолчанию, основанное на имени ассоциации.

Возвращает

строка

attachTo()source public

attachTo( Cake\ORM\Query $query , array $options = [] )

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

Массив параметров принимает следующие ключи:

• includeFields: Включать ли поля целевой модели в результат
• foreignKey: Имя поля, используемого в качестве внешнего ключа, если false, не будет использоваться
• conditions: массив с условиями фильтрации объединения, будет объединен с любыми исходно настроенными условиями для этой ассоциации
• fields: список полей в целевой таблице, которые следует включить в результат
• type: Тип объединения (например, INNER) для записей, найденных в этой ассоциации
• aliasPath: Строка с точками, представляющая путь имен ассоциаций, следующих от основной таблицы переданного запроса к этой ассоциации.
• propertyPath: Строка с точками, представляющая путь свойств ассоциации, за которыми нужно следовать от основного сущности переданного запроса к этой ассоциации
• joinType: Тип SQL-соединения для использования в запросе.
• negateMatch: Добавит условие в переданный запрос для исключения совпадений с этой ассоциацией.

Параметры

Cake\ORM\Query $query

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

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

Дополнительные параметры или переопределения для учета

Исключения

RuntimeException

если переданный конструктор запроса не возвращает объект запроса

bindingKey()source public deprecated

bindingKey( string|null $key = null )

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

Если параметры не переданы, возвращается текущее поле.

Устарело

3.4.0 Используйте setBindingKey()/getBindingKey() вместо этого.

Параметры

строка|null $key необязательно null

поле таблицы, используемое для связи обеих таблиц

Возвращает

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

cascadeCallbacks()source public deprecated

cascadeCallbacks( boolean|null $cascadeCallbacks = null )

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

Устарело

3.4.0 Используйте setCascadeCallbacks()/getCascadeCallbacks() вместо этого.

Параметры

boolean|null $cascadeCallbacks необязательно null

значение переключателя каскадных обратных вызовов

Возвращает

boolean

className()source public deprecated

className( )

Имя класса целевой таблицы

Устарело

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

Возвращает

строка

conditions()source public deprecated

conditions( array|null $conditions = null )

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

Устарело

3.4.0 Используйте setConditions()/getConditions() вместо этого.

Параметры

array|null $conditions optional null

список условий для использования

Возвращает

array|callable

См. также

\Cake\Database\Query::where() для примеров формата массива

deleteAll()source public

deleteAll( mixed $conditions )

Делегирует операцию удаления методу deleteAll целевой таблицы.

Параметры

mixed $conditions

Условия для использования, принимает любые значения, которые может принять Query::where().

Возвращает

integer
Возвращает количество затронутых строк.

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public deprecated

dependent( boolean|null $dependent = null )

Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.

Это используется в первую очередь для указания, что записи должны быть удалены, если запись-владелец в исходной таблице удаляется.

Если параметры не переданы, возвращается текущее значение.

Устарело

3.4.0 Используйте setDependent()/getDependent() вместо этого.

Параметры

boolean|null $dependent optional null

Установите режим зависимости. Используйте null для чтения текущего состояния.

Возвращает

boolean

exists()source public

exists( array|callable|Cake\Database\ExpressionInterface $conditions )

Делегирует операцию методу exists целевой таблицы после добавления стандартных условий для этого объединения.

Параметры

array|callable|Cake\Database\ExpressionInterface $conditions

Условия для проверки наличия совпадающей записи.

Возвращает

boolean

См. также

\Cake\ORM\Table::exists()

find()source public

find( string|array|null $type = null , array $options = [] )

Делегирует операцию поиска методу find целевой таблицы и соответственно изменяет запрос на основе этой конфигурации объединения.

Параметры

string|array|null $type optional null

тип запроса, если передается массив, он интерпретируется как параметр $options

array $options optional []

Параметры для поиска

Возвращает

Cake\ORM\Query

См. также

\Cake\ORM\Table::find()

finder()source public deprecated

finder( string|null $finder = null )

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

Устарело

3.4.0 Используйте setFinder()/getFinder() вместо этого.

Параметры

string|null $finder optional null

имя поиска для использования

Возвращает

string|array

foreignKey()source public deprecated

foreignKey( string|null $key = null )

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

Устарело

3.4.0 Используйте setForeignKey()/getForeignKey() вместо этого.

Параметры

string|null $key optional null

ключ, используемый для связи обеих таблиц

Возвращает

string|array

getBindingKey()source public

getBindingKey( )

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

Возвращает

string|array

getCascadeCallbacks()source public

getCascadeCallbacks( )

Получает, должны ли также срабатывать обратные вызовы при каскадном удалении.

Возвращает

boolean

getClassName()source public

getClassName( )

Получает имя класса объекта целевой таблицы.

Возвращает

string

getConditions()source public

getConditions( )

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

Возвращает

array|callable

См. также

\Cake\Database\Query::where() для примеров формата массива

getDependent()source public

getDependent( )

Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.

Это используется в первую очередь для указания, что записи должны быть удалены, если запись-владелец в исходной таблице удаляется.

Возвращает

boolean

getFinder()source public

getFinder( )

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

Возвращает

string|array

getJoinType()source public

getJoinType( )

Получает тип объединения, используемого при добавлении объединения в запрос.

Возвращает

string

getName()source public

getName( )

Получает имя для этого объединения, обычно псевдоним, назначенный целевой связанной таблице.

Возвращает

string

getProperty()source public

getProperty( )

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

Возвращает

string

getSource()source public

getSource( )

Получает экземпляр таблицы для стороны источника объединения.

Возвращает

Cake\ORM\Table

getStrategy()source public

getStrategy( )

Получает имя стратегии, которое будет использоваться для извлечения связанных записей. Имейте в виду, что некоторые типы объединений могут не реализовать, но стратегия по умолчанию, что делает любые изменения в этом параметре недействительными.

Возвращает

string

getTarget()source public

getTarget( )

Получает экземпляр таблицы для целевой стороны объединения.

Возвращает

Cake\ORM\Table

joinType()source public deprecated

joinType( string|null $type = null )

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

Устаревшее

3.4.0 Используйте setJoinType()/getJoinType() вместо этого.

Параметры

string|null $type optional null

тип объединения (например, INNER)

Возвращает

string

name()source public deprecated

name( string|null $name = null )

Устанавливает имя для этой ассоциации.

Устаревшее

3.4.0 Используйте setName()/getName() вместо этого.

Параметры

string|null $name optional null

Назначаемое имя

Возвращает

string

property()source public deprecated

property( string|null $name = null )

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

Устаревшее

3.4.0 Используйте setProperty()/getProperty() вместо этого.

Параметры

string|null $name optional null

Имя свойства ассоциации. Используйте null для чтения текущего значения.

Возвращает

string

requiresKeys()source public

requiresKeys( array $options = [] )

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

Параметры

array $options optional []

Параметры, содержащие используемую стратегию.

Возвращает

boolean
true, если потребуется список ключей

setBindingKey()source public

setBindingKey( string|array $key )

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

Параметры

string|array $key

поле(я) таблицы, используемые для связи обеих таблиц

Возвращает

$this

setCascadeCallbacks()source public

setCascadeCallbacks( boolean $cascadeCallbacks )

Устанавливает, будут ли срабатывать обратные вызовы при каскадных удалениях.

Параметры

boolean $cascadeCallbacks

значение переключателя каскадных обратных вызовов

Возвращает

$this

setClassName()source public

setClassName( string $className )

Устанавливает имя класса объекта целевой таблицы.

Параметры

string $className

Имя класса для установки.

Возвращает

$this

Исключения

InvalidArgumentException

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

setConditions()source public

setConditions( array|callable $conditions )

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

Параметры

array|callable $conditions

список используемых условий

Возвращает

$this

См. также

\Cake\Database\Query::where() для примеров формата массива

setDependent()source public

setDependent( boolean $dependent )

Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.

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

Если параметры не переданы, возвращается текущее значение.

Параметры

boolean $dependent

Устанавливает зависимый режим. Используйте null для чтения текущего состояния.

Возвращает

$this

setFinder()source public

setFinder( string|array $finder )

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

Параметры

string|array $finder

имя используемого поиска или массив с именем поиска и опцией.

Возвращает

$this

setForeignKey()source public

setForeignKey( string|array $key )

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

Параметры

string|array $key

ключ или ключи, используемые для связи обеих таблиц

Возвращает

$this

setJoinType()source public

setJoinType( string $type )

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

Параметры

string $type

тип объединения (например, INNER)

Возвращает

$this

setName()source public

setName( string $name )

Устанавливает имя этой ассоциации, обычно псевдоним, назначенный целевой таблице ассоциации.

Параметры

string $name

Назначаемое имя

Возвращает

$this

setProperty()source public

setProperty( string $name )

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

Параметры

string $name

Имя свойства ассоциации. Используйте null для чтения текущего значения.

Возвращает

$this

setSource()source public

setSource( Cake\ORM\Table $table )

Устанавливает экземпляр таблицы для исходной стороны ассоциации.

Параметры

Cake\ORM\Table $table

экземпляр, который нужно назначить в качестве исходной стороны

Возвращает

$this

setStrategy()source public

setStrategy( string $name )

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

Параметры

string $name

тип стратегии. Используйте null для чтения текущего значения.

Возвращает

$this

Исключения

InvalidArgumentException
При указании недействительной стратегии.

setTarget()source public

setTarget( Cake\ORM\Table $table )

Устанавливает экземпляр таблицы для целевой стороны ассоциации.

Параметры

Cake\ORM\Table $table

экземпляр, который нужно назначить в качестве целевой стороны

Возвращает

$this

source()source public deprecated

source( Cake\ORM\Table $table = null )

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

Deprecated

3.4.0 Используйте setSource()/getSource() вместо этого.

Parameters

Cake\ORM\Table $table optional null

экземпляр, который нужно назначить стороной источника

Returns

Cake\ORM\Table

strategy()source public deprecated

strategy( string|null $name = null )

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

Deprecated

3.4.0 Используйте setStrategy()/getStrategy() вместо этого.

Parameters

string|null $name optional null

Тип стратегии. Используйте null для чтения текущего значения.

Returns

string

Throws

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

target()source public deprecated

target( Cake\ORM\Table $table = null )

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

Deprecated

3.4.0 Используйте setTarget()/getTarget() вместо этого.

Parameters

Cake\ORM\Table $table optional null

экземпляр, который нужно назначить целевой стороной

Returns

Cake\ORM\Table

transformRow()source public

transformRow( array $row , string $nestKey , boolean $joined , string|null $targetProperty = null )

Правильно вкладывает значения связанных строк результатов в правильные ключи массива внутри исходных результатов.

Parameters

array $row

Строка для преобразования

string $nestKey

Ключ массива, в котором должны быть найдены результаты этой ассоциации

boolean $joined

Является ли строка результатом прямого соединения с этой ассоциацией

string|null $targetProperty optional null

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

Returns

array

updateAll()source public

updateAll( array $fields , mixed $conditions )

Делегирует операцию обновления методу updateAll целевой таблицы

Parameters

array $fields

Хэш поля => нового значения.

mixed $conditions

Условия, которые будут использованы, принимает все, что Query::where() может принять.

Returns

integer
Количество измененных строк.

See

\Cake\ORM\Table::updateAll()

_camelize()source protected

_camelize( string $name )

Создает пришлизованную версию $name

Parameters

string $name

имя

Returns

string
Пришлизованное имя

_entityName()source protected

_entityName( string $name )

Создает правильное имя сущности (единственного числа) для указанного имени

Parameters

string $name

Имя

Returns

string
Пришлизованное и множественное имя модели

_fixtureName()source protected

_fixtureName( string $name )

Создает имя фикстуры

Parameters

string $name

Имя класса модели

Returns

string
Единственное число ключа модели

_modelKey()source protected

_modelKey( string $name )

Создает правильный подчеркнутый ключ модели для ассоциаций

Если вход содержит точку, предполагается, что правая часть — это фактическое имя таблицы.

Parameters

string $name

Имя класса модели

Returns

string
Единственное число ключа модели

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

Создает правильное имя модели из внешнего ключа

Parameters

string $key

Внешний ключ

Returns

string
Имя модели

_pluginNamespace()source protected

_pluginNamespace( string $pluginName )

Возвращает пространство имен плагина

Parameters

string $pluginName

Имя плагина

Returns

string
Пространство имен плагина

_pluginPath()source protected

_pluginPath( string $pluginName )

Находит правильный путь для плагина. Ищет в $pluginPaths нужный плагин.

Parameters

string $pluginName

Имя плагина, например, DebugKit

Returns

string
Путь к нужному плагину.

_pluralHumanName()source protected

_pluralHumanName( string $name )

Создает множественное человеческое имя, используемое в представлениях

Parameters

string $name

Имя контроллера

Returns

string
Множественное человеческое имя

_singularHumanName()source protected

_singularHumanName( string $name )

Создает единственное человеческое имя, используемое в представлениях

Parameters

string $name

Имя контроллера

Returns

string
Единственное человеческое имя

_singularName()source protected

_singularName( string $name )

Создает единственное имя для использования в представлениях.

Parameters

string $name

Используемое имя

Returns

string
Имя переменной

_variableName()source protected

_variableName( string $name )

Создает множественное имя переменной для представлений

Parameters

string $name

Используемое имя

Returns

string
Множественное имя для представлений

getTableLocator()source public

getTableLocator( )

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

Returns

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

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

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

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Returns

$this

tableLocator()source public deprecated

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

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

Deprecated

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

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator optional null

Экземпляр LocatorInterface.

Returns

Cake\ORM\Locator\LocatorInterface

Cake\ORM\Association\QueryInterface::JOIN_TYPE_INNER

self::SAVE_APPEND

self::STRATEGY_SELECT

[
    self::STRATEGY_SELECT,
    self::STRATEGY_SUBQUERY
]