Класс 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
Возвращает одно или несколько условий, которые нужно добавить к сгенерированной части 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 - Опции для ленивой загрузки.
Возвращаемое значение
функцияgetForeignKey()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
bindingKey( string|null $key null )
Устанавливает имя поля, представляющего поле связи с целевой таблицей. Если не указано вручную, используется первичный ключ таблицы со стороны владельца.
Если параметры не переданы, возвращается текущее поле.
Устарело
3.4.0 Используйте setBindingKey()/getBindingKey() вместо этого.Параметры
- строка|null
$keyнеобязательно null - поле таблицы, используемое для связи обеих таблиц
Возвращает
строка|массивcanBeJoined()source public
canBeJoined( array $options [] )
Можно ли эту ассоциацию выразить непосредственно в объединении запроса
Параметры
- массив
$optionsнеобязательно [] - настраиваемый ключ параметров, который может изменить возвращаемое значение
Возвращает
booleancascadeCallbacks()source public
cascadeCallbacks( boolean|null $cascadeCallbacks null )
Устанавливает, должны ли вызываться обратные вызовы при каскадном удалении. Если аргументы не переданы, возвращается текущее значение конфигурации
Устарело
3.4.0 Используйте setCascadeCallbacks()/getCascadeCallbacks() вместо этого.Параметры
- boolean|null
$cascadeCallbacksнеобязательно null - значение переключателя для обратных вызовов каскадного удаления
Возвращает
booleanconditions()source public
conditions( array|null $conditions null )
Устанавливает список условий, которые всегда должны включаться при извлечении записей из целевой ассоциации. Если параметры не переданы, возвращается текущий список.
Устарело
3.4.0 Используйте setConditions()/getConditions() вместо этого.Параметры
- array|null
$conditionsнеобязательно null - список условий для использования
Возвращает
arrayСм. также
\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
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
finder( string|null $finder null )
Устанавливает используемый по умолчанию метод поиска для извлечения строк из целевой таблицы. Если параметры не переданы, возвращается имя текущего метода поиска.
Устарело
3.4.0 Используйте setFinder()/getFinder() вместо этого.Параметры
- string|null
$finderнеобязательно null - имя метода поиска для использования
Возвращает
stringforeignKey()source public
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См. также
\Cake\Database\Query::where() для примеров формата массиваgetDependent()source public
getDependent( )
Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.
Это используется в основном для указания, что записи должны быть удалены, если владеющая запись в исходной таблице будет удалена.
Возвращает
booleangetFinder()source public
getFinder( )
Возвращает используемый по умолчанию метод поиска для извлечения строк из целевой таблицы.
Возвращает
stringgetJoinType()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
joinType( string|null $type null )
Устанавливает тип соединения, который будет использоваться при добавлении ассоциации в запрос. Если аргументы не переданы, возвращается текущий настроенный тип.
Устарело
3.4.0 Используйте setJoinType()/getJoinType() вместо этого.Параметры
- string|null
$typeнеобязательно null - тип соединения (например, INNER)
Возвращает
stringname()source public
name( string|null $name null )
Устанавливает имя для этой ассоциации.
Устарело
3.4.0 Используйте setName()/getName() вместо этого.Параметры
- string|null
$nameнеобязательно null - Присваиваемое имя
Возвращает
stringproperty()source public
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 $conditions )
Устанавливает список условий, которые всегда должны включаться при извлечении записей из целевой ассоциации.
Параметры
- array
$conditions - список используемых условий
Возвращает
$this
См. также
\Cake\Database\Query::where() для примеров формата массиваsetDependent()source public
setDependent( boolean $dependent )
Устанавливает, зависят ли записи в целевой таблице от исходной таблицы.
Это в первую очередь используется для указания, что записи должны быть удалены, если запись-владелец в исходной таблице удаляется.
Если параметры не переданы, возвращается текущее значение.
Параметры
- boolean
$dependent - Установка режима зависимости. Используйте null для чтения текущего состояния.
Возвращает
$this
setFinder()source public
setFinder( string $finder )
Устанавливает используемый по умолчанию поиск для извлечения строк из целевой таблицы.
Параметры
- string
$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
source( Cake\ORM\Table $table null )
Устанавливает экземпляр таблицы для стороны источника ассоциации. Если аргументы не переданы, возвращается текущий настроенный экземпляр таблицы
Устарело
3.4.0 Используйте setSource()/getSource() вместо этого.Параметры
-
Cake\ORM\Table$tableнеобязательно null - экземпляр, который должен быть назначен как сторона источника
Возвращает
Cake\ORM\Tablestrategy()source public
strategy( string|null $name null )
Устанавливает имя стратегии, используемой для извлечения связанных записей. Имейте в виду, что некоторые типы ассоциаций могут не реализовывать, но по умолчанию, и любые изменения в этом параметре окажутся недействительными. Если аргументы не переданы, возвращается текущая настроенная стратегия.
Устарело
3.4.0 Используйте setStrategy()/getStrategy() вместо этого.Параметры
- string|null
$nameнеобязательно null - Тип стратегии. Используйте null для чтения текущего значения.
Возвращает
stringВыбрасывает
InvalidArgumentExceptionПри предоставлении недействительной стратегии.
target()source public
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().
Возвращает
booleanУспех Возвращает true, если затронуто одно или несколько строк.
См. также
\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
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–2017 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.4/class-Cake.ORM.Association.BelongsTo.html