Класс 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()

_checkPersistenceStatus()source protected

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

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

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

array $targetEntities

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

Возвращаемое значение

boolean

Выбрасывает

InvalidArgumentException

_collectJointEntities()source protected

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

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

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

array $targetEntities

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

Возвращаемое значение

array

Выбрасывает

InvalidArgumentException

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

_diffLinks()source protected

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

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

Параметры

Cake\ORM\Query $existing

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

array $jointEntities

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

array $targetEntities

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

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

список опций, принятых Table::delete()

Возвращаемое значение

array

_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 )

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

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

• источник имеет много таблиц соединения, например, Тэги имеют много СтатейТэги

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

Параметры

Cake\ORM\Table $junction

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

Cake\ORM\Table $source

Таблица источника.

_generateTargetAssociations()source protected

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

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

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

• цель имеет много таблиц соединения, например, Статьи имеют много СтатьиТэги
• цель имеет много-ко-многим источник, например, Статьи имеют много-ко-многим Тэги.

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

Параметры

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

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

Возвращает

строка

_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

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

array|Traversable $entities

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

array $options

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

Возвращает

Cake\Datasource\EntityInterface|boolean

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

Исключения

InvalidArgumentException

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

attachTo()source public

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

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

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

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

Параметры

Cake\ORM\Query $query

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

array $options optional []

Дополнительные параметры или переопределения, которые необходимо принять во внимание

Исключения

RuntimeException

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

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

Cake\ORM\Association::attachTo()

canBeJoined()source public

canBeJoined( array $options [] )

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

Параметры

array $options optional []

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

Возвращает

boolean

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

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

Cake\ORM\Association::canBeJoined()

cascadeDelete()source public

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

Очистить данные в таблице соединения для заданной сущности.

Параметры

Cake\Datasource\EntityInterface $entity

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

array $options optional []

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

Возвращает

boolean
Успешно.

defaultRowValue()source public

defaultRowValue( array $row , boolean $joined )

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

Параметры

array $row

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

boolean $joined

Результат соединения напрямую с данной ассоциацией.

Возвращает

array

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

Cake\ORM\Association::defaultRowValue()

eagerLoader()source public

eagerLoader( array $options )

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

Параметры

array $options

Параметры для жадной загрузки.

Возвращает

callable

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()

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

Cake\ORM\Association::find()

getForeignKey()source public

getForeignKey( )

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

Возвращает

string

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

Cake\ORM\Association::getForeignKey()

getSaveStrategy()source public

getSaveStrategy( )

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

Возвращает

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

getSort()source public

getSort( )

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

Возвращает

mixed

getTargetForeignKey()source public

getTargetForeignKey( )

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

Возвращает

string

getThrough()source public

getThrough( )

Получает текущую таблицу соединения, либо имя экземпляра Table, либо сам экземпляр.

Возвращает

string|Cake\ORM\Table

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 )

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

Параметры

string|Cake\ORM\Table|null $table optional null

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

Возвращает

Cake\ORM\Table

junctionConditions()source protected

junctionConditions( )

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

Возвращает

array

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 )

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

Устарело

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

Параметры

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

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

Возвращает

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

Выбрасывает

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

setConditions()source public

setConditions( array $conditions )

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

Параметры

массив $conditions

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

Возвращает

$this

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

Cake\ORM\Association::setConditions()

setSaveStrategy()source public

setSaveStrategy( string $strategy )

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

Параметры

строка $strategy

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

Возвращает

$this

Выбрасывает

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

setSort()source public

setSort( mixed $sort )

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

Параметры

смешанный $sort

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

Возвращает

$this

setTargetForeignKey()source public

setTargetForeignKey( string $key )

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

Параметры

строка $key

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

Возвращает

$this

setThrough()source public

setThrough( string|Cake\ORM\Table $through )

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

Параметры

строка|Cake\ORM\Table $through

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

Возвращает

$this

sort()source public

sort( mixed $sort null )

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

Устарело

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

Параметры

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

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

Возвращает

смешанный

targetConditions()source protected

targetConditions( )

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

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

Возвращает

смешанный

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

targetForeignKey()source public

targetForeignKey( string|null $key null )

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

Устарело

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

Параметры

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, которые хранятся в $sourceEntity (по умолчанию: 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

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

array $targetEntities

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

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

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

Возвращает

boolean
Успех

Исключения

InvalidArgumentException

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

__call()source public

__call( string $method , array $argument )

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

Параметры

string $method

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

array $argument

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

Возвращает

mixed

Исключения

BadMethodCallException

__construct()source public

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

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

Параметры

string $alias

Имя связи

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

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

__get()source public

__get( string $property )

Делегирует получение свойств целевой таблице. Это полезно для получения ассоциаций данной связи.

Параметры

string $property

имя свойства

Возвращает

Cake\ORM\Association

Исключения

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

__isset()source public

__isset( string $property )

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

Параметры

string $property

имя свойства

Возвращает

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

_appendFields()source protected

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

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

Параметры

Cake\ORM\Query $query

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

Cake\ORM\Query $surrogate

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

array $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

запрос, содержащий содержащиеся ассоциации

array $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']]]]]);

Параметры

string|array $finderData

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

Возвращает

array

_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

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

array $options

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

_getClassName()source protected

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

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

Параметры

string $alias

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

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

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

Возвращает

string

_propertyName()source protected

_propertyName( )

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

Возвращает

string

bindingKey()source public

bindingKey( string|null $key null )

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

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

Устаревшее

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

Параметры

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

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

Возвращает

string|array

cascadeCallbacks()source public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Устаревшее

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

Параметры

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

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

Возвращает

boolean

className()source public

className( )

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

Возвращает

string

conditions()source public

conditions( array|null $conditions null )

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

Устаревшее

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

Параметры

array|null $conditions необязательно null

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

Возвращает

array

См. также

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

deleteAll()source public

deleteAll( mixed $conditions )

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

Параметры

mixed $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public

dependent( boolean|null $dependent null )

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

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

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

Устаревшее

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

Параметры

boolean|null $dependent необязательно 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()

finder()source public

finder( string|null $finder null )

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

Устаревшее

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

Параметры

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

имя используемого поиска

Возвращает

string

foreignKey()source public

foreignKey( string|null $key null )

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

Устаревшее

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

Параметры

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

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

Возвращает

string|array

getBindingKey()source public

getBindingKey( )

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

Возвращает

string|array

getCascadeCallbacks()source public

getCascadeCallbacks( )

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

Возвращает

boolean

getConditions()source public

getConditions( )

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

Возвращает

array

См. также

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

getDependent()source public

getDependent( )

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

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

Возвращает

boolean

getFinder()source public

getFinder( )

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

Возвращает

string

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

joinType( string|null $type null )

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

Устарело

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

Параметры

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

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

Возвращает

string

name()source public

name( string|null $name null )

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

Устарело

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

Параметры

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

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

Возвращает

string

property()source public

property( string|null $name null )

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

Устарело

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

Параметры

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

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

Возвращает

string

requiresKeys()source public

requiresKeys( array $options [] )

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

Параметры

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

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

Возвращает

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

setBindingKey()source public

setBindingKey( string|array $key )

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

Параметры

string|array $key

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

Возвращает

$this

setCascadeCallbacks()source public

setCascadeCallbacks( boolean $cascadeCallbacks )

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

Параметры

boolean $cascadeCallbacks

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

Возвращает

$this

setDependent()source public

setDependent( boolean $dependent )

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

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

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

Параметры

boolean $dependent

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

Возвращает

$this

setFinder()source public

setFinder( string $finder )

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

Параметры

string $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

source( Cake\ORM\Table $table null )

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

Устарело

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

Параметры

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

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

Возвращает

Cake\ORM\Table

strategy()source public

strategy( string|null $name null )

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

Устарело

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

Параметры

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

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

Возвращает

string

Исключения

InvalidArgumentException
Когда указана недопустимая стратегия.

target()source public

target( Cake\ORM\Table $table null )

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

Устарело

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

Параметры

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

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

Возвращает

Cake\ORM\Table

transformRow()source public

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

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

Параметры

массив $row

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

строка $nestKey

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

логическое значение $joined

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

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

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

Возвращает

массив

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

массив $fields

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

смешанное $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::updateAll()

_camelize()source protected

_camelize( string $name )

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

Параметры

строка $name

имя

Возвращает

строка
Пришлизованное имя

_entityName()source protected

_entityName( string $name )

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

Параметры

строка $name

Имя

Возвращает

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

_fixtureName()source protected

_fixtureName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_modelKey()source protected

_modelKey( string $name )

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

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

Параметры

строка $name

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

Возвращает

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

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

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

_pluginNamespace()source protected

_pluginNamespace( string $pluginName )

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

Параметры

строка $pluginName

Имя плагина

Возвращает

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

_pluginPath()source protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

строка
Путь к плагину.

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_singularName()source protected

_singularName( string $name )

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

Параметры

строка $name

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

Возвращает

строка
Имя переменной

_variableName()source protected

_variableName( string $name )

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

Параметры

строка $name

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

Возвращает

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

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

true

'INNER'

'_joinData'

self::SAVE_REPLACE

self::STRATEGY_SELECT

[
    self::STRATEGY_SELECT,
    self::STRATEGY_SUBQUERY
]