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

public  $baseControllerClass = 'yii\web\Controller'

public array getColumnNames ( )

public  $controllerClass = null

public string getControllerID ( )

public string getDescription ( )

public boolean $enablePjax = false

public  $indexWidgetType = 'grid'

public  $modelClass = null

public string getName ( )

public void getNameAttribute ( )

public array getSearchAttributes ( )

public  $searchModelClass = ''

public boolean|yii\db\TableSchema getTableSchema ( )

public string getViewPath ( )

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

generateActionParamComments() public method

Генерирует теги параметров для phpdoc

public array generateActionParamComments ( )
return	array	Теги параметров для phpdoc

generateActionParams() public method

Генерирует параметры действия

public string generateActionParams ( )

generateActiveField() public method

Генерирует код для активного поля

public string generateActiveField ( $attribute )
$attribute	string

generateActiveSearchField() public method

Генерирует код для поля активного поиска

public string generateActiveSearchField ( $attribute )
$attribute	string

generateColumnFormat() public method

Генерирует формат столбца

public string generateColumnFormat ( $column )
$column	yii\db\ColumnSchema

generateSearchConditions() public method

Генерирует условия поиска

public array generateSearchConditions ( )

generateSearchLabels() public method

Генерирует метки атрибутов для модели поиска.

public array generateSearchLabels ( )
return	array	Сгенерированные метки атрибутов (имя => метка)

generateSearchRules() public method

Генерирует правила валидации для модели поиска.

public array generateSearchRules ( )
return	array	Сгенерированные правила валидации

generateUrlParams() public method

Генерирует параметры URL

public string generateUrlParams ( )

getClassDbDriverName() protected method (доступен начиная с версии 2.0.6)

protected string|null getClassDbDriverName ( )
return	string|null	Имя драйвера базы данных модели. Если база данных не является экземпляром \yii\db\Connection, возвращается null.

getColumnNames() public method

public array getColumnNames ( )
return	array	Имена столбцов модели

getControllerID() public method

public string getControllerID ( )
return	string	Идентификатор контроллера (без префикса идентификатора модуля)

getDescription() public method

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

getName() public method

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

getNameAttribute() public method

public void getNameAttribute ( )

getSearchAttributes() public method

public array getSearchAttributes ( )
return	array	Атрибуты, используемые для поиска

getTableSchema() public method

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

public boolean|yii\db\TableSchema getTableSchema ( )

getViewPath() public method

public string getViewPath ( )
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\crud\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\crud\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	Список атрибутов с сохранением состояния

validateModelClass() public method

Проверяет, является ли класс модели допустимым

public void validateModelClass ( )