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

public  $baseClass = 'yii\db\ActiveRecord'

protected  $classNames = null

public  $db = 'db'

public string getDescription ( )

public  $generateLabelsFromComments = false

public  $generateQuery = false

public  $generateRelations = self::RELATIONS_ALL

public  $generateRelationsFromCurrentSchema = true

public  $modelClass = null

public string getName ( )

public  $ns = 'app\models'

public  $queryBaseClass = 'yii\db\ActiveQuery'

public  $queryClass = null

public  $queryNs = 'app\models'

public  $tableName = null

protected  $tableNames = null

public string getTablePrefix ( )

public  $useSchemaName = true

public  $useTablePrefix = false

addInverseRelations() защищённый метод (доступен начиная с версии 2.0.5)

Добавляет обратные связи

защищённый массив addInverseRelations ( $relations )
$relations	массив	Объявления связей
return	массив	Объявления связей, дополненные именами обратных связей

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

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

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

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

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

общедоступный массив attributeLabels ( )
return	массив	Метки атрибутов (имя => метка)

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

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

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

общедоступный массив autoCompleteData ( )
return	массив	Список значений автозаполнения

checkJunctionTable() защищённый метод

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

защищённый массив|булево checkJunctionTable ( $table )
$table
return	массив|булево	Все уникальные пары внешних ключей, если таблица является таблицей соединения, или false, если таблица не является таблицей соединения.

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

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

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

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

generateClassName() защищённый метод

Генерирует имя класса из указанного имени таблицы.

защищённый строка generateClassName ( $tableName, $useSchemaName = null )
$tableName	строка	Имя таблицы (которое может содержать префикс схемы)
$useSchemaName	булево	Включать ли имя схемы в имя класса, если оно присутствует
return	строка	Сгенерированное имя класса

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

Генерирует метки атрибутов для указанной таблицы.

общедоступный массив generateLabels ( $table )
$table	yii\db\TableSchema	Схема таблицы
return	массив	Сгенерированные метки атрибутов (имя => метка)

generateQueryClassName() защищённый метод

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

защищённый строка generateQueryClassName ( $modelClassName )
$modelClassName	строка	Имя класса модели
return	строка	Сгенерированное имя класса

generateRelationLink() защищённый метод

Генерирует параметр ссылки, используемый при генерации объявления связи.

защищённый строка generateRelationLink ( $refs )
$refs	массив	Ограничение ссылки
return	строка	Сгенерированный параметр ссылки.

generateRelationName() защищённый метод

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

защищённый строка generateRelationName ( $relations, $table, $key, $multiple )
$relations	массив	Связи, которые генерируются в данный момент.
$table	yii\db\TableSchema	Схема таблицы
$key	строка	Базовое имя, от которого может быть сгенерировано имя связи
$multiple	булево	Является ли это связью "многие-ко-многим"
return	строка	Имя связи

generateRelations() защищённый метод

защищённый массив generateRelations ( )
return	массив	Сгенерированные объявления связей

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

Генерирует правила валидации для указанной таблицы.

общедоступный массив generateRules ( $table )
$table	yii\db\TableSchema	Схема таблицы
return	массив	Сгенерированные правила валидации

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

Генерирует имя таблицы, учитывая префикс таблицы.

Если $useTablePrefix равно false, имя таблицы будет возвращено без изменений.

общедоступный строка generateTableName ( $tableName )
$tableName	строка	Имя таблицы (которое может содержать префикс схемы)
return	строка	Сгенерированное имя таблицы

getDbConnection() защищённый метод

защищённый yii\db\Connection getDbConnection ( )
return	yii\db\Connection	Подключение к базе данных, указанное в $db.

getDbDriverName() защищённый метод (доступен начиная с версии 2.0.6)

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

getDescription() public method

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

getName() public method

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

getSchemaNames() protected method (доступно с версии 2.0.5)

protected string[] getSchemaNames ( )
return	string[]	Все имена схем БД или массив с единственной пустой строкой.
throws	yii\base\NotSupportedException

getTableNames() protected method

protected array getTableNames ( )
return	array	Имена таблиц, соответствующие шаблону, указанному в $tableName.

getTablePrefix() public method (доступно с версии 2.0.5)

Возвращает свойство tablePrefix подключения к БД, как указано

См. также getDbConnection().

public string getTablePrefix ( )

hints() public method

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

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

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

isColumnAutoIncremental() protected method

Проверяет, является ли какой-либо из указанных столбцов автоинкрементируемым.

protected boolean isColumnAutoIncremental ( $table, $columns )
$table	yii\db\TableSchema	Схема таблицы
$columns	array	Столбцы для проверки свойства autoIncrement
return	boolean	Является ли какой-либо из указанных столбцов автоинкрементируемым.

isHasManyRelation() protected method (доступно с версии 2.0.5)

Определяет, является ли отношение отношением «один ко многим»

protected boolean isHasManyRelation ( $table, $fks )
$table	yii\db\TableSchema
$fks	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\model\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\model\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	Список неизменяемых атрибутов

validateDb() public method

Проверяет атрибут $db.

public void validateDb ( )

validateModelClass() public method

Проверяет атрибут $modelClass.

public void validateModelClass ( )

validateNamespace() public method

Проверяет имя пространства имён.

public void validateNamespace ( $attribute )
$attribute	string	Переменная пространства имён.

validateTableName() public method

Проверяет атрибут $tableName.

public void validateTableName ( )