Spec-Zone.ru › CakePHP 3.3

Класс HasOne

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

Пример ассоциации HasOne — пользователь имеет один профиль.

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

Наследуемые константы

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

Краткое описание свойств

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

Наследуемые свойства

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

Краткое описание методов

  • _buildResultMap() protected
  • _linkField() protected
  • _propertyName() protected
    Возвращает имя свойства по умолчанию, основанное на имени ассоциации.
  • foreignKey() public

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

  • isOwningSide() public

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

  • saveAssociated() public

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

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

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

_buildResultMap()source protected

_buildResultMap( $fetchQuery , $options )

_linkField()source protected

_linkField( $options )

_propertyName()source protected

_propertyName( )

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

Возвращает

string

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

Cake\ORM\Association::_propertyName()

foreignKey()source public

foreignKey( string|null $key null )

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

Параметры

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

Возвращает

string

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

Cake\ORM\Association::foreignKey()

isOwningSide()source public

isOwningSide( Cake\ORM\Table $side )

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

Параметры

<%%CODE_BLOCK_32%%> <%%CODE_BLOCK_33%%>
Возможная таблица с правом владения

Возвращает

boolean

saveAssociated()source public

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

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

Параметры

<%%CODE_BLOCK_36%%> <%%CODE_BLOCK_37%%>
сущность из таблицы источника
массив <%%CODE_BLOCK_38%%> необязательно []

опции, передаваемые методу сохранения в целевой таблице

Возвращает

boolean|%%%CODE_BLOCK_39%%>

false, если $entity не удалось сохранить, в противном случае возвращает сохраненную сущность


См. также

\Cake\ORM\Table::save()

type()source public

type( )

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

Возвращает

string

Методы, унаследованные от Cake\ORM\Association

__call()source public

__call( string $method , array $argument )

Делегирует вызовы методов целевой таблице.

Параметры

строка <%%CODE_BLOCK_42%%>
имя вызываемого метода
массив <%%CODE_BLOCK_43%%>
Список аргументов, передаваемых в функцию

Возвращает

смешанный

Исключения

BadMethodCallException

__construct()source public

__construct( string $alias , array $options [] )

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

Параметры

строка <%%CODE_BLOCK_45%%>
Имя, присвоенное ассоциации
массив <%%CODE_BLOCK_46%%> необязательно []
Список свойств, которые должны быть установлены для этого объекта

__get()source public

__get( string $property )

Делегирует получение свойств целевой таблице. Это удобно для получения ассоциаций этой ассоциации

Параметры

строка <%%CODE_BLOCK_48%%>
имя свойства

Возвращает

%%%CODE_BLOCK_49%%>

Исключения

RuntimeException
если ассоциации с таким именем не существует

__isset()source public

__isset( string $property )

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

Параметры

строка <%%CODE_BLOCK_51%%>
имя свойства

Возвращает

boolean
true, если свойство существует

_appendFields()source protected

_appendFields( Cake\ORM\Query $query , Cake\ORM\Query $surrogate , array $options )

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

Параметры

<%%CODE_BLOCK_53%%> <%%CODE_BLOCK_54%%>
запрос, которому будут добавлены поля
<%%CODE_BLOCK_55%%> <%%CODE_BLOCK_56%%>
запрос, содержащий поля, которые нужно скопировать
массив <%%CODE_BLOCK_57%%>
опции, передаваемые методу <%%CODE_BLOCK_58%%>
END_OF_DOCUMENT_MARKER ```

_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

_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 optional []
Дополнительные параметры или переопределения, которые необходимо учитывать

Исключения

RuntimeException

если переданный создатель запросов не возвращает объект запроса


bindingKey()source public

bindingKey( string|null $key null )

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

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

Параметры

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

Возвращает

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

canBeJoined()source public

canBeJoined( array $options [] )

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

Параметры

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

Возвращает

boolean

cascadeCallbacks()source public

cascadeCallbacks( boolean|null $cascadeCallbacks null )

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

Параметры

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

Возвращает

boolean

cascadeDelete()source abstract public

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

Обрабатывает каскадное удаление из связанной модели.

Каждый реализуемый класс должен обрабатывать каскадное удаление как требуется.

Параметры

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

Возвращает

boolean
Успех

className()source public

className( )

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

Возвращает

строка

conditions()source public

conditions( array|null $conditions null )

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

Параметры

массив|null $conditions optional null
список условий, которые будут использоваться

Возвращает

массив

См. также

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

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

dependent( boolean|null $dependent null )

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

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

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

Параметры

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

Возвращает

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

eagerLoader()source абстрактный public

eagerLoader( array $options )

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

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

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

Массив параметров принимает следующие ключи:

  • запрос: Объект Query, настроенный для поиска записей исходной таблицы
  • ключи: Список значений первичных ключей из исходной таблицы
  • внешний ключ: Имя поля, используемого для связи обеих таблиц
  • условия: Список условий, передаваемых методу query where()
  • сортировка: Направление, в котором должны возвращаться записи
  • поля: Список полей для выбора из целевой таблицы
  • содержимое: Список связанных таблиц для загрузки связанных с целевой таблицей
  • стратегия: Имя используемой стратегии поиска записей целевой таблицы
  • ключ_вложенности: Ключ массива, под которым будут находиться результаты при преобразовании строки

Параметры

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

Возвращает

Замыкание

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

finder( string|null $finder null )

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

Параметры

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

Возвращает

строка

joinType()source public

joinType( string|null $type null )

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

Параметры

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

Возвращает

строка

name()source public

name( string|null $name null )

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

Параметры

строка|null $name необязательно null
Присваиваемое имя

Возвращает

строка

property()source public

property( string|null $name null )

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

Параметры

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

Возвращает

строка

source()source public

source( Cake\ORM\Table $table null )

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

Параметры

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

Возвращает

Cake\ORM\Table

strategy()source public

strategy( string|null $name null )

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

Параметры

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

Возвращает

строка

Исключение

InvalidArgumentException
Когда указана недопустимая стратегия.

target()source public

target( Cake\ORM\Table $table null )

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

Параметры

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

Возвращает

Cake\ORM\Table
END_OF_DOCUMENT_MARKER

transformRow()source public

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

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

Параметры

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

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

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

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

строка $targetProperty необязательно null

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

Возвращает

массив

updateAll()source public

updateAll( array $fields , mixed $conditions )

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

Параметры

массив $fields
Хеш пар «поле» => «новое значение».
смешанный тип $conditions

Условие, может быть любой параметр, принимаемый Query::where().

Возвращает

логическое значение
Успех Возвращает true, если затронуто одно или несколько строк.

См. также

\Cake\ORM\Table::updateAll()

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

cascadeDelete()source public

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

Каскадное удаление для удаления зависимых записей.

Этот метод ничего не делает, если связь не является зависимой.

Параметры

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

Возвращает

логическое значение
Успех.

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

_addFilteringCondition()source protected

_addFilteringCondition( Cake\ORM\Query $query , string|array $key , mixed $filter )

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

Параметры

Cake\ORM\Query $query
Запрос целевой таблицы
строка|массив $key
поля, которые должны использоваться для фильтрации
смешанный тип $filter
значение, которое должно использоваться для сопоставления с $key

Возвращает

Cake\ORM\Query

_addFilteringJoin()source public

_addFilteringJoin( Cake\ORM\Query $query , string $key , Cake\ORM\Query $subquery )

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

Параметры

Cake\ORM\Query $query
Запрос целевой таблицы
строка $key
поля, которые должны использоваться для фильтрации
Cake\ORM\Query $subquery
Подзапрос для фильтрации

Возвращает

Cake\ORM\Query

_assertFieldsPresent()source protected

_assertFieldsPresent( Cake\ORM\Query $fetchQuery , array $key )

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

Параметры

Cake\ORM\Query $fetchQuery
Запрос получения данных для связи
массив $key
Поля внешних ключей для проверки

Выбрасывает

InvalidArgumentException

_buildQuery()source protected

_buildQuery( array $options )

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

Параметры

массив $options
параметры, принимаемые eagerLoader()

Возвращает

Cake\ORM\Query

Выбрасывает

InvalidArgumentException
Когда ключ необходим для связи, но не выбран.

_buildSubquery()source protected

_buildSubquery( Cake\ORM\Query $query )

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

Параметры

Cake\ORM\Query $query
исходный запрос, используемый для загрузки записей источника

Возвращает

Cake\ORM\Query

_createTupleCondition()source protected

_createTupleCondition( Cake\ORM\Query $query , array $keys , mixed $filter , string $operator )

Возвращает объект TupleComparison, который может использоваться для сопоставления всех полей из $keys со значениями кортежа в $filter с помощью предоставленного оператора.

Параметры

Cake\ORM\Query $query
Запрос целевой таблицы
массив $keys
поля, которые должны использоваться для фильтрации
смешанный тип $filter
значение, которое должно использоваться для сопоставления с $key
строка $operator
Оператор сравнения кортежей

Возвращает

Cake\Database\Expression\TupleComparison

_defaultOptions()source protected

_defaultOptions( )

Возвращает параметры по умолчанию для eagerLoader

Возвращает

массив

_multiKeysInjector()source protected

_multiKeysInjector( array $resultMap , array $sourceKeys , string $nestKey )

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

Параметры

массив $resultMap
Массив с ключами, содержащими целевую таблицу
массив $sourceKeys
Массив с алиасами ключей для сопоставления
строка $nestKey
Ключ, в котором должны быть вложены результаты

Возвращает

Closure

_resultInjector()source protected

_resultInjector( Cake\ORM\Query $fetchQuery , array $resultMap , array $options )

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

Параметры

Cake\ORM\Query $fetchQuery
Используемый при получении данных запрос
массив $resultMap

Массив, содержащий внешние ключи в качестве ключей и соответствующие результаты целевой таблицы в качестве значений.

массив $options
Параметры, переданные методу eagerLoader

Возвращает

Closure

_subqueryFields()source protected

_subqueryFields( Cake\ORM\Query $query )

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

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

Параметры

Cake\ORM\Query $query
Запрос для получения полей.

Возвращает

массив
Список полей для подзапроса.

eagerLoader()source public

eagerLoader( array $options )

requiresKeys()source public

requiresKeys( array $options [] )

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

Параметры

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

Возвращает

логическое значение
true, если список ключей потребуется
END_OF_DOCUMENT_MARKER

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

_camelize()source protected

_camelize( string $name )

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

Параметры

строка $name
имя

Возвращает

строка
Имя в стиле camelCase

_entityName()source protected

_entityName( string $name )

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

Параметры

строка $name
Имя

Возвращает

строка
Имя модели в стиле camelCase и множественное число

_fixtureName()source protected

_fixtureName( string $name )

Создаёт имя фикстуры

Параметры

строка $name
Имя класса модели

Возвращает

строка
Ключ модели в единственном числе

_modelKey()source protected

_modelKey( string $name )

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

Если входная строка содержит точку, предполагается, что правая часть — это фактическое имя таблицы.

Параметры

строка $name
Имя класса модели

Возвращает

строка
Ключ модели в единственном числе

_modelNameFromKey()source protected

_modelNameFromKey( string $key )

Создаёт правильное имя модели из внешнего ключа

Параметры

строка $key
Внешний ключ

Возвращает

строка
Имя модели

_pluginNamespace()source protected

_pluginNamespace( string $pluginName )

Возвращает имя пространства имён плагина

Параметры

строка $pluginName
Имя плагина

Возвращает

строка
Пространство имён плагина

_pluginPath()source protected

_pluginPath( string $pluginName )

Находит правильный путь к плагину. Просматривает $pluginPaths для нужного плагина.

Параметры

строка $pluginName
Имя плагина, например DebugKit

Возвращает

строка
Путь к плагину.

_pluralHumanName()source protected

_pluralHumanName( string $name )

Создаёт имя множественного числа для отображения в представлениях

Параметры

строка $name
Имя контроллера

Возвращает

строка
Имя множественного числа

_singularHumanName()source protected

_singularHumanName( string $name )

Создаёт имя единственного числа для отображения в представлениях

Параметры

строка $name
Имя контроллера

Возвращает

строка
Имя единственного числа

_singularName()source protected

_singularName( string $name )

Создаёт имя единственного числа для использования в представлениях.

Параметры

строка $name
Имя для использования

Возвращает

строка
Имя переменной

_variableName()source protected

_variableName( string $name )

Создаёт имя множественного числа для отображения в представлениях

Параметры

строка $name
Имя для использования

Возвращает

строка
Имя множественного числа для представлений

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

tableLocator()source public

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

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

Параметры

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.3/class-Cake.ORM.Association.HasOne.html

Spec-Zone.ru

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