Класс 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\Datasource\QueryInterface $query , array $options )

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

Параметры

Cake\Datasource\QueryInterface $query

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

массив $options

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

_bindNewAssociations()source protected

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

Применяет все присоединяемые ассоциации к $query из содержаний, найденных в $surrogate запросе.

Копирует все содержащиеся ассоциации из $surrogate запроса в переданный $query запрос. Содержимое изменяется так, чтобы оно соответствовало цепочке ассоциаций, из которой они произошли.

Параметры

Cake\ORM\Query $query

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

Cake\ORM\Query $surrogate

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

массив $options

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

_dispatchBeforeFind()source protected

_dispatchBeforeFind( Cake\ORM\Query $query )

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

Параметры

Cake\ORM\Query $query

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

_extractFinder()source protected

_extractFinder( string|array $finderData )

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

Возвращает определенные параметры из поиска $type.

Примеры:

Следующее вызовет поиск 'translations' со значением поиска в качестве его параметров: $query->contain(['Comments' => ['finder' => ['translations']]]); $query->contain(['Comments' => ['finder' => ['translations' => []]]]); $query->contain(['Comments' => ['finder' => ['translations' => ['locales' => ['en_US']]]]]);

Параметры

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

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

Возвращает

массив

_formatAssociationResults()source protected

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

Добавляет функцию форматирования в переданный $query запрос, если $surrogate запрос объявляет любой другой форматировщик. Поскольку $surrogate запрос соответствует ассоциированной целевой таблице, результирующий форматировщик будет результатом применения форматировщиков-заместителей только к свойству, соответствующему данной таблице.

Параметры

Cake\ORM\Query $query

запрос, которому будет применено форматирование

Cake\ORM\Query $surrogate

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

массив $options

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

_joinCondition()source protected

_joinCondition( array $options )

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

Параметры

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

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

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

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

Возвращает

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

См. также

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

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

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

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

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

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

Параметры

массив $options

Опции для ленивой загрузки.

Возвращает

Closure

exists()source public

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

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

Параметры

массив|вызываемая функция|Cake\Database\ExpressionInterface $conditions

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

Возвращает

boolean

См. также

\Cake\ORM\Table::exists()

find()source public

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

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

Параметры

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

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

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

Опции для поиска

Возвращает

Cake\ORM\Query

См. также

\Cake\ORM\Table::find()

finder()source public

finder( string|null $finder null )

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

Параметры

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

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

Возвращает

строка

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

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

Параметры

array $row

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

string $nestKey

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

boolean $joined

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

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

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

Возвращает

array

type()source abstract 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 )

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

Параметры

string $name

имя

Возвращает

string
Camelized имя

_entityName()source protected

_entityName( string $name )

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

Параметры

string $name

Имя

Возвращает

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

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

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

Параметры

строка $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

false

[]

false

'all'

'LEFT'

self::STRATEGY_JOIN

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