Трейт ModelAwareTrait

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

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

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

Cake\Console\Shell, Cake\Controller\Controller, Cake\Mailer\Mailer, Cake\View\Cell

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

Cake\Controller\ErrorController, Cake\Shell\CommandListShell, Cake\Shell\Task\ExtractTask, Cake\Shell\Task\LoadTask, Cake\Shell\Task\UnloadTask, Cake\Shell\CompletionShell, Cake\Shell\I18nShell, Cake\Shell\OrmCacheShell, Cake\Shell\PluginShell, Cake\Shell\RoutesShell, Cake\Shell\ServerShell, Cake\Shell\Task\AssetsTask, Cake\Shell\Task\CommandTask

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

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

_setModelClasssource protected

_setModelClass( string $name )

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

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

Параметры

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

loadModelsource public

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

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

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

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

Параметры

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

Возвращает

object
Созданный экземпляр модели.

Исключения

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

modelFactorysource public

modelFactory( string $type , callable $factory )

Регистрирует вызываемый объект для генерации репозиториев заданного типа.

Параметры

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

modelTypesource public

modelType( string|null $modelType null )

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

Параметры

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

Возвращает

string|$this
$this

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

$_modelFactoriessource

protected массив

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

[]

$_modelTypesource

protected строка

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

'Table'

$modelClasssource

public строка

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

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

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Datasource.ModelAwareTrait.html