Трейт ModelAwareTrait

Обеспечивает функциональность для загрузки классов таблиц и других репозиториев в свойства объекта-хоста.

Примеры пользователей этого трейта — Cake\Controller\Controller и Cake\Console\Shell.

Прямые пользователи

Косвенные пользователи

Пространство имён: Cake\Datasource
Расположение: Datasource/ModelAwareTrait.php

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

$_modelFactories protected

array
Список переопределённых функций фабрики моделей.
$_modelType protected

string
Тип модели для использования.
$modelClass public

string

Основное имя класса модели этого объекта. Должно быть в множественном числе. CakePHP не будет склонять имя.

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

_setModelClass() protected
Устанавливает свойства modelClass и modelKey на основе соглашений.
getModelType() public
Получить тип модели, который будет использоваться этим классом
loadModel() public
Загружает и создаёт объекты репозитория, необходимые этому объекту
modelFactory() public
Переопределить существующую вызываемую функцию для создания репозиториев заданного типа.
modelType() public
Установить или получить тип модели, который будет использоваться этим классом
setModelType() public
Установить тип модели, который будет использоваться этим классом

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

_setModelClass()source protected

_setModelClass( string $name )

Устанавливает свойства modelClass и modelKey на основе соглашений.

Если свойства уже заданы, они не будут перезаписаны.

Параметры

строка $name: Имя класса.

getModelType()source public

getModelType( )

Получить тип модели, который будет использоваться этим классом

Возвращает

строка

loadModel()source public

loadModel( string|null $modelClass null , string|null $modelType null )

Загружает и создаёт объекты репозитория, необходимые этому объекту

Обычно используется для загрузки объектов ORM Table по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.

Если поставщик репозитория не возвращает объект, будет выброшено исключение MissingModelException.

Параметры

строка|null $modelClass необязательно null: Имя класса модели для загрузки. По умолчанию $this->modelClass
строка|null $modelType необязательно null: Тип репозитория для загрузки. По умолчанию значение modelType().

Возвращает

Cake\Datasource\RepositoryInterface
Созданный экземпляр модели.

Исключения

Cake\Datasource\Exception\MissingModelException
Если класс модели не найден.
InvalidArgumentException
При использовании типа, который не зарегистрирован.
UnexpectedValueException
Если тип модели не определён

modelFactory()source public

modelFactory( string $type , callable $factory )

Переопределить существующую вызываемую функцию для создания репозиториев заданного типа.

Параметры

строка $type: Имя типа репозитория, для которого предназначена функция фабрики.
вызываемая функция $factory: Функция фабрики, используемая для создания экземпляров.

modelType()source public

modelType( string|null $modelType null )

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

Устаревшее

3.5.0 Используйте getModelType()/setModelType() вместо этого.

Параметры

строка|null $modelType необязательно null: Тип модели или null для получения текущего

Возвращает

строка|Cake\Datasource\ModelAwareTrait
$this

setModelType()source public

setModelType( string $modelType )

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

Параметры

строка $modelType: Тип модели

Возвращает

$this

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

$_modelFactoriessource

protected массив

Список переопределённых функций фабрики моделей.

[]

$_modelTypesource

protected строка

Тип модели для использования.

'Table'

$modelClasssource

public строка

Основное имя класса модели этого объекта. Должно быть в множественном числе. CakePHP не будет склонять имя.

Пример: для объекта с именем 'Comments', modelClass должно быть 'Comments'. Классы плагинов должны использовать имена в формате Plugin.Comments для правильной загрузки моделей из соответствующего плагина.

© 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.Datasource.ModelAwareTrait.html