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

public string getControllerNamespace ( )

public string getDescription ( )

public  $moduleClass = null

public  $moduleID = null

public boolean getModulePath ( )

public string getName ( )

attributeLabels() открытый метод

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

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

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

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

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

generate() открытый метод

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

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

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

getControllerNamespace() открытый метод

public string getControllerNamespace ( )
return	string	Пространство имён контроллера модуля.

getDescription() открытый метод

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

getModulePath() открытый метод

public boolean getModulePath ( )
return	boolean	Директория, содержащая класс модуля

getName() открытый метод

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

hints() открытый метод

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

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

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

requiredTemplates() открытый метод

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

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

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

rules() открытый метод

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

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

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

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

где

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

Валидатор может быть либо объектом класса, расширяющего \yii\gii\generators\module\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\module\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	Правила проверки

successMessage() открытый метод

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

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

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

validateModuleClass() открытый метод

Проверяет $moduleClass, чтобы убедиться, что это полностью квалифицированное имя класса.

public void validateModuleClass ( )