Spec-Zone.ru › CakePHP 3.8

Класс BelongsTo

Представляет отношение 1 - N, где сторона источника связана только с одной записью в целевой таблице.

Пример ассоциации BelongsTo: Статья принадлежит Автору.

Cake\ORM\Association использует Cake\Core\ConventionsTrait , Cake\ORM\Locator\LocatorAwareTrait
Расширенный Cake\ORM\Association\BelongsTo
Пространство имен: Cake\ORM\Association
Расположение: ORM/Association/BelongsTo.php

Унаследованные константы

  • MANY_TO_MANY, MANY_TO_ONE, ONE_TO_MANY, ONE_TO_ONE, STRATEGY_JOIN, STRATEGY_SELECT, STRATEGY_SUBQUERY

Резюме свойств

  • $_validStrategies protected
    array
    Допустимые стратегии для этого типа ассоциации

Унаследованные свойства

  • _bindingKey, _cascadeCallbacks, _className, _conditions, _dependent, _finder, _foreignKey, _joinType, _name, _propertyName, _sourceTable, _strategy, _targetTable _tableLocator

Резюме методов

  • _joinCondition() protected

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

  • _propertyName() protected
    Возвращает имя свойства по умолчанию, основанное на имени ассоциации.
  • cascadeDelete() public
    Обработка каскадных удалений.
  • eagerLoader() public

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

  • getForeignKey() public
    Возвращает имя поля, представляющего внешний ключ к целевой таблице.
  • isOwningSide() public

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

  • saveAssociated() public

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

  • type() public
    Получение типа отношения.

Подробное описание методов

_joinCondition()source protected

_joinCondition( array $options )

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

Параметры

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

Возвращает

массив

Выбрасывает

RuntimeException

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


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

Cake\ORM\Association::_joinCondition()

_propertyName()source protected

_propertyName( )

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

Возвращает

строка

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

Cake\ORM\Association::_propertyName()

cascadeDelete()source public

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

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

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

Параметры

Cake\Datasource\EntityInterface $entity
Сущность, которая инициировала каскадное удаление.
массив $options необязательно []
Параметры исходного удаления.

Возвращает

булево
Успех.

eagerLoader()source public

eagerLoader( array $options )

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

Параметры

массив $options
Параметры для ленивой загрузки.

Возвращает

Замкнутая функция

getForeignKey()source public

getForeignKey( )

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

Возвращает

строка

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

Cake\ORM\Association::getForeignKey()

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

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

Возвращает

строка

Методы, унаследованные от Cake\ORM\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
если ассоциация с таким именем не существует
END_OF_DOCUMENT_MARKER

__isset()source public

__isset( string $property )

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

Параметры

строка $property
имя свойства

Возвращает

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

_getClassName()source protected

_getClassName( string $alias , array $options = [] )

Получает имя класса таблицы.

Параметры

строка $alias
Имя псевдонима, которое вы хотите получить.
массив $options optional []
Массив опций таблицы.

Возвращает

строка

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

bindingKey( string|null $key = null )

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

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

Устарело

3.4.0 Используйте setBindingKey()/getBindingKey() вместо этого.

Параметры

строка|null $key optional null
поле таблицы, которое будет использоваться для связи обеих таблиц

Возвращает

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

canBeJoined()source public

canBeJoined( array $options = [] )

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

Параметры

массив $options optional []
пользовательский ключ опций, который может изменить возвращаемое значение

Возвращает

boolean

cascadeCallbacks()source public deprecated

cascadeCallbacks( boolean|null $cascadeCallbacks = null )

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

Устарело

3.4.0 Используйте setCascadeCallbacks()/getCascadeCallbacks() вместо этого.

Параметры

boolean|null $cascadeCallbacks optional null
значение переключателя каскадных вызовов

Возвращает

boolean

className()source public deprecated

className( )

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

Устарело

3.7.0 Используйте getClassName() вместо этого.

Возвращает

строка
END_OF_DOCUMENT_MARKER

conditions()source public deprecated

conditions( array|null $conditions = null )

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

Устарело

3.4.0 Используйте вместо этого setConditions()/getConditions().

Параметры

массив|null $conditions необязательно 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().

Возвращает

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

См. также

\Cake\ORM\Table::deleteAll()

dependent()source public deprecated

dependent( boolean|null $dependent = null )

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

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

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

Устарело

3.4.0 Используйте вместо этого setDependent()/getDependent().

Параметры

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

Возвращает

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

exists()source public

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

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

Параметры

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

Условия для проверки соответствия записям.

Возвращает

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

См. также

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

finder( string|null $finder = null )

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

Устарело

3.4.0 Используйте вместо этого setFinder()/getFinder().

Параметры

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

Возвращает

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

foreignKey()source public deprecated

foreignKey( string|null $key = null )

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

Устарело

3.4.0 Используйте вместо этого setForeignKey()/getForeignKey().

Параметры

строка|null $key необязательно null
ключ для связи обеих таблиц

Возвращает

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

getBindingKey()source public

getBindingKey( )

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

Возвращает

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

getCascadeCallbacks()source public

getCascadeCallbacks( )

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

Возвращает

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

getClassName()source public

getClassName( )

Получает имя класса объекта целевой таблицы.

Возвращает

строка

getConditions()source public

getConditions( )

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

Возвращает

массив|вызов функции

См. также

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

getDependent()source public

getDependent( )

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

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

Возвращает

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

getFinder()source public

getFinder( )

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

Возвращает

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

getJoinType()source public

getJoinType( )

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

Возвращает

строка

getName()source public

getName( )

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

Возвращает

строка

getProperty()source public

getProperty( )

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

Возвращает

строка

getSource()source public

getSource( )

Получает экземпляр таблицы для стороны источника ассоциации.

Возвращает

Cake\ORM\Table

getStrategy()source public

getStrategy( )

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

Возвращает

строка

getTarget()source public

getTarget( )

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

Возвращает

Cake\ORM\Table

joinType()source public deprecated

joinType( string|null $type = null )

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

Устарело

3.4.0 Используйте setJoinType()/getJoinType() вместо этого.

Параметры

string|null $type необязательно null
тип соединения (например, INNER)

Возвращает

string

name()source public deprecated

name( string|null $name = null )

Устанавливает имя для этой ассоциации.

Устарело

3.4.0 Используйте setName()/getName() вместо этого.

Параметры

string|null $name необязательно null
Назначаемое имя

Возвращает

string

property()source public deprecated

property( string|null $name = null )

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

Устарело

3.4.0 Используйте setProperty()/getProperty() вместо этого.

Параметры

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

Возвращает

string

requiresKeys()source public

requiresKeys( array $options = [] )

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

Параметры

array $options необязательно []
Опции, содержащие используемую стратегию.

Возвращает

boolean
true, если список ключей потребуется

setBindingKey()source public

setBindingKey( string|array $key )

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

Параметры

string|array $key
поле или поля таблицы, используемые для связывания обеих таблиц

Возвращает


$this

setCascadeCallbacks()source public

setCascadeCallbacks( boolean $cascadeCallbacks )

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

Параметры

boolean $cascadeCallbacks
Значение переключателя обратных вызовов каскадных операций

Возвращает


$this

setClassName()source public

setClassName( string $className )

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

Параметры

string $className
Имена класса для установки.

Возвращает


$this

Вызывает исключение

InvalidArgumentException

Если имя класса установлено после разрешения целевой таблицы и оно не соответствует имени класса целевой таблицы.


setConditions()source public

setConditions( array|callable $conditions )

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

Параметры

array|callable $conditions
Список условий для использования

Возвращает


$this

См. также

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

setDependent()source public

setDependent( boolean $dependent )

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

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

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

Параметры

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

Возвращает


$this

setFinder()source public

setFinder( string|array $finder )

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

Параметры

string|array $finder
имя используемого поиска или массив из имени поиска и опции.

Возвращает


$this

setForeignKey()source public

setForeignKey( string|array $key )

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

Параметры

string|array $key
ключ или ключи, используемые для связывания обеих таблиц

Возвращает


$this

setJoinType()source public

setJoinType( string $type )

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

Параметры

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

Возвращает


$this

setName()source public

setName( string $name )

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

Параметры

string $name
Назначаемое имя

Возвращает


$this

setProperty()source public

setProperty( string $name )

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

Параметры

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

Возвращает


$this

setSource()source public

setSource( Cake\ORM\Table $table )

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

Параметры

Cake\ORM\Table $table
экземпляр, который будет назначен для исходной стороны

Возвращает


$this

setStrategy()source public

setStrategy( string $name )

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

Параметры

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

Возвращает


$this

Вызывает исключение

InvalidArgumentException
Когда предоставлена неверная стратегия.

setTarget()source public

setTarget( Cake\ORM\Table $table )

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

Параметры

Cake\ORM\Table $table
экземпляр, который будет назначен для целевой стороны

Возвращает


$this
END_OF_DOCUMENT_MARKER

source()source public deprecated

source( Cake\ORM\Table $table = null )

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

Устаревшее

3.4.0 Используйте setSource()/getSource() вместо этого.

Параметры

Cake\ORM\Table $table необязательно null
экземпляр, который нужно назначить как источник

Возвращает

Cake\ORM\Table

strategy()source public deprecated

strategy( string|null $name = null )

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

Устаревшее

3.4.0 Используйте setStrategy()/getStrategy() вместо этого.

Параметры

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

Возвращает

string

Исключения

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

target()source public deprecated

target( Cake\ORM\Table $table = null )

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

Устаревшее

3.4.0 Используйте setTarget()/getTarget() вместо этого.

Параметры

Cake\ORM\Table $table необязательно null
экземпляр, который нужно назначить как целевую сторону

Возвращает

Cake\ORM\Table

transformRow()source public

transformRow( array $row , string $nestKey , boolean $joined , string|null $targetProperty = null )

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

Параметры

array $row
Строка для преобразования
string $nestKey

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

boolean $joined

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

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

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

Возвращает

array

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

array $fields
Хэш поля => новое значение.
mixed $conditions

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

Возвращает

integer
Количество затронутых строк.

См. также

\Cake\ORM\Table::updateAll()

Методы, используемые из Cake\Core\ConventionsTrait

_camelize()source protected

_camelize( string $name )

Создаёт версию $name в стиле camelCase.

Параметры

string $name
Имя

Возвращает

string
Имя в стиле camelCase

_entityName()source protected

_entityName( string $name )

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

Параметры

string $name
Имя

Возвращает

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

_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
Имя множественного числа для представлений

Методы, используемые из Cake\ORM\Locator\LocatorAwareTrait

getTableLocator()source public

getTableLocator( )

Возвращает локатор таблиц.

Возвращает

Cake\ORM\Locator\LocatorInterface

setTableLocator()source public

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

Устанавливает локатор таблиц.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator
Экземпляр LocatorInterface.

Возвращает


$this
END_OF_DOCUMENT_MARKER

tableLocator()source public deprecated

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

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

Устаревшее

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator необязательный null
Экземпляр LocatorInterface.

Возвращает

Cake\ORM\Locator\LocatorInterface

Подробности свойств

$_validStrategiessource

protected массив

Допустимые стратегии для этого типа ассоциации

[
    self::STRATEGY_JOIN,
    self::STRATEGY_SELECT
]

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.ORM.Association.BelongsTo.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API