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

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

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)

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

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

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.

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

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

$useIndexPrefix public property public $useIndexPrefix = false