Класс BelongsToMany

_appendJunctionJoin()source protected

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

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

Параметры

Cake\ORM\Query $query

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

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

Условие запроса для использования.

Возвращает

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

_appendNotMatching()source protected

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

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

Параметры

Cake\Datasource\QueryInterface $query

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

массив $options

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

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

Cake\ORM\Association::_appendNotMatching()

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

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

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

• соединение belongsTo источник, например, ArticlesTags belongsTo Tags
• соединение belongsTo целевой, например, 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 )

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

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

• источник hasMany соединение, например, 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 )

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

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

• цель hasMany соединение, например, Articles hasMany ArticlesTags
• цель belongsToMany источник, например, 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

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

Возвращает

строка

_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

Параметры "ленивой загрузки".

Возвращает

Closure

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

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

Возвращает

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->getAssociation('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->getAssociation('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

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

boolean|Cake\Datasource\EntityInterface

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

Исключения

InvalidArgumentException

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

См. также

\Cake\ORM\Table::save()
\Cake\ORM\Association\BelongsToMany::replaceLinks()

saveStrategy()source public deprecated

saveStrategy( string|null $strategy = null )

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

Устарело

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

Параметры

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

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

Возвращает

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

Исключения

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

setConditions()source public

setConditions( array|callable $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 deprecated

sort( mixed $sort = null )

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

Устарело

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

Параметры

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

запрос сортировки find()

Возвращает

смешанный

targetConditions()source protected

targetConditions( )

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

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

Возвращает

смешанный

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

targetForeignKey()source public deprecated

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->getAssociation('tags')->unlink($article, $tags);

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

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

array $targetEntities

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

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

Список параметров, передаваемых в внутренний вызов delete, или boolean в качестве сокращения для ключа cleanProperty.

Возвращает

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 )

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

Параметры

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 deprecated

bindingKey( string|null $key = null )

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

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

Устаревшее

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

Параметры

string|null $key optional null

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

Возвращает

string|array

cascadeCallbacks()source public deprecated

cascadeCallbacks( boolean|null $cascadeCallbacks = null )

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

Устаревшее

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

Параметры

boolean|null $cascadeCallbacks optional null

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

Возвращает

boolean

className()source public deprecated

className( )

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

Устаревшее

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

Возвращает

string

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

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 необязательно null

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

Возвращает

string

name()source public deprecated

name( string|null $name = null )

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

Устаревшее

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

Параметры

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

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

Возвращает

string

property()source public deprecated

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

setClassName()source public

setClassName( string $className )

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

Параметры

string $className

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

Возвращает

$this

Исключение

InvalidArgumentException

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

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 )

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

Устаревшее

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

Параметры

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

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

Возвращает

Cake\ORM\Table

strategy()source public deprecated

strategy( string|null $name = null )

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

Устаревшее

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

Параметры

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

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

Возвращает

string

Исключения

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

target()source public deprecated

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 )

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

Параметры

array $row

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

string $nestKey

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

boolean $joined

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

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

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

Возвращает

array

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

array $fields

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

mixed $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::updateAll()

_camelize()source protected

_camelize( string $name )

Создаёт камелизованную версию $name

Параметры

string $name

имя

Возвращает

string
Камелизованное имя

_entityName()source protected

_entityName( string $name )

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

Параметры

string $name

Имя

Возвращает

string
Камелизованное и множественное имя модели

_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
Множественное имя для представлений

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 deprecated

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

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

Устаревший

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

Параметры

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

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

true

Cake\ORM\Association\QueryInterface::JOIN_TYPE_INNER

'_joinData'

self::SAVE_REPLACE

self::STRATEGY_SELECT

[
    self::STRATEGY_SELECT,
    self::STRATEGY_SUBQUERY
]