Класс BelongsToMany

_appendJunctionJoin()source protected

_appendJunctionJoin( Cake\ORM\Query $query , string|array $conditions )

Добавление соединения к таблице сопряжения.

Параметры

Cake\ORM\Query $query

Запрос для добавления.

string|array $conditions

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

Возвращает

Cake\ORM\Query
Изменённый запрос.

_appendNotMatching()source protected

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

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

Параметры

Cake\Datasource\QueryInterface $query

Запрос для изменения

array $options

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

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

Cake\ORM\Association::_appendNotMatching()

_buildQuery()source protected

_buildQuery( array $options )

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

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

Параметры

array $options

опции, принятые eagerLoader()

Возвращает

Cake\ORM\Query

Выбрасывает

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

_buildResultMap()source protected

_buildResultMap( Cake\ORM\Query $fetchQuery , array $options )

Создаёт массив, содержащий результаты из fetchQuery, индексированные по значению foreignKey, соответствующему этому ассоциации.

Параметры

Cake\ORM\Query $fetchQuery

Запрос для получения результатов

массив $options

Параметры, переданные в загрузчик eager

Возвращает

массив

Вызывает исключение

RuntimeException
в случае, если свойство ассоциации не является частью набора результатов.

_checkPersistenceStatus()source protected

_checkPersistenceStatus( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities )

Выбрасывает исключение, если какой-либо из переданных сущностей не сохранён.

Параметры

Cake\Datasource\EntityInterface $sourceEntity

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

массив $targetEntities

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

Возвращает

boolean

Вызывает исключение

InvalidArgumentException

_collectJointEntities()source protected

_collectJointEntities( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities )

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

Строка, относящаяся к стороне источника этой ассоциации.

массив $targetEntities

Строки, относящиеся к стороне целевого объекта этой ассоциации.

Возвращает

массив

Вызывает исключение

InvalidArgumentException

если у какой-либо из сущностей отсутствует значение первичного ключа

_diffLinks()source protected

_diffLinks( Cake\ORM\Query $existing , array $jointEntities , array $targetEntities , array $options [] )

Вспомогательный метод, используемый для удаления различий между ссылками, переданными в $existing и $jointEntities. Этот метод вернёт значения из $targetEntities, которые не были удалены при расчёте разницы.

Параметры

Cake\ORM\Query $existing

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

массив $jointEntities

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

массив $targetEntities

сущности в целевой таблице, связанные с $jointEntities

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

список параметров, принятых Table::delete()

Возвращает

массив

_generateJunctionAssociations()source protected

_generateJunctionAssociations( Cake\ORM\Table $junction , Cake\ORM\Table $source , Cake\ORM\Table $target )

Генерирует ассоциации в таблице соединения по мере необходимости.

Генерирует следующие ассоциации:

• junction belongsTo source e.g. ArticlesTags belongsTo Tags
• junction belongsTo target e.g. ArticlesTags belongsTo Articles

Вы можете переопределить эти сгенерированные ассоциации, определив ассоциации с соответствующими псевдонимами.

Параметры

Cake\ORM\Table $junction

Таблица соединения.

Cake\ORM\Table $source

Исходная таблица.

Cake\ORM\Table $target

Целевая таблица.

_generateSourceAssociations()source protected

_generateSourceAssociations( Cake\ORM\Table $junction , Cake\ORM\Table $source )

Генерирует дополнительные ассоциации исходной таблицы по мере необходимости.

Генерирует следующие ассоциации:

• source hasMany junction e.g. Tags hasMany ArticlesTags

Вы можете переопределить эти сгенерированные ассоциации, определив ассоциации с соответствующими псевдонимами.

Параметры

Cake\ORM\Table $junction

Таблица соединения.

Cake\ORM\Table $source

Исходная таблица.

_generateTargetAssociations()source protected

_generateTargetAssociations( Cake\ORM\Table $junction , Cake\ORM\Table $source , Cake\ORM\Table $target )

Генерирует взаимные ассоциации по мере необходимости.

Генерирует следующие ассоциации:

• target hasMany junction e.g. Articles hasMany ArticlesTags
• target belongsToMany source e.g Articles belongsToMany Tags.

Вы можете переопределить эти сгенерированные ассоциации, определив ассоциации с соответствующими псевдонимами.

Параметры

Cake\ORM\Table $junction

Таблица соединения.

Cake\ORM\Table $source

Исходная таблица.

Cake\ORM\Table $target

Целевая таблица.

_joinCondition()source protected

_joinCondition( array $options )

Возвращает false, так как условия соединения определены в таблице соединения.

Параметры

массив $options

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

Возвращает

boolean
false

Вызывает исключение

RuntimeException

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

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

Cake\ORM\Association::_joinCondition()

_junctionAssociationName()source protected

_junctionAssociationName( )

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

Возвращает

строка

_junctionTableName()source protected

_junctionTableName( string|null $name null )

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

Параметры

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

Имя таблицы соединения.

Возвращает

строка

_linkField()source protected

_linkField( array $options )

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

Параметры

массив $options

параметры для получения поля ссылки.

Возвращает

строка

_options()source protected

_options( array $opts )

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

Параметры

массив $opts

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

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

Cake\ORM\Association::_options()

_saveLinks()source protected

_saveLinks( Cake\Datasource\EntityInterface $sourceEntity , array $targetEntities , array $options )

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

сущность из исходной таблицы в данной ассоциации

массив $targetEntities

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

массив $options

список параметров, принятых Table::save()

Возвращает

boolean
успех

_saveTarget()source protected

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

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

Параметры

Cake\Datasource\EntityInterface $parentEntity

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

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

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

массив $options

список параметров, принятых Table::save()

Возвращает

Cake\Datasource\EntityInterface|boolean

родительская сущность после создания всех ссылок, если ошибок не было, иначе false

Вызывает исключение

InvalidArgumentException

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

attachTo()source public

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

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

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

• includeFields: Включать ли поля целевой модели в результат
• foreignKey: Название поля для использования в качестве внешнего ключа, если false, не используется
• conditions: Массив с условиями фильтрации для объединения
• fields: Список полей в целевой таблице для включения в результат
• type: Тип объединения (например, INNER)

Параметры

Cake\ORM\Query $query

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

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

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

Исключения

RuntimeException

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

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

Cake\ORM\Association::attachTo()

cascadeDelete()source public

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

Очищает данные в таблице соединения для данного объекта.

Параметры

Cake\Datasource\EntityInterface $entity

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

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

Параметры для исходного удаления.

Возвращает

boolean
Успех.

conditions()source public

conditions( array|null $conditions null )

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

Параметры

массив|null $conditions необязательный null

список условий

Возвращает

массив

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

Cake\ORM\Association::conditions()

find()source public

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

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

Если ваше объединение включает условия, таблица соединения будет включена в содержащие объединения запроса.

Параметры

строка|массив|null $type необязательный null

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

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

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

Возвращает

Cake\ORM\Query

См. также

\Cake\ORM\Table::find()

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

Cake\ORM\Association::find()

isOwningSide()source public

isOwningSide( Cake\ORM\Table $side )

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

Параметры

Cake\ORM\Table $side

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

Возвращает

boolean

junction()source public

junction( string|Cake\ORM\Table|null $table null )

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

Параметры

строка|Cake\ORM\Table|null $table необязательный null

Имя или экземпляр таблицы соединения

Возвращает

Cake\ORM\Table

junctionConditions()source protected

junctionConditions( )

Возвращает отфильтрованные условия, которые относятся конкретно к таблице соединения.

Возвращает

массив

link()source public

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

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

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

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

Пример:

$newTags = $tags->find('relevant')->toArray();
$articles->association('tags')->link($article, $newTags);

$article->get('tags') будет содержать все теги из $newTags после связывания.

Параметры

Cake\Datasource\EntityInterface $sourceEntity

строка, относящаяся к стороне source этого объединения

массив $targetEntities

список объектов, относящихся к стороне target этого объединения

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

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

Возвращает

boolean
true при успехе, иначе false

Исключения

InvalidArgumentException

если какой-либо из значений в $targetEntities не сохранен

replaceLinks()source public

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

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

Например, если статья связана с тегами «cake» и «framework», и вы передаете в этот метод массив, содержащий объекты тегов «cake», «php» и «awesome», только ссылка для «cake» будет сохранена в базе данных, ссылка для «framework» будет удалена, а ссылки для «php» и «awesome» будут созданы.

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

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

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

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

Пример:

$article->tags = [$tag1, $tag2, $tag3, $tag4];
$articles->save($article);
$tags = [$tag1, $tag3];
$articles->association('tags')->replaceLinks($article, $tags);

$article->get('tags') в конце будет содержать только [$tag1, $tag3]

Параметры

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()
\Cake\ORM\Association\BelongsToMany::replaceLinks()

saveStrategy()source public

saveStrategy( string|null $strategy null )

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

Параметры

string|null $strategy необязательный null

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

Возвращает

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

Исключения

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

targetConditions()source protected

targetConditions( )

Возвращает отфильтрованные условия, ссылающиеся на целевую таблицу.

Любые строковые выражения или объекты выражений также будут возвращены в этом списке.

Возвращает

mixed

Обычно массив. Если условия не являются массивом, условия ассоциации возвращаются без изменений.

targetForeignKey()source public

targetForeignKey( string|null $key null )

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

Параметры

string|null $key необязательный null

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

Возвращает

string

type()source public

type( )

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

Возвращает

string

unlink()source public

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

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

Параметры

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

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

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

Пример:

$article->tags = [$tag1, $tag2, $tag3, $tag4];
$tags = [$tag1, $tag2, $tag3];
$articles->association('tags')->unlink($article, $tags);

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

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

массив $targetEntities

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

массив|логическое $options необязательный []

список параметров, передаваемых внутреннему вызову delete, или значение типа boolean

Возвращает

boolean
Успех

Исключения

InvalidArgumentException

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

__call()source public

__call( string $method , array $argument )

Делегирует вызовы методов к целевой таблице.

Параметры

строка $method

имя вызываемого метода

массив $argument

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

Возвращает

mixed

Исключения

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

_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

_propertyName()source protected

_propertyName( )

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

Возвращает

строка

bindingKey()source public

bindingKey( string|null $key null )

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

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

Параметры

string|null $key необязательно null

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

Возвращает

string|array

canBeJoined()source public

canBeJoined( array $options [] )

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

Параметры

array $options необязательно []

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

Возвращает

boolean

cascadeCallbacks()source public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Параметры

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

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

Возвращает

boolean

className()source public

className( )

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

Возвращает

string

defaultRowValue()source public

defaultRowValue( array $row , boolean $joined )

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

Параметры

array $row

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

boolean $joined

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

Возвращает

array

deleteAll()source public

deleteAll( mixed $conditions )

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

Параметры

mixed $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public

dependent( boolean|null $dependent null )

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

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

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

Параметры

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

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

Возвращает

boolean

eagerLoader()source abstract public

eagerLoader( array $options )

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

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

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

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

• query: Объект запроса, настроенный для поиска записей исходной таблицы
• keys: Список значений первичного ключа из исходной таблицы
• foreignKey: Имя поля, используемого для связи обеих таблиц
• conditions: Список условий, которые должны быть переданы методу query where()
• sort: Направление, в котором должны быть возвращены записи
• fields: Список полей для выбора из целевой таблицы
• contain: Список связанных таблиц, которые необходимо загрузить в связке с целевой таблицей
• strategy: Имя стратегии, используемой для поиска записей целевой таблицы
• nestKey: Ключ массива, под которым будут найдены результаты при преобразовании строки

Параметры

array $options

Параметры для загрузки с помощью Eager Loading.

Возвращает

Closure

exists()source public

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

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

Параметры

array|callable|Cake\Database\ExpressionInterface $conditions

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

Возвращает

boolean

См. также

\Cake\ORM\Table::exists()

finder()source public

finder( string|null $finder null )

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

Параметры

string|null $finder необязательно null

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

Возвращает

string

foreignKey()source public

foreignKey( string|null $key null )

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

Параметры

string|null $key необязательно null

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

Возвращает

string|array

joinType()source public

joinType( string|null $type null )

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

Параметры

string|null $type необязательно null

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

Возвращает

string

name()source public

name( string|null $name null )

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

Параметры

string|null $name необязательно null

Присваиваемое имя

Возвращает

string

property()source public

property( string|null $name null )

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

Параметры

string|null $name необязательно null

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

Возвращает

string

source()source public

source( Cake\ORM\Table $table null )

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

Параметры

Cake\ORM\Table $table необязательно null

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

Возвращает

Cake\ORM\Table

strategy()source public

strategy( string|null $name null )

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

Параметры

string|null $name необязательно null

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

Возвращает

string

Исключения

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

target()source public

target( Cake\ORM\Table $table null )

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

Параметры

Cake\ORM\Table $table необязательно null

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

Возвращает

Cake\ORM\Table

transformRow()source public

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

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

Параметры

array $row

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

string $nestKey

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

boolean $joined

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

string $targetProperty необязательно null

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

Возвращает

array

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

array $fields

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

mixed $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::updateAll()

_defaultOptions()source protected

_defaultOptions( )

Возвращает значения параметров по умолчанию для eagerLoader

Возвращает

array

canBeJoined()source public

canBeJoined( array $options [] )

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

Параметры

array $options необязательно []

ключ пользовательских параметров, которые могут изменить значение возврата

Возвращает

boolean

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

defaultRowValue()source public

defaultRowValue( $row , $joined )

foreignKey()source public

foreignKey( string|null $key null )

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

Параметры

string|null $key необязательно null

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

Возвращает

string

sort()source public

sort( mixed $sort null )

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

Параметры

mixed $sort необязательно null

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

Возвращает

mixed

_camelize()source protected

_camelize( string $name )

Создаёт версию $name с использованием camelCase

Параметры

string $name

имя

Возвращает

string
Название в camelCase

_entityName()source protected

_entityName( string $name )

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

Параметры

string $name

Имя

Возвращает

string
Название модели в camelCase и единственном числе

_fixtureName()source protected

_fixtureName( string $name )

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

Параметры

string $name

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

Возвращает

string
Ключ модели в единственном числе

_modelKey()source protected

_modelKey( string $name )

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

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

Параметры

string $name

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

Возвращает

string
Ключ модели в единственном числе

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

string $key

Внешний ключ

Возвращает

string
Имя модели

_pluginNamespace()source protected

_pluginNamespace( string $pluginName )

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

Параметры

string $pluginName

Имя плагина

Возвращает

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

_pluginPath()source protected

_pluginPath( string $pluginName )

Находит правильный путь к плагину. Просматривает $pluginPaths для нужного плагина.

Параметры

string $pluginName

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

Возвращает

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

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularName()source protected

_singularName( string $name )

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

Параметры

string $name

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

Возвращает

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

_variableName()source protected

_variableName( string $name )

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

Параметры

string $name

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

Возвращает

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

tableLocator()source public

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

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

Параметры

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

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

true

'INNER'

'_joinData'

self::SAVE_REPLACE

self::STRATEGY_SELECT

[self::STRATEGY_SELECT, self::STRATEGY_SUBQUERY]