Абстрактный класс yii\gii\Generator

public string getDescription ( )

public boolean $enableI18N = false

public string $messageCategory = 'app'

public abstract string getName ( )

public string getStickyDataFile ( )

public string $template = 'default'

public string getTemplatePath ( )

public array $templates = []

attributeLabels() public method

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

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

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

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

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

autoCompleteData() public method

Возвращает список значений автозаполнения.

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

public массив autoCompleteData ( )
return	массив	Список значений автозаполнения

defaultTemplate() public method

Возвращает корневой путь к файлам шаблонов по умолчанию.

Реализация по умолчанию вернёт подкаталог "templates" каталога, содержащего файл класса генератора.

public строка defaultTemplate ( )
return	строка	Корневой путь к файлам шаблонов по умолчанию.

formView() public method

Возвращает файл представления для формы ввода генератора.

Реализация по умолчанию вернёт файл "form.php" в каталоге, содержащем файл класса генератора.

public строка formView ( )
return	строка	Файл представления для формы ввода генератора.

generate() public abstract method

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

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

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

generateString() public method

Генерирует строку в зависимости от свойства enableI18N

public строка generateString ( $string = '', $placeholders = [] )
$string	строка	Текст для генерации
$placeholders	массив	Плейсхолдеры, используемые для Yii::t()

getDescription() public method

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

getName() public abstract method

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

getStickyDataFile() public method

public строка getStickyDataFile ( )
return	строка	Путь к файлу, хранящему значения атрибутов.

getTemplatePath() public method

public строка getTemplatePath ( )
return	строка	Корневой путь к используемым файлам шаблонов.
throws	yii\base\InvalidConfigException	если $template некорректен

hints() public method

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

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

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

init() public method

Инициализирует объект.

Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.

public void init ( )

isReservedKeyword() public method

public логическое isReservedKeyword ( $value )
$value	строка	Атрибут, который нужно проверить
return	логическое	Является ли значение зарезервированным ключевым словом PHP.

loadStickyAttributes() public method

Загружает атрибуты со свойствами сохранения из внутреннего файла и заполняет ими генератор.

public void loadStickyAttributes ( )

render() public method

Генерирует код, используя указанный шаблон кода и параметры.

Обратите внимание, что шаблон кода будет использоваться как PHP-файл.

public строка render ( $template, $params = [] )
$template	строка	Файл шаблона кода. Он должен быть указан как путь к файлу относительно $templatePath.
$params	массив	Список параметров, которые будут переданы в файл шаблона.
return	строка	Сгенерированный код

requiredTemplates() public method

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

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

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

rules() public method

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

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

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

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

где

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

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

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

Сохраняет сгенерированный код в файлы.

public boolean save ( $files, $answers, &$results )
$files	yii\gii\CodeFile[]	Файлы кода, которые нужно сохранить
$answers	массив
$results	строка	Этот параметр получает значение из этого метода, указывающее сообщения журнала, сгенерированные при сохранении файлов кода.
возвращает	boolean	Были ли файлы успешно сохранены без ошибок.

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

Сохраняет сохранённые атрибуты во внутренний файл.

public void saveStickyAttributes ( )

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

Возвращает список сохранённых атрибутов.

Сохранённый атрибут будет запоминать своё значение и инициализирует атрибут этим значением при повторном запуске генератора.

public массив stickyAttributes ( )
возвращает	массив	Список сохранённых атрибутов

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

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

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

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

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

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

Если указан параметр extends, он также проверит, является ли класс дочерним классом класса, представленного параметром extends.

public void validateClass ( $attribute, $params )
$attribute	строка	Валидируемый атрибут
$params	массив	Параметры валидации

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

Проверяет, не пуста ли категория сообщений, если включён I18N.

public void validateMessageCategory ( )

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

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

Валидатор проверит, существует ли каталог, содержащий новый файл класса.

public void validateNewClass ( $attribute, $params )
$attribute	строка	Валидируемый атрибут
$params	массив	Параметры валидации

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

Валидирует выбор шаблона.

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

public void validateTemplate ( )