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

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

Параметры

массив $options

Опции для "eager" загрузки.

Возвращает

Закрытие

getForeignKey()source public

getForeignKey( )

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

Возвращает

строка

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

Cake\ORM\Association::getForeignKey()

getSaveStrategy()source public

getSaveStrategy( )

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

Возвращает

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

getSort()source public

getSort( )

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

Возвращает

смешанное

isOwningSide()source public

isOwningSide( Cake\ORM\Table $side )

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

Параметры

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

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

Параметры

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 )

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

Параметры

массив $options

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

Возвращает

массив

Исключения

RuntimeException

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

_propertyName()source protected

_propertyName( )

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

Возвращает

строка

attachTo()source public

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

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

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

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

Параметры

Cake\ORM\Query $query

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

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

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

Исключения

RuntimeException

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

bindingKey()source public

bindingKey( string|null $key null )

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

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

Устаревшее

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

Параметры

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

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

Возвращает

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

cascadeCallbacks()source public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Устаревшее

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

Параметры

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

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

Возвращает

булево

className()source public

className( )

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

Возвращает

строка

conditions()source public

conditions( array|null $conditions null )

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

Устаревшее

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

Параметры

array|null $conditions optional null

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

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

array

См. также

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

deleteAll()source public

deleteAll( mixed $conditions )

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

Параметры

mixed $conditions

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

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

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public

dependent( boolean|null $dependent null )

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

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

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

Устаревшее

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

Параметры

boolean|null $dependent 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

finder( string|null $finder null )

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

Устаревшее

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

Параметры

string|null $finder optional null

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

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

string

foreignKey()source public

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

getJoinType()source public

getJoinType( )

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

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

string

getName()source public

getName( )

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

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

string

getProperty()source public

getProperty( )

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

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

string

getSource()source public

getSource( )

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

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

Cake\ORM\Table

getStrategy()source public

getStrategy( )

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

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

string

getTarget()source public

getTarget( )

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

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

Cake\ORM\Table

joinType()source public

joinType( string|null $type null )

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

Устаревшее

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

Параметры

string|null $type optional null

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

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

string

name()source public

name( string|null $name null )

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

Устарело

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

Параметры

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

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

Возвращает

string

property()source public

property( string|null $name null )

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

Устарело

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

Параметры

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

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

Возвращает

string

requiresKeys()source public

requiresKeys( array $options [] )

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

Параметры

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

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

Возвращает

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

setBindingKey()source public

setBindingKey( string|array $key )

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

Параметры

string|array $key

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

Возвращает

$this

setCascadeCallbacks()source public

setCascadeCallbacks( boolean $cascadeCallbacks )

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

Параметры

boolean $cascadeCallbacks

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

Возвращает

$this

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 $finder )

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

Параметры

string $finder

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

Возвращает

$this

setForeignKey()source public

setForeignKey( string|array $key )

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

Параметры

string|array $key

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

Возвращает

$this

setJoinType()source public

setJoinType( string $type )

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

Параметры

string $type

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

Возвращает

$this

setName()source public

setName( string $name )

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

Параметры

string $name

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

Возвращает

$this

setProperty()source public

setProperty( string $name )

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

Параметры

string $name

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

Возвращает

$this

setSource()source public

setSource( Cake\ORM\Table $table )

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

Параметры

Cake\ORM\Table $table

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

Возвращает

$this

setStrategy()source public

setStrategy( string $name )

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

Параметры

string $name

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

Возвращает

$this

Исключения

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

setTarget()source public

setTarget( Cake\ORM\Table $table )

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

Параметры

Cake\ORM\Table $table

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

Возвращает

$this

source()source public

source( Cake\ORM\Table $table null )

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

Устарело

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

Параметры

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

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

Возвращает

Cake\ORM\Table

strategy()source public

strategy( string|null $name null )

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

Устарело

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

Параметры

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

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

Возвращает

string

Исключения

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

target()source public

target( Cake\ORM\Table $table null )

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

Устаревшее

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

Параметры

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

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

Возвращает

Cake\ORM\Table

transformRow()source public

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

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

Параметры

массив $row

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

строка $nestKey

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

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

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

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

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

Возвращает

массив

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

массив $fields

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

смешанное $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::updateAll()

_camelize()source protected

_camelize( string $name )

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

Параметры

строка $name

имя

Возвращает

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

_entityName()source protected

_entityName( string $name )

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

Параметры

строка $name

Имя

Возвращает

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

_fixtureName()source protected

_fixtureName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_modelKey()source protected

_modelKey( string $name )

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

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

Параметры

строка $name

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

Возвращает

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

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

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

_pluginNamespace()source protected

_pluginNamespace( string $pluginName )

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

Параметры

строка $pluginName

Имя плагина

Возвращает

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

_pluginPath()source protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

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

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_singularName()source protected

_singularName( string $name )

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

Параметры

строка $name

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

Возвращает

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

_variableName()source protected

_variableName( string $name )

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

Параметры

строка $name

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

Возвращает

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

getTableLocator()source public

getTableLocator( )

Возвращает локатор таблиц.

Возвращает

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

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

Устанавливает локатор таблиц.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Возвращает

$this

tableLocator()source public

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

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

Устаревшее

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

Параметры

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

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

Cake\ORM\Association\QueryInterface::JOIN_TYPE_INNER

self::SAVE_APPEND

self::STRATEGY_SELECT

[
    self::STRATEGY_SELECT,
    self::STRATEGY_SUBQUERY
]