Класс BelongsTo

_buildResultMap()source protected

_buildResultMap( $fetchQuery , $options )

_joinCondition()source protected

_joinCondition( array $options )

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

Параметры

массив $options

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

Возвращает

массив

Исключения

RuntimeException

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

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

Cake\ORM\Association::_joinCondition()

_linkField()source protected

_linkField( $options )

_propertyName()source protected

_propertyName( )

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

Возвращает

строка

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

Cake\ORM\Association::_propertyName()

cascadeDelete()source public

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

Обработка каскадного удаления.

Ассоциации BelongsTo никогда не очищаются в сценарии каскадного удаления.

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

булево
Успешно.

foreignKey()source public

foreignKey( string|null $key null )

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

Параметры

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

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

Возвращает

строка

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

Cake\ORM\Association::foreignKey()

isOwningSide()source public

isOwningSide( Cake\ORM\Table $side )

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

Параметры

Cake\ORM\Table $side

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

Возвращает

булево

saveAssociated()source public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

булево|Cake\Datasource\EntityInterface

false, если сущность не может быть сохранена, в противном случае возвращает сохранённую сущность

См. также

\Cake\ORM\Table::save()

type()source public

type( )

Получить тип отношения.

Возвращает

строка

__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\Database\Query $query , array $options )

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

Параметры

Cake\Database\Query $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 )

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

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

Примеры:

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

Параметры

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

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

Возвращает

массив

_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

_options()source protected

_options( array $options )

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

Параметры

массив $options

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

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

bindingKey( string|null $key null )

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

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

Параметры

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

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

Возвращает

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

canBeJoined()source public

canBeJoined( array $options [] )

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

Параметры

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

необязательные параметры, которые могут повлиять на результат.

Возвращает

boolean

cascadeCallbacks()source public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Параметры

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

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

Возвращает

boolean

className()source public

className( )

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

Возвращает

строка

conditions()source public

conditions( array|null $conditions null )

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

Параметры

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

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

Возвращает

array

См. также

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

defaultRowValue()source public

defaultRowValue( array $row , boolean $joined )

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

Параметры

array $row

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

boolean $joined

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

Возвращает

array

deleteAll()source public

deleteAll( mixed $conditions )

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

Параметры

mixed $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public

dependent( boolean|null $dependent null )

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

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

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

Параметры

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

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

Возвращает

boolean

eagerLoader()source abstract public

eagerLoader( array $options )

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

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

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

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

• query: Объект Query, настроенный для поиска записей исходной таблицы
• keys: Список значений первичного ключа из исходной таблицы
• foreignKey: Имя поля, используемого для связи обеих таблиц
• conditions: Список условий, которые будут переданы методу where() запроса
• sort: Направление, в котором должны возвращаться записи
• fields: Список полей для выбора из целевой таблицы
• contain: Список связанных таблиц, которые следует жадно загрузить, связанных с целевой таблицей
• strategy: Имя стратегии, которую следует использовать для поиска записей целевой таблицы
• nestKey: Ключ массива, под которым будут найдены результаты при преобразовании строки

Параметры

array $options

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

Возвращает

Closure

find()source public

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

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

Параметры

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

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

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

Опции для поиска

Возвращает

Cake\ORM\Query

См. также

\Cake\ORM\Table::find()

finder()source public

finder( string|null $finder null )

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

Параметры

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

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

Возвращает

string

joinType()source public

joinType( string|null $type null )

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

Параметры

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

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

Возвращает

string

name()source public

name( string|null $name null )

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

Параметры

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

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

Возвращает

string

property()source public

property( string|null $name null )

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

Параметры

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

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

Возвращает

string

source()source public

source( Cake\ORM\Table $table null )

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

Параметры

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

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

Возвращает

Cake\ORM\Table

strategy()source public

strategy( string|null $name null )

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

Параметры

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

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

Возвращает

string

Выбрасывает

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

target()source public

target( Cake\ORM\Table $table null )

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

Параметры

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

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

Возвращает

Cake\ORM\Table

transformRow()source public

transformRow( array $row , string $nestKey , boolean $joined )

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

Параметры

массив $row

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

строка $nestKey

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

булево $joined

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

Возвращает

массив

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

массив $fields

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

смешанный $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::updateAll()

_addFilteringCondition()source protected

_addFilteringCondition( Cake\ORM\Query $query , string|array $key , mixed $filter )

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

Параметры

Cake\ORM\Query $query

Запрос целевой таблицы

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

Поля, которые должны использоваться для фильтрации

смешанный $filter

Значение, которое должно использоваться для соответствия $key

Возвращает

Cake\ORM\Query

_addFilteringJoin()source public

_addFilteringJoin( Cake\ORM\Query $query , string $key , Cake\ORM\Query $subquery )

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

Параметры

Cake\ORM\Query $query

Запрос целевой таблицы

строка $key

Поля, которые должны использоваться для фильтрации

Cake\ORM\Query $subquery

Подзапрос, используемый для фильтрации

Возвращает

Cake\ORM\Query

_buildQuery()source protected

_buildQuery( array $options )

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

Параметры

массив $options

параметры, принимаемые eagerLoader()

Возвращает

Cake\ORM\Query

Исключения

InvalidArgumentException
Когда ключ необходим для связей, но не выбран.

_buildSubquery()source protected

_buildSubquery( Cake\ORM\Query $query )

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

Параметры

Cake\ORM\Query $query

исходный запрос, используемый для загрузки исходных записей

Возвращает

Cake\ORM\Query

_createTupleCondition()source protected

_createTupleCondition( Cake\ORM\Query $query , array $keys , mixed $filter , string $operator )

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

Параметры

Cake\ORM\Query $query

Запрос целевой таблицы

массив $keys

Поля, которые должны использоваться для фильтрации

смешанный $filter

Значение, которое должно использоваться для сопоставления для $key

строка $operator

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

Возвращает

Cake\Database\Expression\TupleComparison

_defaultOptions()source protected

_defaultOptions( )

Возвращает значения по умолчанию для использования в eagerLoader

Возвращает

массив

_multiKeysInjector()source protected

_multiKeysInjector( array $resultMap , array $sourceKeys , string $nestKey )

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

Параметры

массив $resultMap

Массивы с ключами, содержащие целевую таблицу

массив $sourceKeys

Массив с алиасами ключей для соответствия

строка $nestKey

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

Возвращает

Closure

_resultInjector()source protected

_resultInjector( Cake\ORM\Query $fetchQuery , array $resultMap , array $options )

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

Параметры

Cake\ORM\Query $fetchQuery

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

массив $resultMap

Массив, в котором внешние ключи служат ключами, а соответствующие результаты целевой таблицы — значениями.

массив $options

Параметры, переданные методу eagerLoader

Возвращает

Closure

_subqueryFields()source protected

_subqueryFields( Cake\ORM\Query $query )

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

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

Параметры

Cake\ORM\Query $query

Запрос для получения полей.

Возвращает

массив
Список полей для подзапроса.

eagerLoader()source public

eagerLoader( array $options )

requiresKeys()source public

requiresKeys( array $options [] )

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

Параметры

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

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

Возвращает

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

_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

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

Возвращает

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

tableLocator()source public

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

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

Параметры

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

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

[self::STRATEGY_JOIN, self::STRATEGY_SELECT]