Класс BelongsTo
Представляет отношение 1 - N, где сторона источника отношения связана только с одной записью в целевой таблице.
Пример ассоциации BelongsTo: Статья принадлежит Автору.
- Cake\ORM\Association использует Cake\Core\ConventionsTrait , Cake\ORM\Locator\LocatorAwareTrait
-
Cake\ORM\Association\BelongsTo
Унаследованные константы
-
MANY_TO_MANY,MANY_TO_ONE,ONE_TO_MANY,ONE_TO_ONE,STRATEGY_JOIN,STRATEGY_SELECT,STRATEGY_SUBQUERY
Резюме свойств
-
$_validStrategiesprotectedДопустимые стратегии для этого типа ассоциацииarray
Унаследованные свойства
-
_bindingKey,_cascadeCallbacks,_className,_conditions,_dependent,_finder,_foreignKey,_joinType,_name,_propertyName,_sourceTable,_strategy,_targetTable_tableLocator
Резюме методов
- _joinCondition() protected
Возвращает одно или несколько условий, которые должны быть добавлены к сгенерированной фразе объединения для получения результатов в целевой таблице.
- _propertyName() protectedВозвращает имя свойства по умолчанию на основе имени ассоциации.
- cascadeDelete() publicОбработка каскадных удалений.
- eagerLoader() public
Загружает список записей в целевой таблице, связанных с другим набором записей в исходной таблице. Записи источника могут быть указаны двумя способами: во-первых, путем передачи объекта Query, настроенного для поиска в таблице источника, а во-вторых, явно передав массив значений первичного ключа из таблицы источника.
- getForeignKey() publicПолучает имя поля, представляющего внешний ключ к целевой таблице.
- isOwningSide() public
Возвращает, является ли переданная таблица стороной владения для этой ассоциации. Это означает, что строки в таблице «цель» будут пропускать важную или необходимую информацию, если строка в «источнике» не существует.
- saveAssociated() public
Берет сущность из таблицы источника и проверяет, есть ли поле, соответствующее имени свойства для этой ассоциации. Найденная сущность будет сохранена в целевой таблице для этой ассоциации, передавая предоставленные
$options - type() publicПолучить тип отношения.
Подробное описание методов
_joinCondition()source protected
_joinCondition( array $options )
Возвращает одно или несколько условий, которые должны быть добавлены к сгенерированной фразе объединения для получения результатов в целевой таблице.
Параметры
- массив
$options - список параметров, переданных методу attachTo
Возвращает
массивИсключения
RuntimeExceptionесли количество столбцов во внешнем ключе не соответствует количеству столбцов в первичном ключе целевой таблицы
Переопределяет
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 )
Загружает список записей в целевой таблице, связанных с другим набором записей в исходной таблице. Записи источника могут быть указаны двумя способами: во-первых, путем передачи объекта Query, настроенного для поиска в таблице источника, а во-вторых, явно передав массив значений первичного ключа из таблицы источника.
Параметры
- массив
$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\EntityInterfacefalse, если сущность не может быть сохранена, в противном случае возвращает сохраненную сущность
См. также
\Cake\ORM\Table::save()Методы, унаследованные от 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если ассоциации с таким именем не существует
__isset()source public
__isset( string $property )
Делегирует вызов isset целевой таблице. Это удобно для проверки, есть ли у целевой таблицы другая ассоциация с указанным именем.
Параметры
- строка
$property - имя свойства
Возвращает
booleantrue, если свойство существует
_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необязательно [] - Массив параметров таблицы.
Возвращает
строка_options()source protected
_options( array $options )
Переопределите эту функцию, чтобы инициализировать любой конкретный класс ассоциации; в нее будет передан исходный список параметров, используемых в конструкторе.
Параметры
- массив
$options - Список параметров, используемых для инициализации
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 )
Устанавливает имя поля, представляющего поле привязки к целевой таблице. Если не указано явно, используется первичный ключ таблицы, владеющей стороной.
Если параметры не переданы, возвращается текущее поле.
Устарело
3.4.0 Используйте setBindingKey()/getBindingKey() вместо этого.Параметры
- строка|null
$keyнеобязательно null - поле таблицы, используемое для связи обеих таблиц
Возвращает
строка|массивcanBeJoined()source public
canBeJoined( array $options = [] )
Может ли эта ассоциация быть выражена непосредственно в объединении запроса
Параметры
- массив
$optionsнеобязательно [] - пользовательские параметры ключа, которые могут изменить возвращаемое значение
Возвращает
booleancascadeCallbacks()source public deprecated
cascadeCallbacks( boolean|null $cascadeCallbacks = null )
Устанавливает, будут ли вызываться обратные вызовы при каскадном удалении. Если аргументы не переданы, возвращается текущее значение конфигурации
Устаревшее
3.4.0 Используйте setCascadeCallbacks()/getCascadeCallbacks() вместо этого.Параметры
- boolean|null
$cascadeCallbacksнеобязательно null - Значение переключателя обратных вызовов каскадного удаления
Возвращает
booleanconditions()source public deprecated
conditions( array|null $conditions = null )
Устанавливает список условий, которые всегда должны включаться при извлечении записей из целевого объединения. Если параметры не переданы, возвращается текущий список.
Устаревшее
3.4.0 Используйте setConditions()/getConditions() вместо этого.Параметры
- array|null
$conditionsнеобязательно null - Список условий, которые необходимо использовать
Возвращает
array|callableСм. также
\Cake\Database\Query::where() для примеров формата массиваdefaultRowValue()source public
defaultRowValue( array $row , boolean $joined )
Возвращает изменённую строку после добавления свойства для этого объединения с значением по умолчанию, в зависимости от того, было ли объединение подключено или получено внешне.
Параметры
- array
$row - Строка, для которой нужно установить значение по умолчанию.
- boolean
$joined Признак того, является ли строка результатом прямого объединения с этим объединением
Возвращает
arraydeleteAll()source public
deleteAll( mixed $conditions )
Делегирует операцию удаления методу deleteAll целевой таблицы.
Параметры
- mixed
$conditions Условия, используемые для операции, принимает всё, что может принять Query::where().
Возвращает
integerВозвращает количество затронутых строк.
См. также
\Cake\ORM\Table::deleteAll()dependent()source public deprecated
dependent( boolean|null $dependent = null )
Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.
Это используется в первую очередь для указания, должны ли записи удаляться, если владеющая запись в исходной таблице удалена.
Если параметры не переданы, возвращается текущее значение.
Устаревшее
3.4.0 Используйте setDependent()/getDependent() вместо этого.Параметры
- boolean|null
$dependentнеобязательно null - Устанавливает зависимый режим. Используйте null для чтения текущего состояния.
Возвращает
booleanexists()source public
exists( array|callable|Cake\Database\ExpressionInterface $conditions )
Делегирует операцию методу exists целевой таблицы после добавления условий по умолчанию для этого объединения
Параметры
- array|callable|
Cake\Database\ExpressionInterface$conditions Условия, используемые для проверки, соответствует ли какая-либо запись.
Возвращает
booleanСм. также
\Cake\ORM\Table::exists()find()source public
find( string|array|null $type = null , array $options = [] )
Делегирует операцию поиска методу find целевой таблицы и изменяет запрос в соответствии с конфигурацией этого объединения
Параметры
- string|array|null
$typeнеобязательно null Тип запроса, который нужно выполнить. Если передаётся массив, он интерпретируется как
$optionsпараметр- array
$optionsнеобязательно [] - Параметры поиска
Возвращает
Cake\ORM\QueryСм. также
\Cake\ORM\Table::find()finder()source public deprecated
finder( string|null $finder = null )
Устанавливает используемый по умолчанию метод поиска для извлечения строк из целевой таблицы. Если параметры не переданы, возвращается имя текущего метода поиска.
Устаревшее
3.4.0 Используйте setFinder()/getFinder() вместо этого.Параметры
- string|null
$finderнеобязательно null - Имя используемого метода поиска
Возвращает
string|arrayforeignKey()source public deprecated
foreignKey( string|null $key = null )
Устанавливает имя поля, представляющего внешний ключ для целевой таблицы. Если параметры не переданы, возвращается текущее поле.
Устаревшее
3.4.0 Используйте setForeignKey()/getForeignKey() вместо этого.Параметры
- string|null
$keyнеобязательно null - Ключ, который будет использоваться для объединения обеих таблиц
Возвращает
string|arraygetBindingKey()source public
getBindingKey( )
Возвращает имя поля, представляющего поле связи с целевой таблицей. Если не указано явно, используется первичный ключ таблицы владельца.
Возвращает
string|arraygetCascadeCallbacks()source public
getCascadeCallbacks( )
Возвращает значение, определяющее, будут ли вызываться обратные вызовы при каскадном удалении.
Возвращает
booleangetConditions()source public
getConditions( )
Возвращает список условий, которые всегда должны включаться при извлечении записей из целевого объединения.
Возвращает
array|callableСм. также
\Cake\Database\Query::where() для примеров формата массиваgetDependent()source public
getDependent( )
Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.
Это используется в первую очередь для указания, должны ли записи удаляться, если владеющая запись в исходной таблице удалена.
Возвращает
booleangetFinder()source public
getFinder( )
Возвращает метод поиска по умолчанию для извлечения строк из целевой таблицы.
Возвращает
string|arraygetJoinType()source public
getJoinType( )
Возвращает тип объединения, который будет использоваться при добавлении объединения в запрос.
Возвращает
stringgetName()source public
getName( )
Возвращает имя этого объединения, обычно псевдоним назначенной целевой таблицы объединения
Возвращает
stringgetProperty()source public
getProperty( )
Возвращает имя свойства, которое должно быть заполнено данными из целевой таблицы в записи исходной таблицы.
Возвращает
stringgetSource()source public
getSource( )
Получает экземпляр таблицы для исходной стороны ассоциации.
Возвращает
Cake\ORM\TablegetStrategy()source public
getStrategy( )
Получает имя стратегии, используемой для извлечения связанных записей. Имейте в виду, что некоторые типы ассоциаций могут не реализовывать стратегию по умолчанию, что делает любые изменения в этом параметре недействительными.
Возвращает
stringgetTarget()source public
getTarget( )
Получает экземпляр таблицы для целевой стороны ассоциации.
Возвращает
Cake\ORM\TablejoinType()source public deprecated
joinType( string|null $type = null )
Устанавливает тип соединения, используемый при добавлении ассоциации в запрос. Если аргументы не переданы, возвращается текущий настроенный тип.
Устарело
3.4.0 Используйте setJoinType()/getJoinType() вместо этого.Параметры
- string|null
$typeнеобязательно null - тип соединения (например, INNER)
Возвращает
stringname()source public deprecated
name( string|null $name = null )
Устанавливает имя для этой ассоциации.
Устарело
3.4.0 Используйте setName()/getName() вместо этого.Параметры
- string|null
$nameнеобязательно null - Назначаемое имя
Возвращает
stringproperty()source public deprecated
property( string|null $name = null )
Устанавливает имя свойства, которое должно быть заполнено данными из целевой таблицы в записи исходной таблицы. Если аргументы не переданы, возвращается текущий настроенный тип.
Устарело
3.4.0 Используйте setProperty()/getProperty() вместо этого.Параметры
- string|null
$nameнеобязательно null - Имя свойства ассоциации. Используйте null для чтения текущего значения.
Возвращает
stringrequiresKeys()source public
requiresKeys( array $options = [] )
Возвращает true, если процесс жадного загрузки потребует набор связующих ключей таблицы-владельца для использования их в качестве фильтра в запросе нахождения.
Параметры
- array
$optionsнеобязательно [] - Опции, содержащие используемую стратегию.
Возвращает
booleantrue, если список ключей потребуется
setBindingKey()source public
setBindingKey( string|array $key )
Устанавливает имя поля, представляющего связующее поле с целевой таблицей. Если не указано вручную, используется первичный ключ таблицы со стороны владельца.
Параметры
- string|array
$key - поле или поля таблицы, используемые для связи обеих таблиц
Возвращает
$this
setCascadeCallbacks()source public
setCascadeCallbacks( boolean $cascadeCallbacks )
Устанавливает, будут ли срабатывать обратные вызовы при каскадном удалении.
Параметры
- boolean
$cascadeCallbacks - значение переключателя каскадных обратных вызовов
Возвращает
$this
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
source()source public deprecated
source( Cake\ORM\Table $table = null )
Устанавливает экземпляр таблицы для исходной стороны ассоциации. Если аргументы не переданы, возвращается текущий настроенный экземпляр таблицы.
Устаревшее
3.4.0 Используйте setSource()/getSource() вместо этого.Параметры
-
Cake\ORM\Table$tableнеобязательно null - экземпляр, который необходимо назначить исходной стороной
Возвращает
Cake\ORM\Tablestrategy()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\TabletransformRow()source public
transformRow( array $row , string $nestKey , boolean $joined , string|null $targetProperty = null )
Правильно вкладывает значения связанных строк результатов в правильные ключи массива внутри исходных результатов.
Параметры
- array
$row - Строка для преобразования
- string
$nestKey Ключ массива, в котором должны быть найдены результаты этой ассоциации
- boolean
$joined Является ли строка результатом прямого соединения с этой ассоциацией
- string|null
$targetPropertyнеобязательно null Имя свойства в исходных результатах, где данные ассоциации должны быть вложены. Будет использовано значение по умолчанию, если не указано.
Возвращает
arrayupdateAll()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
Параметры
- 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Множественное имя для представлений
Методы, используемые из Cake\ORM\Locator\LocatorAwareTrait
getTableLocator()source public
getTableLocator( )
Получает локатор таблицы.
Возвращает
Cake\ORM\Locator\LocatorInterfacesetTableLocator()source public
setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )
Устанавливает локатор таблицы.
Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocator - Экземпляр LocatorInterface.
Возвращаемое значение
$this
tableLocator()source public deprecated
tableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator = null )
Устанавливает локатор таблицы. Если параметры не переданы, возвращает текущий используемый локатор.
Устаревшее
3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocatoroptional 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.6/class-Cake.ORM.Association.BelongsTo.html