Класс yii\gii\generators\controller\Generator

public array getActionIDs ( )

public string $actions = 'index'

public string $baseClass = 'yii\web\Controller'

public string $controllerClass = null

public string getControllerFile ( )

public string getControllerID ( )

public string getControllerNamespace ( )

public string getControllerSubPath ( )

public string getDescription ( )

public string getName ( )

public string $viewPath = null

attributeLabels() public method

Возвращает метки атрибутов.

Метки атрибутов в основном используются для отображения. Например, для атрибута firstName, мы можем объявить метку First Name, которая более удобна для пользователя и может быть отображена конечным пользователям.

По умолчанию метка атрибута генерируется с помощью generateAttributeLabel(). Этот метод позволяет явно указать метки атрибутов.

Обратите внимание, что для наследования меток, определенных в родительском классе, дочернему классу необходимо объединить родительские метки с дочерними метками, используя функции, такие как array_merge().

public array attributeLabels ( )
return	array	Метки атрибутов (имя => метка)

generate() public method

Генерирует код на основе текущего пользовательского ввода и указанных шаблонов файлов кода.

Это основной метод, который должны реализовывать дочерние классы. Обратитесь к yii\gii\generators\controller\Generator::generate() в качестве примера реализации этого метода.

public yii\gii\CodeFile[] generate ( )
return	yii\gii\CodeFile[]	Список файлов кода, которые нужно создать.

getActionIDs() public method

Нормализует $actions в массив идентификаторов действий.

public array getActionIDs ( )
return	array	Массив идентификаторов действий, введенных пользователем

getControllerFile() public method

public string getControllerFile ( )
return	string	Путь к файлу класса контроллера

getControllerID() public method

public string getControllerID ( )
return	string	Идентификатор контроллера

getControllerNamespace() public method

public string getControllerNamespace ( )
return	string	Пространство имен класса контроллера

getControllerSubPath() public method (доступно с версии 2.0.6)

Этот метод вернет подпуть для контроллера, если он расположен в подкаталоге директории контроллеров приложения

См. также https://github.com/yiisoft/yii2-gii/issues/182.

public string getControllerSubPath ( )
return	string	Подпуть контроллера

getDescription() public method

public string getDescription ( )
return	string	Подробное описание генератора.

getName() public method

public string getName ( )
return	string	Имя генератора кода

getViewFile() public method

public string getViewFile ( $action )
$action	string	Идентификатор действия
return	string	Путь к файлу представления действия

hints() public method

Возвращает список сообщений подсказок.

Ключи массива — имена атрибутов, а значения — соответствующие сообщения подсказок. Сообщения подсказок будут отображаться конечным пользователям при заполнении формы генератора.

public array hints ( )
return	array	Список сообщений подсказок

requiredTemplates() public method

Возвращает список требуемых файлов шаблонов кода.

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

public array requiredTemplates ( )
return	array	Список требуемых файлов шаблонов кода. Они должны быть путями к файлам относительно $templatePath.

rules() public method

Возвращает правила валидации для атрибутов.

Правила валидации используются методом validate() для проверки допустимости значений атрибутов. Дочерние классы могут переопределять этот метод для объявления различных правил валидации.

Каждое правило — это массив со следующей структурой:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

где

• список атрибутов: обязательный, указывает массив атрибутов, подлежащих валидации, для отдельного атрибута можно передать строку;
• тип валидатора: обязательный, указывает используемый валидатор. Он может быть встроенным именем валидатора, именем метода класса модели, анонимной функцией или именем класса валидатора.
• on: необязательный, указывает массив сценариев, в которых правило валидации может применяться. Если этот параметр не задан, правило будет применяться ко всем сценариям.
• дополнительные пары имя-значение могут быть указаны для инициализации соответствующих свойств валидатора. Обратитесь к API отдельных классов валидатора для возможных свойств.

Валидатор может быть либо объектом класса, расширяющего \yii\gii\generators\controller\Validator, либо методом класса модели (называемый встроенным валидатором), имеющим следующий синтаксис:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

В приведенном выше примере $attribute относится к атрибуту, который в данный момент валидируется, а $params содержит массив параметров конфигурации валидатора, таких как max в случае валидатора string. Значение атрибута, который в данный момент валидируется, может быть получено как $this->$attribute. Обратите внимание на $ перед attribute; это берет значение переменной $attribute и использует его в качестве имени свойства для доступа.

Yii также предоставляет набор \yii\gii\generators\controller\Validator::builtInValidators. Каждый из них имеет псевдоним, который может использоваться при указании правила валидации.

Ниже приведены несколько примеров:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Обратите внимание, что для наследования правил, определенных в родительском классе, дочернему классу необходимо объединить родительские правила с дочерними правилами, используя функции, такие как array_merge().

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

return array_merge(parent::rules(), [
    ...rules for the child class...
]);

public array rules ( )
return	array	Правила валидации

stickyAttributes() public method

Возвращает список «липких» атрибутов.

«Липкий» атрибут сохранит свое значение и инициализирует атрибут этим значением при перезапуске генератора.

public array stickyAttributes ( )
return	array	Список «липких» атрибутов

successMessage() public method

Возвращает сообщение, которое будет отображено при успешном сохранении сгенерированного кода.

Подклассы могут переопределить этот метод для настройки сообщения.

public string successMessage ( )
return	string	Сообщение, отображаемое при успешном сохранении сгенерированного кода.