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

public string getDescription ( )

public array getModelAttributes ( )

public  $modelClass = null

public string getName ( )

public  $scenarioName = null

public  $viewName = null

public  $viewPath = '@app/views'

attributeLabels() общедоступный метод

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

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

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

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

public массив attributeLabels ( )
возвращает	массив	Метки атрибутов (имя => метка)

generate() общедоступный метод

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

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

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

getDescription() общедоступный метод

public строка getDescription ( )
возвращает	строка	Подробное описание генератора.

getModelAttributes() общедоступный метод

public массив getModelAttributes ( )
возвращает	массив	Список безопасных атрибутов $modelClass.

getName() общедоступный метод

public строка getName ( )
возвращает	строка	Имя генератора кода.

hints() общедоступный метод

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

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

public массив hints ( )
возвращает	массив	Список сообщений подсказок

requiredTemplates() общедоступный метод

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

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

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

rules() общедоступный метод

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

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

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

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

где

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

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

stickyAttributes() общедоступный метод

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

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

public массив stickyAttributes ( )
возвращает	массив	Список «липких» атрибутов

successMessage() общедоступный метод

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

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

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

validateViewPath() общедоступный метод

Проверяет $viewPath на то, является ли это корректным путём или псевдонимом пути и существует ли он.

public void validateViewPath ( )