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

public  $attributeList = null

public  $baseClass = 'yii\mongodb\ActiveRecord'

public  $collectionName = null

public  $databaseName = null

public  $db = 'mongodb'

public string getDescription ( )

public  $modelClass = null

public string getName ( )

public  $ns = 'app\models'

attributeLabels() public method

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

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

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

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

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

autoCompleteData() public method

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

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

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

generate() public method

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

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

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

generateClassName() protected method

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

protected string generateClassName ( $collectionName )
$collectionName	string	Имя коллекции (которое может содержать префикс схемы)
return	string	Сгенерированное имя класса

generateLabels() public method

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

public array generateLabels ( $attributes )
$attributes	array	Список атрибутов
return	array	Сгенерированные метки атрибутов (имя => метка)

generateRules() public method

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

public array generateRules ( $attributes )
$attributes	array	Список атрибутов
return	array	Сгенерированные правила валидации

getDbConnection() protected method

protected yii\mongodb\Connection getDbConnection ( )
return	yii\mongodb\Connection	Подключение к БД, заданное параметром $db.

getDescription() public method

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

getName() public method

public string getName ( )
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\mongodb\gii\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\mongodb\gii\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	Список вязких атрибутов

validateCollectionName() public method

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

public void validateCollectionName ( )

validateDb() public method

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

public void validateDb ( )

validateModelClass() public method

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

public void validateModelClass ( )

validateNamespace() public method

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

public void validateNamespace ( )