Класс 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, если $entity не удалось сохранить; в противном случае возвращает сохранённую сущность

См. также

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

Вспомогательная функция, используемая для условного добавления полей к клаузу 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

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

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

Выбрасывает

RuntimeException

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

bindingKey()source public

bindingKey( string|null $key null )

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

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

Параметры

строка|null $key optional null

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

Возвращает

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

canBeJoined()source public

canBeJoined( array $options [] )

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

Параметры

массив $options optional []

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

Возвращает

boolean

cascadeCallbacks()source public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Параметры

boolean|null $cascadeCallbacks optional null

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

Возвращает

boolean

className()source public

className( )

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

Возвращает

строка

conditions()source public

conditions( array|null $conditions null )

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

Параметры

массив|null $conditions optional null

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

Возвращает

массив

См.

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

defaultRowValue()source public

defaultRowValue( array $row , boolean $joined )

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

Параметры

массив $row

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

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

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

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

массив

deleteAll()source public

deleteAll( mixed $conditions )

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

Параметры

смешанное $conditions

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

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

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public

dependent( boolean|null $dependent null )

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

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

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

Параметры

логическое значение|null $dependent необязательно null

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

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

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

eagerLoader()source абстрактный public

eagerLoader( array $options )

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

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

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

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

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

Параметры

массив $options

Параметры для жадной загрузки.

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

Лямбда-функция

exists()source public

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

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

Параметры

массив|вызываемый объект|Cake\Database\ExpressionInterface $conditions

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

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

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

См. также

\Cake\ORM\Table::exists()

find()source public

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

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

Параметры

строка|массив|null $type необязательно null

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

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

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

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

Cake\ORM\Query

См. также

\Cake\ORM\Table::find()

finder()source public

finder( string|null $finder null )

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

Параметры

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

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

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

строка

joinType()source public

joinType( string|null $type null )

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

Параметры

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

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

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

строка

name()source public

name( string|null $name null )

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

Параметры

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

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

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

строка

property()source public

property( string|null $name null )

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

Параметры

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

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

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

строка

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 )

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

Параметры

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

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

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

строка

Исключения

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 , string $targetProperty null )

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

Параметры

массив $row

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

строка $nestKey

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

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

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

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

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

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

массив

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

_assertFieldsPresent()source protected

_assertFieldsPresent( Cake\ORM\Query $fetchQuery , array $key )

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

Параметры

Cake\ORM\Query $fetchQuery

Запрос выборки связи

массив $key

Поля внешнего ключа для проверки

Выбрасывает

InvalidArgumentException

_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, если процесс eager loading потребует набор ключей привязки таблицы владельца, чтобы использовать их в качестве фильтра в запросе нахождения.

Параметры

массив $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]