Класс HasOne

_buildResultMapисточник защищённый

_buildResultMap( mixed $fetchQuery , mixed $options )

_linkFieldисточник защищённый

_linkField( mixed $options )

foreignKeyисточник общедоступный

foreignKey( string|null $key null )

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

Параметры

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

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

Возвращает

string
string

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

Cake\ORM\Association::foreignKey()

isOwningSideисточник общедоступный

isOwningSide( Cake\ORM\Table $side )

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

Параметры

Cake\ORM\Table $side

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

Возвращает

boolean
bool

propertyисточник общедоступный

property( string|null $name null )

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

Параметры

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

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

Возвращает

string
string

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

Cake\ORM\Association::property()

saveAssociatedsource public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

сущность из исходной таблицы

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

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

Возвращает

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

См. также

Table::save()

typesource public

type( )

Получение типа связи.

Возвращает

string
строка

__callsource public

__call( string $method , array $argument )

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

Параметры

строка $method

имя метода, который нужно вызвать

массив $argument

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

Возвращает

mixed
смешанное значение

Исключения

BadMethodCallException
\BadMethodCallException

__constructsource public

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

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

Параметры

строка $alias

Имя, данное ассоциации

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

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

__getsource public

__get( string $property )

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

Параметры

строка $property

имя свойства

Возвращает

Cake\ORM\Association
\Cake\ORM\Association

Исключения

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

__issetsource public

__isset( string $property )

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

Параметры

строка $property

имя свойства

Возвращает

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

_appendFieldssource protected

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

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

Параметры

Cake\ORM\Query $query

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

Cake\ORM\Query $surrogate

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

массив $options

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

_appendNotMatchingsource 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']]]]]);

Параметры

string|array $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

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

array $options

параметры, передаваемые методу attachTo

_joinConditionsource protected

_joinCondition( array $options )

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

Параметры

array $options

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

Возвращает

array
массив

Исключения

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

_optionssource protected

_options( array $options )

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

Параметры

array $options

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

attachTosource 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

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

array $options optional []

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

Исключения

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

bindingKeysource public

bindingKey( string|null $key null )

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

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

Параметры

string|null $key optional null

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

Возвращает

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

canBeJoinedsource public

canBeJoined( array $options [] )

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

Параметры

array $options optional []

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

Возвращает

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

cascadeCallbackssource public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Параметры

boolean|null $cascadeCallbacks optional null

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

Возвращает

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

cascadeDeletesource abstract public

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

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

array $options optional []

параметры первоначального удаления.

Возвращает

boolean
Успех

conditionssource public

conditions( array|null $conditions null )

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

Параметры

array|null $conditions optional null

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

Возвращает

array
массив

См. также

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

defaultRowValuesource public

defaultRowValue( array $row , boolean $joined )

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

Параметры

array $row

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

boolean $joined

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

Возвращает

array
массив

deleteAllsource public

deleteAll( mixed $conditions )

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

Параметры

mixed $conditions

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

Возвращает

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

См. также

Cake\ORM\Table::deleteAll()

dependentsource public

dependent( boolean|null $dependent null )

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

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

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

Параметры

boolean|null $dependent optional null

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

Возвращает

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

eagerLoadersource abstract public

eagerLoader( array $options )

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

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

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

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

• query: Объект Query, настроенный для поиска записей исходной таблицы
• keys: Список значений первичных ключей из исходной таблицы
• foreignKey: Название поля, используемого для связи обеих таблиц
• conditions: Список условий, которые должны быть переданы методу where() запроса
• 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()

cascadeDeletesource public

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

Каскадное удаление для удаления зависимых записей.

Этот метод ничего не делает, если связь не зависит.

Параметры

Cake\Datasource\EntityInterface $entity

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

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

Параметры для исходного удаления.

Возвращает

boolean
Успех.

_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 с использованием camelCase

Параметры

строка $name

имя

Возвращает

string
Имя с использованием camelCase

_entityNamesource protected

_entityName( string $name )

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

Параметры

строка $name

Имя

Возвращает

string
Имя модели в camelCase и единственном числе

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

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

Параметры

string $name

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

Возвращает

string
Множественное число человекочитаемого имени

_singularHumanNamesource protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

string
Единственное число человекочитаемого имени

_singularNamesource protected

_singularName( string $name )

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

Параметры

string $name

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

Возвращает

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

_variableNamesource protected

_variableName( string $name )

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

Параметры

string $name

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

Возвращает

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

tableLocatorsource public

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

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator optional 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