Класс Association

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

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

_propertyName()source protected

_propertyName( )

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

Возвращает

строка

attachTo()source public

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

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

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

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

Параметры

Cake\ORM\Query $query

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

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

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

Исключения

RuntimeException

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

bindingKey()source public

bindingKey( string|null $key null )

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

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

Параметры

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

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

Возвращает

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

canBeJoined()source public

canBeJoined( array $options [] )

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

Параметры

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

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

Возвращает

boolean

cascadeCallbacks()source public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Параметры

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

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

Возвращает

boolean

cascadeDelete()source abstract public

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

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

boolean
Успех

className()source public

className( )

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

Возвращает

string

conditions()source public

conditions( array|null $conditions null )

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

Параметры

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

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

Возвращает

массив

См. также

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

defaultRowValue()source public

defaultRowValue( array $row , boolean $joined )

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

Параметры

массив $row

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

boolean $joined

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

Возвращает

массив

deleteAll()source public

deleteAll( mixed $conditions )

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

Параметры

смешанный $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public

dependent( boolean|null $dependent null )

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

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

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

Параметры

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

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

Возвращает

boolean

eagerLoader()source abstract public

eagerLoader( array $options )

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

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

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

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

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

Параметры

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

имя используемого поиска

Возвращает

строка

foreignKey()source public

foreignKey( string|null $key null )

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

Параметры

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

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

Возвращает

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

isOwningSide()source abstract public

isOwningSide( Cake\ORM\Table $side )

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

Параметры

Cake\ORM\Table $side

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

Возвращает

boolean

joinType()source public

joinType( string|null $type null )

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

Параметры

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

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

Возвращает

строка

name()source public

name( string|null $name null )

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

Параметры

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

Присваиваемое имя

Возвращает

string

property()source public

property( string|null $name null )

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

Параметры

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

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

Возвращает

string

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

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

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

Параметры

Cake\Datasource\EntityInterface $entity

данные для сохранения

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

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

Возвращает

boolean|Cake\Datasource\EntityInterface

false, если $entity не удалось сохранить, иначе возвращает сохранённый объект

См. также

\Cake\ORM\Table::save()

source()source public

source( Cake\ORM\Table $table null )

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

Параметры

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

экземпляр для назначения как источника

Возвращает

Cake\ORM\Table

strategy()source public

strategy( string|null $name null )

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

Параметры

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

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

Возвращает

string

Исключения

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

target()source public

target( Cake\ORM\Table $table null )

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

Параметры

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

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

Возвращает

Cake\ORM\Table

transformRow()source public

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

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

Параметры

array $row

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

string $nestKey

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

boolean $joined

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

Возвращает

array

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

type( )

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

Возвращает

string
Константа одного из ONE_TO_ONE, MANY_TO_ONE, ONE_TO_MANY или MANY_TO_MANY.

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

array $fields

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

mixed $conditions

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

Возвращает

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

См. также

\Cake\ORM\Table::updateAll()

_camelize()source protected

_camelize( string $name )

Создаёт версию $name с использованием camelize

Параметры

string $name

имя

Возвращает

string
Именованное имя

_entityName()source protected

_entityName( string $name )

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

Параметры

string $name

Имя

Возвращает

string
Именованное и множественное имя модели

_fixtureName()source protected

_fixtureName( string $name )

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

Параметры

string $name

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

Возвращает

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

_modelKey()source protected

_modelKey( string $name )

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

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

Параметры

string $name

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

Возвращает

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

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

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

Параметры

string $key

Внешний ключ

Возвращает

string
Имя модели

_pluginNamespace()source protected

_pluginNamespace( string $pluginName )

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

Параметры

string $pluginName

Имя плагина

Возвращает

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

_pluginPath()source protected

_pluginPath( string $pluginName )

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

Параметры

string $pluginName

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

Возвращает

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

_pluralHumanName()source protected

_pluralHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularHumanName()source protected

_singularHumanName( string $name )

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

Параметры

string $name

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

Возвращает

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

_singularName()source protected

_singularName( string $name )

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

Параметры

string $name

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

Возвращает

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

_variableName()source protected

_variableName( string $name )

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

Параметры

string $name

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

Возвращает

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

tableLocator()source public

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

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator optional null

Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

false

[]

false

'all'

'LEFT'

self::STRATEGY_JOIN

[self::STRATEGY_JOIN, self::STRATEGY_SELECT, self::STRATEGY_SUBQUERY]