Трейт ModelAwareTrait

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

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

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

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

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

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

$_modelFactories protected

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

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

string|false|null

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

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

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

Если поставщик репозитория не возвращает объект, будет выброшено исключение 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 deprecated

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 строка|false|null

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

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

Использование false для отключения автозагрузки для этого объекта. Null для автоматического определения на основе имени контроллера.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.7/class-Cake.Datasource.ModelAwareTrait.html