Класс HasMany

_foreignKeyAcceptsNull()source protected

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

Проверяет флаг допустимости значения NULL для внешнего ключа

Параметры

Cake\ORM\Table $table

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

массив $properties

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

Возвращает

boolean

_options()source protected

_options( array $opts )

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

Параметры

массив $opts

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

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

Cake\ORM\Association::_options()

_saveTarget()source protected

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

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

Параметры

массив $foreignKeyReference

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

Cake\Datasource\EntityInterface $parentEntity

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

массив|Перечисляемый объект $entities

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

массив $options

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

Возвращает

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

_unlink()source protected

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

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

Параметры

массив $foreignKey

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

Cake\ORM\Table $target

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

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

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

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

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

Возвращает

boolean
успех

_unlinkAssociated()source protected

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

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

Параметры

массив $foreignKeyReference

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

Cake\Datasource\EntityInterface $entity

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

Cake\ORM\Table $target

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

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

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

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

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

Возвращает

boolean
успех

canBeJoined()source public

canBeJoined( array $options = [] )

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

Параметры

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

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

Возвращает

boolean

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

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

Cake\ORM\Association::canBeJoined()

cascadeDelete()source public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

boolean
Успех

defaultRowValue()source public

defaultRowValue( array $row , boolean $joined )

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

Параметры

массив $row

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

boolean $joined

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

Возвращает

массив

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

Cake\ORM\Association::defaultRowValue()

eagerLoader()source public

eagerLoader( array $options )

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

Параметры

массив $options

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

Возвращает

Closure

getForeignKey()source public

getForeignKey( )

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

Возвращает

строка

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

Cake\ORM\Association::getForeignKey()

getSaveStrategy()source public

getSaveStrategy( )

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

Возвращает

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

getSort()source public

getSort( )

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

Возвращает

смешанное

isOwningSide()source public

isOwningSide( Cake\ORM\Table $side )

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

Параметры

Cake\ORM\Table $side

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

Возвращает

boolean

link()source public

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

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

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

Пример:

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

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

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

массив $targetEntities

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

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

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

Возвращает

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

replace()source public

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

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

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

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

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

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

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

Пример:

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

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

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

массив $targetEntities

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

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

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

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

boolean
успех

Исключения

InvalidArgumentException

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

saveAssociated()source public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

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

boolean|Cake\Datasource\EntityInterface

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

Исключения

InvalidArgumentException
если данные связи не могут быть обработаны.

См. также

\Cake\ORM\Table::save()

saveStrategy()source public устарело

saveStrategy( string|null $strategy = null )

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

Устарело

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

Параметры

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

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

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

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

Исключения

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

setSaveStrategy()source public

setSaveStrategy( string $strategy )

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

Параметры

строка $strategy

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

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

$this

Исключения

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

setSort()source public

setSort( mixed $sort )

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

Параметры

смешанный $sort

Предложение сортировки совместимое с find()

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

$this

sort()source public устарело

sort( mixed $sort = null )

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

Устарело

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

Параметры

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

Предложение сортировки совместимое с find()

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

смешанный

type()source public

type( )

Получить тип связи.

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

строка

unlink()source public

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

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

Параметры

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

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

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

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

Пример:

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

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

Параметры

Cake\Datasource\EntityInterface $sourceEntity

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

массив $targetEntities

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

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

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

Исключения

InvalidArgumentException

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

__call()source public

__call( string $method , array $argument )

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

Параметры

строка $method

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

массив $argument

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

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

смешанный

Исключения

BadMethodCallException

__construct()source public

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

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

Параметры

строка $alias

Имя, заданное для связи

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

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

__get()source public

__get( string $property )

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

Параметры

строка $property

имя свойства

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

Cake\ORM\Association

Исключения

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

__isset()source public

__isset( string $property )

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

Параметры

строка $property

имя свойства

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

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

_appendFields()source protected

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

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

Параметры

Cake\ORM\Query $query

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

Cake\ORM\Query $surrogate

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

массив $options

опции, переданные методу attachTo

_appendNotMatching()source protected

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

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

Параметры

Cake\Datasource\QueryInterface $query

Запрос для модификации

массив $options

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

_bindNewAssociations()source protected

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

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

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

Параметры

Cake\ORM\Query $query

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

Cake\ORM\Query $surrogate

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

массив $options

опции, переданные методу attachTo

_dispatchBeforeFind()source protected

_dispatchBeforeFind( Cake\ORM\Query $query )

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

Параметры

Cake\ORM\Query $query

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

_extractFinder()source protected

_extractFinder( string|array $finderData )

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

Возвращает выведенные опции из поиска $type.

Примеры:

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

Параметры

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

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

Возвращает

массив

_formatAssociationResults()source protected

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

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

Параметры

Cake\ORM\Query $query

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

Cake\ORM\Query $surrogate

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

массив $options

опции, переданные методу attachTo

_getClassName()source protected

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

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

Параметры

строка $alias

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

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

Массив опций таблицы.

Возвращает

строка

_joinCondition()source protected

_joinCondition( array $options )

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

Параметры

массив $options

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

Возвращает

массив

Исключения

RuntimeException

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

_propertyName()source protected

_propertyName( )

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

Возвращает

строка

attachTo()source public

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

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

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

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

Параметры

Cake\ORM\Query $query

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

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

Дополнительные опции или переопределения, которые нужно учитывать

Исключения

RuntimeException

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

bindingKey()source public deprecated

bindingKey( string|null $key = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

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

cascadeCallbacks()source public deprecated

cascadeCallbacks( boolean|null $cascadeCallbacks = null )

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

Устарело

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

Параметры

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

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

Возвращает

boolean

className()source public

className( )

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

Возвращает

строка

conditions()source public deprecated

conditions( array|null $conditions = null )

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

Устаревшее

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

Параметры

array|null $conditions optional null

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

Возвращает

array|callable

См. также

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

deleteAll()source public

deleteAll( mixed $conditions )

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

Параметры

mixed $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public deprecated

dependent( boolean|null $dependent = null )

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

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

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

Устаревшее

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

Параметры

boolean|null $dependent optional null

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

Возвращает

boolean

exists()source public

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

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

Параметры

array|callable|Cake\Database\ExpressionInterface $conditions

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

Возвращает

boolean

См. также

\Cake\ORM\Table::exists()

find()source public

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

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

Параметры

string|array|null $type optional null

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

array $options optional []

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

Возвращает

Cake\ORM\Query

См. также

\Cake\ORM\Table::find()

finder()source public deprecated

finder( string|null $finder = null )

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

Устаревшее

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

Параметры

string|null $finder optional null

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

Возвращает

string|array

foreignKey()source public deprecated

foreignKey( string|null $key = null )

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

Устаревшее

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

Параметры

string|null $key optional null

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

Возвращает

string|array

getBindingKey()source public

getBindingKey( )

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

Возвращает

string|array

getCascadeCallbacks()source public

getCascadeCallbacks( )

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

Возвращает

boolean

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

setConditions()source public

setConditions( array|callable $conditions )

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

Параметры

array|callable $conditions

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

Возвращает

$this

См.

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

setDependent()source public

setDependent( boolean $dependent )

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

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

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

Параметры

boolean $dependent

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

Возвращает

$this

setFinder()source public

setFinder( string|array $finder )

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

Параметры

string|array $finder

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

Возвращает

$this

setForeignKey()source public

setForeignKey( string|array $key )

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

Параметры

string|array $key

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

Возвращает

$this

setJoinType()source public

setJoinType( string $type )

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

Параметры

string $type

используемый тип соединения (например, INNER)

Возвращает

$this

setName()source public

setName( string $name )

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

Параметры

string $name

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

Возвращает

$this

setProperty()source public

setProperty( string $name )

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

Параметры

string $name

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

Возвращает

$this

setSource()source public

setSource( Cake\ORM\Table $table )

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

Параметры

Cake\ORM\Table $table

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

Возвращает

$this

setStrategy()source public

setStrategy( string $name )

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

Параметры

string $name

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

Возвращает

$this

Исключения

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

setTarget()source public

setTarget( Cake\ORM\Table $table )

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

Параметры

Cake\ORM\Table $table

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

Возвращает

$this

source()source public deprecated

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

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

Устарело

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 )

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

Параметры

массив $row

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

строка $nestKey

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

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

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

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

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

Возвращает

массив

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

массив $fields

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

смешанное $conditions

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

Возвращает

целое число
Количество затронутых строк.

См. также

\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 deprecated

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

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

Устаревшее

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

Параметры

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

экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

Cake\ORM\Association\QueryInterface::JOIN_TYPE_INNER

self::SAVE_APPEND

self::STRATEGY_SELECT

[
    self::STRATEGY_SELECT,
    self::STRATEGY_SUBQUERY
]