Класс BelongsTo

_buildResultMapисходный код protected

_buildResultMap( mixed $fetchQuery , mixed $options )

_joinConditionисходный код protected

_joinCondition( array $options )

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

Параметры

массив $options

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

Возвращает

array
массив

Исключения

RuntimeException
если количество столбцов в foreignKey не соответствует количеству столбцов в primaryKey целевой таблицы

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

Cake\ORM\Association::_joinCondition()

_linkFieldисходный код protected

_linkField( mixed $options )

cascadeDeleteисходный код public

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

Обработка каскадных удалений.

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

boolean
Успех.

foreignKeyисходный код public

foreignKey( string|null $key null )

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

Параметры

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

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

Возвращает

string
строка

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

Cake\ORM\Association::foreignKey()

isOwningSideисходный код public

isOwningSide( Cake\ORM\Table $side )

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

Параметры

Cake\ORM\Table $side

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

Возвращает

boolean
bool

propertyисходный код public

property( string|null $name null )

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

Параметры

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

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

Возвращает

string
строка

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

Cake\ORM\Association::property()

saveAssociatedисходный код public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

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

См. также

Таблица::save()

typeисходный код public

type( )

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

Возвращает

string
строка

__callисходный код public

__call( string $method , array $argument )

Перенаправляет вызовы методов на целевую таблицу.

Параметры

строка $method

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

массив $argument

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

Возвращает

mixed
смешанный тип

Исключения

BadMethodCallException
\BadMethodCallException

__constructисходный код public

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

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

Параметры

строка $alias

Имя, присвоенное ассоциации

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

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

__getисходный код public

__get( string $property )

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

Параметры

строка $property

имя свойства

Возвращает

Cake\ORM\Association
\Cake\ORM\Association

Исключения

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

__issetисходный код public

__isset( string $property )

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

Параметры

строка $property

имя свойства

Возвращает

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

_appendFieldsисходный код protected

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

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

Параметры

Cake\ORM\Query $query

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

Cake\ORM\Query $surrogate

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

массив $options

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

_appendNotMatchingисходный код protected

_appendNotMatching( Cake\Database\Query $query , array $options )

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

Параметры

Cake\Database\Query $query

запрос для изменения

массив $options

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

_bindNewAssociationssource 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

_dispatchBeforeFindsource protected

_dispatchBeforeFind( Cake\ORM\Query $query )

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

Параметры

Cake\ORM\Query $query

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

_extractFindersource 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

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

Возвращает

array
массив

_formatAssociationResultssource 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

_optionssource protected

_options( array $options )

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

Параметры

массив $options

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

attachTosource public

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

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

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

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

Параметры

Cake\ORM\Query $query

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

массив $options optional []

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

Выбрасывает

RuntimeException
если обработчик запросов не возвращает объект запроса

bindingKeysource public

bindingKey( string|null $key null )

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

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

Параметры

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

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

Возвращает

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

canBeJoinedsource public

canBeJoined( array $options [] )

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

Параметры

массив $options optional []

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

Возвращает

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

cascadeCallbackssource public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Параметры

булево|null $cascadeCallbacks optional null

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

Возвращает

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

conditionssource public

conditions( array|null $conditions null )

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

Параметры

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

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

Возвращает

array
массив

См

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

defaultRowValuesource public

defaultRowValue( array $row , boolean $joined )

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

Параметры

массив $row

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

булево $joined

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

Возвращает

array
массив

deleteAllsource public

deleteAll( mixed $conditions )

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

Параметры

смешанное $conditions

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

Возвращает

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

См

Cake\ORM\Table::deleteAll()

dependentsource public

dependent( boolean|null $dependent null )

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

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

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

Параметры

булево|null $dependent optional null

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

Возвращает

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

eagerLoadersource abstract public

eagerLoader( array $options )

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

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

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

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

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

Параметры

массив $options

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

Возвращает

Closure
\Closure

findsource public

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

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

Параметры

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

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

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

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

Возвращает

Cake\ORM\Query
\Cake\ORM\Query

См. также

Cake\ORM\Table::find()

findersource public

finder( string|null $finder null )

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

Параметры

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

имя финдера для использования

Возвращает

string
строка

joinTypesource public

joinType( string $type null )

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

Параметры

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

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

Возвращает

string
строка

namesource public

name( string|null $name null )

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

Параметры

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

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

Возвращает

string
строка

sourcesource public

source( Cake\ORM\Table $table null )

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

Параметры

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

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

Возвращает

Cake\ORM\Table
\Cake\ORM\Table

strategysource public

strategy( string|null $name null )

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

Параметры

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

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

Возвращает

string
строка

Исключения

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

targetsource public

target( Cake\ORM\Table $table null )

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

Параметры

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

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

Возвращает

Cake\ORM\Table
\Cake\ORM\Table

transformRowsource public

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

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

Параметры

массив $row

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

строка $nestKey

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

булево $joined

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

Возвращает

array
массив

updateAllsource public

updateAll( array $fields , mixed $conditions )

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

Параметры

массив $fields

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

смешанное $conditions

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

Возвращает

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

См. также

Cake\ORM\Table::updateAll()

_addFilteringConditionsource protected

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

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

Параметры

Cake\ORM\Query $query

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

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

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

смешанное $filter

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

Возвращает

Cake\ORM\Query
\Cake\ORM\Query

_addFilteringJoinsource public

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

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

Параметры

Cake\ORM\Query $query

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

строка $key

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

Cake\ORM\Query $subquery

Подзапрос для использования при фильтрации

Возвращает

Cake\ORM\Query
\Cake\ORM\Query

_buildQuerysource protected

_buildQuery( array $options )

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

Параметры

массив $options

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

Возвращает

Cake\ORM\Query
\Cake\ORM\Query

Исключения

InvalidArgumentException
Когда для ассоциаций требуется ключ, но он не выбран.

_buildSubquerysource protected

_buildSubquery( Cake\ORM\Query $query )

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

Параметры

Cake\ORM\Query $query

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

Возвращает

Cake\ORM\Query
\Cake\ORM\Query

_createTupleConditionsource 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
\Cake\Database\Expression\TupleComparison

_defaultOptionssource protected

_defaultOptions( )

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

Возвращает

array
массив

_multiKeysInjectorsource protected

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

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

Параметры

массив $resultMap

Массив со значениями целевой таблицы

массив $sourceKeys

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

строка $nestKey

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

Возвращает

Closure
\Closure

_resultInjectorsource protected

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

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

Параметры

Cake\ORM\Query $fetchQuery

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

массив $resultMap

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

массив $options

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

Возвращает

Closure
\Closure

_subqueryFieldssource protected

_subqueryFields( Cake\ORM\Query $query )

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

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

Параметры

Cake\ORM\Query $query

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

Возвращает

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

eagerLoadersource public

eagerLoader( array $options )

requiresKeyssource public

requiresKeys( array $options [] )

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

Параметры

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

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

Возвращает

boolean
true, если список ключей будет необходим

_camelizesource protected

_camelize( string $name )

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

Параметры

строка $name

имя

Возвращает

string
Пришлизованное имя

_entityNamesource protected

_entityName( string $name )

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

Параметры

строка $name

Имя

Возвращает

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

_fixtureNamesource protected

_fixtureName( string $name )

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

Параметры

строка $name

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

Возвращает

string
Ключ модели в единственном числе

_modelKeysource protected

_modelKey( string $name )

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

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

Параметры

строка $name

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

Возвращает

string
Ключ модели в единственном числе

_modelNameFromKeysource protected

_modelNameFromKey( string $key )

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

Параметры

строка $key

Внешний ключ

Возвращает

string
Имя модели

_pluginNamespacesource protected

_pluginNamespace( string $pluginName )

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

Параметры

строка $pluginName

Имя плагина

Возвращает

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

_pluginPathsource protected

_pluginPath( string $pluginName )

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

Параметры

строка $pluginName

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

Возвращает

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

_pluralHumanNamesource protected

_pluralHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

string
Множественное человекопонятное имя

_singularHumanNamesource protected

_singularHumanName( string $name )

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

Параметры

строка $name

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

Возвращает

string
Единственное человекопонятное имя

_singularNamesource protected

_singularName( string $name )

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

Параметры

строка $name

Используемое имя

Возвращает

string
Имя переменной

_variableNamesource protected

_variableName( string $name )

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

Параметры

строка $name

Используемое имя

Возвращает

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

tableLocatorsource public

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

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

Параметры

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

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface
\Cake\ORM\Locator\LocatorInterface

[self::STRATEGY_JOIN, self::STRATEGY_SELECT]

false

[]

false

'all'

'LEFT'

Cake\ORM\Association::STRATEGY_JOIN