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

public  $baseClass = 'yii\sphinx\ActiveRecord'

public  $db = 'sphinx'

public string getDescription ( )

public  $indexName = null

public  $modelClass = null

public string getName ( )

public  $ns = 'app\models'

public  $useIndexPrefix = false

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 ( $indexName )
$indexName	string	Имя таблицы (которое может содержать префикс схемы)
return	string	Сгенерированное имя класса

generateIndexName() public method

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

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

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

generateLabels() public method

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

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

generateRules() public method

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

public array generateRules ( $index )
$index	yii\sphinx\IndexSchema	Схема индекса
return	array	Сгенерированные правила валидации

getDbConnection() protected method

protected yii\sphinx\Connection getDbConnection ( )
return	yii\sphinx\Connection	Подключение к Sphinx, заданное $db.

getDescription() public method

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

getIndexNames() protected method

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

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\sphinx\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\sphinx\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 массив rules ( )
return	массив	Правила валидации

stickyAttributes() public метод

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

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

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

validateDb() public метод

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

public void validateDb ( )

validateIndexName() public метод

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

public void validateIndexName ( )

validateModelClass() public метод

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

public void validateModelClass ( )

validateNamespace() public метод

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

public void validateNamespace ( )