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

Returns the attribute labels.

Attribute labels are mainly used for display purpose. For example, given an attribute firstName, we can declare a label First Name which is more user-friendly and can be displayed to end users.

By default an attribute label is generated using generateAttributeLabel(). This method allows you to explicitly specify attribute labels.

Note, in order to inherit labels defined in the parent class, a child class needs to merge the parent labels with child labels using functions such as array_merge().

public array attributeLabels ( )
return	array	Attribute labels (name => label)

autoCompleteData() public method

Returns the list of auto complete values.

The array keys are the attribute names, and the array values are the corresponding auto complete values. Auto complete values can also be callable typed in order one want to make postponed data generation.

public array autoCompleteData ( )
return	array	The list of auto complete values

generate() public method

Generates the code based on the current user input and the specified code template files.

This is the main method that child classes should implement. Please refer to yii\gii\generators\controller\Generator::generate() as an example on how to implement this method.

public yii\gii\CodeFile[] generate ( )
return	yii\gii\CodeFile[]	A list of code files to be created.

generateClassName() protected method

Generates a class name from the specified table name.

protected string generateClassName ( $indexName )
$indexName	string	The table name (which may contain schema prefix)
return	string	The generated class name

generateIndexName() public method

Generates the table name by considering table prefix.

If $useIndexPrefix is false, the table name will be returned without change.

public string generateIndexName ( $indexName )
$indexName	string	The table name (which may contain schema prefix)
return	string	The generated table name

generateLabels() public method

Generates the attribute labels for the specified table.

public array generateLabels ( $table )
$table	yii\db\TableSchema	The table schema
return	array	The generated attribute labels (name => label)

generateRules() public method

Generates validation rules for the specified index.

public array generateRules ( $index )
$index	yii\sphinx\IndexSchema	The index schema
return	array	The generated validation rules

getDbConnection() protected method

protected yii\sphinx\Connection getDbConnection ( )
return	yii\sphinx\Connection	The Sphinx connection as specified by $db.

getDescription() public method

public string getDescription ( )
return	string	The detailed description of the generator.

getIndexNames() protected method

protected array getIndexNames ( )
return	array	The index names that match the pattern specified by $indexName.

getName() public method

public string getName ( )
return	string	Name of the code generator

hints() public method

Returns the list of hint messages.

The array keys are the attribute names, and the array values are the corresponding hint messages. Hint messages will be displayed to end users when they are filling the form for the generator.

public array hints ( )
return	array	The list of hint messages

requiredTemplates() public method

Returns a list of code template files that are required.

Derived classes usually should override this method if they require the existence of certain template files.

public array requiredTemplates ( )
return	array	List of code template files that are required. They should be file paths relative to $templatePath.

rules() public method

Returns the validation rules for attributes.

Validation rules are used by validate() to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

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

where

• attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
• validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
• on: optional, specifies the scenarios array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
• additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \yii\sphinx\gii\model\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of \yii\sphinx\gii\model\Validator::builtInValidators. Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // 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'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

Child classes should override this method like the following so that the parent rules are included:

return array_merge(parent::rules(), [
    ...rules for the child class...
]);

public array rules ( )
return	array	Validation rules

stickyAttributes() public method

Returns the list of sticky attributes.

A sticky attribute will remember its value and will initialize the attribute with this value when the generator is restarted.

public array stickyAttributes ( )
return	array	List of sticky attributes

validateDb() public method

Validates the $db attribute.

public void validateDb ( )

validateIndexName() public method

Validates the $indexName attribute.

public void validateIndexName ( )

validateModelClass() public method

Validates the $modelClass attribute.

public void validateModelClass ( )

validateNamespace() public method

Validates the $ns attribute.

public void validateNamespace ( )