Класс HasOne

_buildResultMap()source protected

_buildResultMap( $fetchQuery , $options )

_linkField()source protected

_linkField( $options )

_propertyName()source protected

_propertyName( )

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

Возвращает

строка

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

Cake\ORM\Association::_propertyName()

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

имя свойства

Возвращает

логическое значение
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 )

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

Возвращает выведенные параметры из нахождения $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

_joinCondition()source protected

_joinCondition( array $options )

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

Параметры

массив $options

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

Возвращает

массив

Выбрасывает

RuntimeException

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

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

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

Возвращает

булево

cascadeCallbacks()source public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Параметры

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

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

Возвращает

булево

cascadeDelete()source abstract public

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

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

массив $options optional []

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

Возвращает

булево
Успех

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().

Возвращает

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public

dependent( boolean|null $dependent null )

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

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

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

Параметры

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

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

Возвращает

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

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

eagerLoader( array $options )

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

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

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

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

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

Параметры

массив $options

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

Возвращает

Замыкание

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 )

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

Параметры

массив $row

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

строка $nestKey

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

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

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

Возвращает

массив

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

массив $fields

Хэш полей и новых значений.

смешанное $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::updateAll()

cascadeDelete()source public

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

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

boolean
Успех.

_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 необязательно []

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

Возвращает

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

_camelize()source protected

_camelize( string $name )

Создает camelized версию $name

Параметры

строка $name

имя

Возвращает

строка
Camelized имя

_entityName()source protected

_entityName( string $name )

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

Параметры

строка $name

Имя

Возвращает

строка
Camelized и множественное имя модели

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