Класс 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, например, ArticlesTags belongsTo Tags
• junction belongsTo target, например, 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 )

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

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

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

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

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

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

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

Параметры

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

Имя экземпляра Table или сам экземпляр

Возвращает

$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 optional 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 optional []

Список параметров, которые будут переданы в внутренний вызов 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 optional []

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

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

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

Возвращает полученные параметры из findera $type.

Примеры:

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

Параметры

string|array $finderData

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

Возвращает

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 optional []

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

Возвращает

string

_propertyName()source protected

_propertyName( )

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

Возвращает

string

bindingKey()source public deprecated

bindingKey( string|null $key = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

string|array

cascadeCallbacks()source public deprecated

cascadeCallbacks( boolean|null $cascadeCallbacks = null )

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

Устарело

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

Параметры

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

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

Возвращает

boolean

className()source public deprecated

className( )

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

Устарело

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

Возвращает

string

conditions()source public deprecated

conditions( array|null $conditions = null )

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

Устарело

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

Параметры

array|null $conditions необязательный 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 необязательный 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 необязательный null

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

Возвращает

string|array

foreignKey()source public deprecated

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

getClassName()source public

getClassName( )

Возвращает имя класса объекта целевой таблицы.

Возвращает

string

getConditions()source public

getConditions( )

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

Возвращает

array|callable

См. также

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

getDependent()source public

getDependent( )

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

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

Возвращает

boolean

getFinder()source public

getFinder( )

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

Возвращает

string|array

getJoinType()source public

getJoinType( )

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

Возвращает

string

getName()source public

getName( )

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

Возвращает

string

getProperty()source public

getProperty( )

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

Возвращает

string

getSource()source public

getSource( )

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

Возвращает

Cake\ORM\Table

getStrategy()source public

getStrategy( )

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

Возвращает

string

getTarget()source public

getTarget( )

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

Возвращает

Cake\ORM\Table

joinType()source public deprecated

joinType( string|null $type = null )

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

Устарело

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

Параметры

string|null $type optional null

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

Возвращает

string

name()source public deprecated

name( string|null $name = null )

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

Устарело

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

Параметры

string|null $name optional null

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

Возвращает

string

property()source public deprecated

property( string|null $name = null )

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

Устарело

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

Параметры

string|null $name optional null

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

Возвращает

string

requiresKeys()source public

requiresKeys( array $options = [] )

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

Параметры

array $options optional []

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

Возвращает

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

setBindingKey()source public

setBindingKey( string|array $key )

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

Параметры

string|array $key

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

Возвращает

$this

setCascadeCallbacks()source public

setCascadeCallbacks( boolean $cascadeCallbacks )

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

Параметры

boolean $cascadeCallbacks

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

Возвращает

$this

setClassName()source public

setClassName( string $className )

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

Параметры

string $className

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

Возвращает

$this

Исключения

InvalidArgumentException

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

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
]