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

public  $authorEmail = null

public  $authorName = null

public string getDescription ( )

public  $keywords = "yii2,extension"

public string getKeywordsArrayJson ( )

public  $license = null

public string getName ( )

public  $namespace = null

public boolean getOutputPath ( )

public  $packageName = "yii2-"

public  $title = null

public  $type = "yii2-extension"

public  $vendorName = 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[]	Список файлов кода, которые должны быть созданы.

getDescription() public method

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

getKeywordsArrayJson() public method

public string getKeywordsArrayJson ( )
return	string	Массив ключевых слов, закодированный в формате JSON.

getName() public method

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

getOutputPath() public method

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

hints() public method

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

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

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

optsLicense() public method

public array optsLicense ( )
return	array	Параметры для выпадающего списка лицензии.

optsType() public method

public array optsType ( )
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\extension\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\extension\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	Сообщение, отображаемое при успешном сохранении сгенерированного кода.