Класс HasOne
Представляет отношение 1 — 1, где сторона источника отношения связана только с одной записью в целевой таблице и наоборот.
Пример ассоциации HasOne: Пользователь имеет один профиль.
- Cake\ORM\Association использует Cake\Core\ConventionsTrait , Cake\ORM\Locator\LocatorAwareTrait
-
Cake\ORM\Association\HasOne
Наследуемые константы
-
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
Краткое описание методов
- _propertyName() protectedВозвращает имя свойства по умолчанию на основе имени ассоциации.
- cascadeDelete() publicОбрабатывает каскадное удаление из связанной модели.
- eagerLoader() public
Загружает список записей в целевой таблице, связанных с другим набором записей в таблице источника. Записи источника можно указать двумя способами: во-первых, передать объект запроса, настроенный для поиска в таблице источника; во-вторых, явно передать массив значений первичных ключей из таблицы источника.
- getForeignKey() publicПолучает имя поля, представляющего внешний ключ к целевой таблице.
- isOwningSide() public
Возвращает, является ли переданная таблица стороной владения для этой ассоциации. Это означает, что строки в таблице «цели» потеряют важную или необходимую информацию, если строка в «источнике» не существует.
- saveAssociated() public
Принимает сущность из таблицы источника и проверяет, существует ли поле, соответствующее имени свойства для этой ассоциации. Найденная сущность будет сохранена в целевой таблице для этой ассоциации путём передачи предоставленных
$options - type() publicПолучает тип отношения.
Подробное описание методов
_propertyName()source protected
_propertyName( )
Возвращает имя свойства по умолчанию на основе имени ассоциации.
Возвращает
stringПереопределяет
Cake\ORM\Association::_propertyName() cascadeDelete()source public
cascadeDelete( Cake\Datasource\EntityInterface $entity , array $options = [] )
Обрабатывает каскадное удаление из связанной модели.
Параметры
-
Cake\Datasource\EntityInterface$entity - Сущность, которая инициировала каскадное удаление.
- массив
$optionsдополнительно [] - Параметры для исходного удаления.
Возвращает
booleanУспех
eagerLoader()source public
eagerLoader( array $options )
Загружает список записей в целевой таблице, связанных с другим набором записей в таблице источника. Записи источника можно указать двумя способами: во-первых, передать объект запроса, настроенный для поиска в таблице источника; во-вторых, явно передать массив значений первичных ключей из таблицы источника.
Параметры
- массив
$options - Параметры для eager loading.
Возвращает
ClosuregetForeignKey()source public
getForeignKey( )
Получает имя поля, представляющего внешний ключ к целевой таблице.
Возвращает
stringПереопределяет
Cake\ORM\Association::getForeignKey() isOwningSide()source public
isOwningSide( Cake\ORM\Table $side )
Возвращает, является ли переданная таблица стороной владения для этой ассоциации. Это означает, что строки в таблице «цели» потеряют важную или необходимую информацию, если строка в «источнике» не существует.
Параметры
-
Cake\ORM\Table$side - Возможная таблица с владение
Возвращает
booleansaveAssociated()source public
saveAssociated( Cake\Datasource\EntityInterface $entity , array $options = [] )
Принимает сущность из таблицы источника и проверяет, существует ли поле, соответствующее имени свойства для этой ассоциации. Найденная сущность будет сохранена в целевой таблице для этой ассоциации путём передачи предоставленных $options
Параметры
-
Cake\Datasource\EntityInterface$entity - сущность из таблицы источника
- массив
$optionsдополнительно [] - параметры для передачи методу сохранения в целевой таблице
Возвращает
boolean|Cake\Datasource\EntityInterfacefalse, если $entity не удалось сохранить, в противном случае возвращает сохранённую сущность
См. также
\Cake\ORM\Table::save()Методы, унаследованные от Cake\ORM\Association
__call()source public
__call( string $method , array $argument )
Перенаправляет вызовы методов в целевую таблицу.
Параметры
- строка
$method - имя метода для вызова
- массив
$argument - Список аргументов, передаваемых в функцию
Возвращает
mixedИсключения
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 )
Вспомогательная функция для условного добавления полей к части SELECT запроса из полей другого объекта запроса.
Параметры
-
Cake\ORM\Query$query - запрос, к которому будут добавлены поля
-
Cake\ORM\Query$surrogate - запрос, поля которого будут скопированы
- массив
$options - параметры, переданные методу
attachTo
_appendNotMatching()source protected
_appendNotMatching( Cake\Datasource\QueryInterface $query , array $options )
Условно добавляет условие к переданному запросу, которое будет искать записи, где нет соответствия с данным ассоциацией.
Параметры
-
Cake\Datasource\QueryInterface$query - Запрос для изменения
- массив
$options - Массив параметров, содержащий ключ
negateMatch.
_bindNewAssociations()source protected
_bindNewAssociations( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )
Применяет все присоединяемые ассоциации к $query из контент-элементов, найденных в запросе $surrogate.
Копирует все содержащиеся ассоциации из запроса $surrogate в переданный $query. Контент-элементы изменены так, что они соответствуют цепочке ассоциаций, из которых они возникли.
Параметры
-
Cake\ORM\Query$query - запрос, к которому будут прикреплены ассоциации
-
Cake\ORM\Query$surrogate - запрос, содержащий контент-элементы, которые нужно прикрепить
- массив
$options - параметры, переданные методу
attachTo
_dispatchBeforeFind()source protected
_dispatchBeforeFind( Cake\ORM\Query $query )
Вызывает beforeFind для целевой таблицы для запроса, к которому присоединяется данная ассоциация.
Параметры
-
Cake\ORM\Query$query - запрос, к которому присоединяется ассоциация
_extractFinder()source protected
_extractFinder( string|array $finderData )
Вспомогательный метод для вывода запрошенного нахождения и его параметров.
Возвращает выведенные параметры из нахождения $type.
Примеры:
Следующее вызовет нахождение 'translations' со значением нахождения в качестве параметров: $query->contain(['Comments' => ['finder' => ['translations']]]); $query->contain(['Comments' => ['finder' => ['translations' => []]]]); $query->contain(['Comments' => ['finder' => ['translations' => ['locales' => ['en_US']]]]]);
Параметры
- строка|массив
$finderData Имя нахождения или массив, имеющий имя в качестве ключа и параметры в качестве значения.
Возвращает
массив_formatAssociationResults()source protected
_formatAssociationResults( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )
Добавляет функцию форматирования к переданному $query если запрос $surrogate объявляет любой другой форматировщик. Поскольку запрос $surrogate соответствует связанной целевой таблице, результирующий форматировщик будет результатом применения форматировщиков-суррогатов только к свойству, соответствующему этой таблице.
Параметры
-
Cake\ORM\Query$query - запрос, к которому будет применено форматирование
-
Cake\ORM\Query$surrogate запрос, содержащий форматировщики для связанной целевой таблицы.
- массив
$options - параметры, переданные методу
attachTo
_getClassName()source protected
_getClassName( string $alias , array $options = [] )
Получает имя класса таблицы.
Параметры
- строка
$alias - Имя псевдонима, которое вы хотите получить.
- массив
$optionsнеобязательно [] - Массив параметров таблицы.
Возвращает
строка_joinCondition()source protected
_joinCondition( array $options )
Возвращает одно или несколько условий, которые нужно добавить к сгенерированной части условия объединения для получения результатов в целевой таблице.
Параметры
- массив
$options - список параметров, переданных методу attachTo
Возвращает
массивИсключения
RuntimeExceptionесли количество столбцов в foreignKey не соответствует количеству столбцов в primaryKey исходной таблицы
_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 )
Устанавливает имя поля, представляющего поле привязки к целевой таблице. Если не указано вручную, используется первичный ключ таблицы владельца.
Если параметры не переданы, возвращается текущее поле.
Устарело
3.4.0 Используйте setBindingKey()/getBindingKey() вместо этого.Параметры
- строка|null
$keyнеобязательно null - поле таблицы, используемое для связи обеих таблиц
Возвращает
строка|массивcanBeJoined()source public
canBeJoined( array $options = [] )
Можно ли напрямую выразить эту ассоциацию в объединении запросов?
Параметры
- массив
$optionsнеобязательно [] - настройка параметров, которые могут повлиять на результат
Возвращает
булевоcascadeCallbacks()source public deprecated
cascadeCallbacks( boolean|null $cascadeCallbacks = null )
Устанавливает, должны ли также срабатывать вызовы каскадного удаления. Если аргументы не переданы, возвращается текущее значение конфигурации.
Устарело
3.4.0 Используйте setCascadeCallbacks()/getCascadeCallbacks() вместо этого.Параметры
- булево|null
$cascadeCallbacksнеобязательно null - значение переключателя каскадных вызовов
Возвращает
булевоclassName()source public deprecated
className( )
Имя класса целевой таблицы.
Устарело
3.7.0 Используйте getClassName() вместо этого.Возвращает
строка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\TablegetStrategy()source public
getStrategy( )
Возвращает имя стратегии, которое будет использоваться для извлечения связанных записей. Имейте в виду, что некоторые типы объединений могут не реализовывать, но по умолчанию стратегию, что делает любые изменения в этом параметре недействительными.
Возвращает
строкаgetTarget()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
Параметры
- 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$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.HasOne.html