Класс BelongsTo
Представляет отношение 1 - N, где сторона источника связана только с одной записью в целевой таблице.
Примером ассоциации BelongsTo будет Article принадлежит Author.
- 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
Возвращает одно или несколько условий, которые должны быть добавлены к сгенерированной части JOIN для получения результатов в целевой таблице.
- _propertyName() protectedВозвращает имя свойства по умолчанию, основанное на имени ассоциации.
- cascadeDelete() publicОбработка каскадных удалений.
- eagerLoader() public
Загружает список записей в целевой таблице, связанных с другой группой записей в исходной таблице. Исходные записи можно указать двумя способами: первый — передать объект Query, настроенный для поиска в исходной таблице, второй — явно передать массив значений первичного ключа из исходной таблицы.
- getForeignKey() publicПолучает имя поля, представляющего внешний ключ к целевой таблице.
- isOwningSide() public
Возвращает значение, указывающее, является ли переданная таблица стороной владения для этой ассоциации. Это означает, что строки в таблице «target» потеряют важную или необходимую информацию, если строка в таблице «source» не существует.
- saveAssociated() public
Принимает сущность из исходной таблицы и проверяет, есть ли поле, соответствующее имени свойства для этой ассоциации. Найденная сущность будет сохранена в целевой таблице для этой ассоциации, передавая предоставленные
$options - type() publicПолучить тип отношения.
Подробное описание методов
_joinCondition()source protected
_joinCondition( array $options )
Возвращает одно или несколько условий, которые должны быть добавлены к сгенерированной части JOIN для получения результатов в целевой таблице.
Параметры
- массив
$options - список параметров, переданных методу attachTo
Возвращает
массивИсключения
RuntimeExceptionесли количество столбцов в foreignKey не соответствует количеству столбцов в primaryKey целевой таблицы
Переопределяет
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 - Параметры для eager loading.
Возвращает
ClosuregetForeignKey()source public
getForeignKey( )
Получает имя поля, представляющего внешний ключ к целевой таблице.
Возвращает
строкаПереопределяет
Cake\ORM\Association::getForeignKey() isOwningSide()source public
isOwningSide( Cake\ORM\Table $side )
Возвращает значение, указывающее, является ли переданная таблица стороной владения для этой ассоциации. Это означает, что строки в таблице «target» потеряют важную или необходимую информацию, если строка в таблице «source» не существует.
Параметры
-
Cake\ORM\Table$side - Возможная таблица с владение
Возвращает
логическое значениеsaveAssociated()source public
saveAssociated( Cake\Datasource\EntityInterface $entity , array $options = [] )
Принимает сущность из исходной таблицы и проверяет, есть ли поле, соответствующее имени свойства для этой ассоциации. Найденная сущность будет сохранена в целевой таблице для этой ассоциации, передавая предоставленные $options
Параметры
-
Cake\Datasource\EntityInterface$entity - сущность из исходной таблицы
- массив
$optionsнеобязательно [] - параметры, которые будут переданы в метод сохранения в целевой таблице
Возвращает
логическое значение|Cake\Datasource\EntityInterfacefalse, если $entity не удалось сохранить, в противном случае возвращает сохраненную сущность
См. также
\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 = [] )
Изменяет объект Query, чтобы включить данные целевой связанной таблицы в окончательный результат.
Массив параметров может принимать следующие ключи:
- includeFields: Включать ли поля целевой модели в результат
- foreignKey: Имя поля, используемого в качестве внешнего ключа, если false, не используется
- conditions: массив с перечнем условий для фильтрации объединения, он будет объединен с любыми условиями, первоначально настроенными для этой ассоциации
- fields: список полей в целевой таблице, которые нужно включить в результат
- type: Тип соединения (например, INNER) записей, найденных в этой ассоциации
- aliasPath: Строка с точками, представляющая путь имен ассоциаций, следующих от основной таблицы переданного запроса к этой ассоциации.
- propertyPath: Строка с точками, представляющая путь свойств ассоциации, которые нужно проследить от основного сущности переданного запроса к этой ассоциации
- joinType: Тип SQL-соединения, используемый в запросе.
- negateMatch: Добавит условие в переданный запрос для исключения совпадений с этой ассоциацией.
Параметры
-
Cake\ORM\Query$query - запрос, который нужно изменить, чтобы включить данные целевой таблицы
- массив
$optionsнеобязательно [] - Дополнительные параметры или переопределения для учета
Исключения
RuntimeExceptionесли переданный билдер запросов не возвращает объект запроса
bindingKey()source public deprecated
bindingKey( string|null $key = null )
Устанавливает имя поля, представляющего поле связи с целевой таблицей. Если не указано вручную, используется первичный ключ таблицы, владеющей стороной.
Если параметры не переданы, возвращается текущее поле.
Deprecated
3.4.0 Используйте setBindingKey()/getBindingKey() вместо этого.Параметры
- строка|null
$keyнеобязательно null - поле таблицы, используемое для связи обеих таблиц
Возвращает
строка|массивcanBeJoined()source public
canBeJoined( array $options = [] )
Можно ли выразить эту ассоциацию напрямую в соединении запроса
Параметры
- массив
$optionsнеобязательно [] - настраиваемый ключ параметров, который может изменить возвращаемое значение
Возвращает
booleancascadeCallbacks()source public deprecated
cascadeCallbacks( boolean|null $cascadeCallbacks = null )
Устанавливает, будут ли также срабатывать обратные вызовы при каскадных удалениях. Если аргументы не переданы, возвращается текущее значение конфигурации.
Deprecated
3.4.0 Используйте setCascadeCallbacks()/getCascadeCallbacks() вместо этого.Parameters
- boolean|null
$cascadeCallbacksoptional null - Значение переключателя каскадных обратных вызовов
Returns
booleanclassName()source public deprecated
className( )
Имя класса объекта целевой таблицы
Deprecated
3.7.0 Используйте getClassName() вместо этого.Returns
stringconditions()source public deprecated
conditions( array|null $conditions = null )
Устанавливает список условий, которые всегда должны включаться при извлечении записей из целевого объединения. Если параметры не переданы, возвращается текущий список.
Deprecated
3.4.0 Используйте setConditions()/getConditions() вместо этого.Parameters
- array|null
$conditionsoptional null - Список условий для использования
Returns
array|callableSee
\Cake\Database\Query::where() для примеров формата массиваdefaultRowValue()source public
defaultRowValue( array $row , boolean $joined )
Возвращает измененную строку после добавления свойства для этого объединения со значениями по умолчанию в соответствии с тем, было ли объединение присоединено или получено извне.
Parameters
- array
$row - Строка, для которой нужно установить значение по умолчанию.
- boolean
$joined Является ли строка результатом прямого объединения с этим объединением
Returns
arraydeleteAll()source public
deleteAll( mixed $conditions )
Делегирует операцию удаления методу deleteAll целевой таблицы
Parameters
- mixed
$conditions Условие, используемое, поддерживает все, что может принять Query::where().
Returns
integerВозвращает количество затронутых строк.
See
\Cake\ORM\Table::deleteAll()dependent()source public deprecated
dependent( boolean|null $dependent = null )
Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.
Это используется в основном для указания того, что записи должны быть удалены, если владеющая запись в исходной таблице удалена.
Если параметры не переданы, возвращается текущее значение.
Deprecated
3.4.0 Используйте setDependent()/getDependent() вместо этого.Parameters
- boolean|null
$dependentoptional null - Установите режим зависимости. Используйте null для чтения текущего состояния.
Returns
booleanexists()source public
exists( array|callable|Cake\Database\ExpressionInterface $conditions )
Делегирует операцию целевой таблице exists после добавления условий по умолчанию для этого объединения
Parameters
- array|callable|
Cake\Database\ExpressionInterface$conditions Условие для проверки, соответствует ли какая-либо запись.
Returns
booleanSee
\Cake\ORM\Table::exists()find()source public
find( string|array|null $type = null , array $options = [] )
Делегирует операцию поиска методу find целевой таблицы и соответствующим образом изменяет запрос на основе конфигурации этого объединения
Parameters
- string|array|null
$typeoptional null тип запроса, если передан массив, он будет интерпретироваться как параметр
$options- array
$optionsoptional [] - Параметры для поиска
Returns
Cake\ORM\QuerySee
\Cake\ORM\Table::find()finder()source public deprecated
finder( string|null $finder = null )
Устанавливает используемый по умолчанию поиск для извлечения строк из целевой таблицы. Если параметры не переданы, возвращается имя текущего поиска.
Deprecated
3.4.0 Используйте setFinder()/getFinder() вместо этого.Parameters
- string|null
$finderoptional null - имя используемого поиска
Returns
string|arrayforeignKey()source public deprecated
foreignKey( string|null $key = null )
Устанавливает имя поля, представляющего внешний ключ к целевой таблице. Если параметры не переданы, возвращается текущее поле.
Deprecated
3.4.0 Используйте setForeignKey()/getForeignKey() вместо этого.Parameters
- string|null
$keyoptional null - ключ, используемый для связывания обеих таблиц
Returns
string|arraygetBindingKey()source public
getBindingKey( )
Получает имя поля, представляющего поле привязки к целевой таблице. Если не указано вручную, используется первичный ключ таблицы владения.
Returns
string|arraygetCascadeCallbacks()source public
getCascadeCallbacks( )
Возвращает, будут ли при каскадных удалениях также срабатывать обратные вызовы.
Returns
booleangetClassName()source public
getClassName( )
Получает имя класса объекта целевой таблицы.
Returns
stringgetConditions()source public
getConditions( )
Получает список условий, которые всегда должны включаться при извлечении записей из целевого объединения.
Returns
array|callableSee
\Cake\Database\Query::where() для примеров формата массиваgetDependent()source public
getDependent( )
Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.
Это используется в основном для указания того, что записи должны быть удалены, если владеющая запись в исходной таблице удалена.
Returns
booleangetFinder()source public
getFinder( )
Получает используемый по умолчанию поиск для извлечения строк из целевой таблицы.
Returns
string|arraygetJoinType()source public
getJoinType( )
Получает тип объединения, который будет использоваться при добавлении объединения в запрос.
Returns
stringgetName()source public
getName( )
Получает имя этого объединения, обычно псевдоним, присвоенный целевой связанной таблице
Returns
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
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
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 в формате 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 )
Создаёт множественное имя переменной для представлений
Параметры
- строка
$name - Имя для использования
Возвращает
строкуМножественное имя для представлений
Методы, используемые из 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$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.7/class-Cake.ORM.Association.BelongsTo.html