Class yii\gii\generators\model\Generator

Inheritanceyii\gii\generators\model\Generator » yii\gii\Generator » yii\base\Model
Available since version2.0

This generator will generate one or multiple ActiveRecord classes for the specified database table.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
attributeLabels() yii\gii\generators\model\Generator
autoCompleteData() Returns the list of auto complete values. yii\gii\generators\model\Generator
defaultTemplate() Returns the root path to the default code template files. yii\gii\Generator
formView() Returns the view file for the input form of the generator. yii\gii\Generator
generate() Generates the code based on the current user input and the specified code template files. yii\gii\generators\model\Generator
generateLabels() Generates the attribute labels for the specified table. yii\gii\generators\model\Generator
generateRules() Generates validation rules for the specified table. yii\gii\generators\model\Generator
generateString() Generates a string depending on enableI18N property yii\gii\Generator
generateTableName() Generates the table name by considering table prefix. yii\gii\generators\model\Generator
getDescription() yii\gii\generators\model\Generator
getName() yii\gii\generators\model\Generator
getStickyDataFile() yii\gii\Generator
getTablePrefix() Returns the tablePrefix property of the DB connection as specified yii\gii\generators\model\Generator
getTemplatePath() yii\gii\Generator
hints() Returns the list of hint messages. yii\gii\generators\model\Generator
init() yii\gii\Generator
isReservedKeyword() yii\gii\Generator
loadStickyAttributes() Loads sticky attributes from an internal file and populates them into the generator. yii\gii\Generator
render() Generates code using the specified code template and parameters. yii\gii\Generator
requiredTemplates() Returns a list of code template files that are required. yii\gii\generators\model\Generator
rules() yii\gii\generators\model\Generator
save() Saves the generated code into files. yii\gii\Generator
saveStickyAttributes() Saves sticky attributes into an internal file. yii\gii\Generator
stickyAttributes() Returns the list of sticky attributes. yii\gii\generators\model\Generator
successMessage() Returns the message to be displayed when the newly generated code is saved successfully. yii\gii\Generator
validateClass() An inline validator that checks if the attribute value refers to an existing class name. yii\gii\Generator
validateDb() Validates the $db attribute. yii\gii\generators\model\Generator
validateMessageCategory() Checks if message category is not empty when I18N is enabled. yii\gii\Generator
validateModelClass() Validates the $modelClass attribute. yii\gii\generators\model\Generator
validateNamespace() Validates the namespace. yii\gii\generators\model\Generator
validateNewClass() An inline validator that checks if the attribute value refers to a valid namespaced class name. yii\gii\Generator
validateTableName() Validates the $tableName attribute. yii\gii\generators\model\Generator
validateTemplate() Validates the template selection. yii\gii\Generator

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
addInverseRelations() Adds inverse relations yii\gii\generators\model\Generator
checkJunctionTable() Checks if the given table is a junction table, that is it has at least one pair of unique foreign keys. yii\gii\generators\model\Generator
generateClassName() Generates a class name from the specified table name. yii\gii\generators\model\Generator
generateProperties() Generates the properties for the specified table. yii\gii\generators\model\Generator
generateQueryClassName() Generates a query class name from the specified model class name. yii\gii\generators\model\Generator
generateRelationLink() Generates the link parameter to be used in generating the relation declaration. yii\gii\generators\model\Generator
generateRelationName() Generate a relation name for the specified table and a base name. yii\gii\generators\model\Generator
generateRelations() yii\gii\generators\model\Generator
getDbConnection() yii\gii\generators\model\Generator
getDbDriverName() yii\gii\generators\model\Generator
getSchemaNames() yii\gii\generators\model\Generator
getTableNames() yii\gii\generators\model\Generator
isColumnAutoIncremental() Checks if any of the specified columns is auto incremental. yii\gii\generators\model\Generator
isHasManyRelation() Determines if relation is of has many type yii\gii\generators\model\Generator

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
RELATIONS_ALL 'all' yii\gii\generators\model\Generator
RELATIONS_ALL_INVERSE 'all-inverse' yii\gii\generators\model\Generator
RELATIONS_NONE 'none' yii\gii\generators\model\Generator

Property Details

$baseClass public property
public $baseClass 'yii\db\ActiveRecord'
$classNames protected property
protected $classNames null
$db public property
public $db 'db'
$generateLabelsFromComments public property
$generateQuery public property
public $generateQuery false
$generateRelations public property
public $generateRelations self::RELATIONS_ALL
$generateRelationsFromCurrentSchema public property
$modelClass public property
public $modelClass null
$ns public property
public $ns 'app\models'
$queryBaseClass public property
public $queryBaseClass 'yii\db\ActiveQuery'
$queryClass public property
public $queryClass null
$queryNs public property
public $queryNs 'app\models'
$tableName public property
public $tableName null
$tableNames protected property
protected $tableNames null
$useSchemaName public property
public $useSchemaName true
$useTablePrefix public property
public $useTablePrefix false

Method Details

addInverseRelations() protected method (available since version 2.0.5)

Adds inverse relations

protected array addInverseRelations ( $relations )
$relations array

Relation declarations

return array

Relation declarations extended with inverse relation names

attributeLabels() public method

public void attributeLabels ( )
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

checkJunctionTable() protected method

Checks if the given table is a junction table, that is it has at least one pair of unique foreign keys.

protected array|boolean checkJunctionTable ( $table )
$table
return array|boolean

All unique foreign key pairs if the table is a junction table, or false if the table is not a junction table.

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 ( $tableName, $useSchemaName null )
$tableName string

The table name (which may contain schema prefix)

$useSchemaName boolean

Should schema name be included in the class name, if present

return string

The generated class 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)

generateProperties() protected method (available since version 2.0.6)

Generates the properties for the specified table.

protected array generateProperties ( $table )
$table \yii\db\TableSchema

The table schema

return array

The generated properties (property => type)

generateQueryClassName() protected method

Generates a query class name from the specified model class name.

protected string generateQueryClassName ( $modelClassName )
$modelClassName string

Model class name

return string

Generated class name

generateRelationLink() protected method

Generates the link parameter to be used in generating the relation declaration.

protected string generateRelationLink ( $refs )
$refs array

Reference constraint

return string

The generated link parameter.

generateRelationName() protected method

Generate a relation name for the specified table and a base name.

protected string generateRelationName ( $relations, $table, $key, $multiple )
$relations array

The relations being generated currently.

$table \yii\db\TableSchema

The table schema

$key string

A base name that the relation name may be generated from

$multiple boolean

Whether this is a has-many relation

return string

The relation name

generateRelations() protected method

protected array generateRelations ( )
return array

The generated relation declarations

generateRules() public method

Generates validation rules for the specified table.

public array generateRules ( $table )
$table \yii\db\TableSchema

The table schema

return array

The generated validation rules

generateTableName() public method

Generates the table name by considering table prefix.

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

public string generateTableName ( $tableName )
$tableName string

The table name (which may contain schema prefix)

return string

The generated table name

getDbConnection() protected method

protected \yii\db\Connection getDbConnection ( )
return \yii\db\Connection

The DB connection as specified by $db.

getDbDriverName() protected method (available since version 2.0.6)

protected string|null getDbDriverName ( )
return string|null

Driver name of db connection. In case db is not instance of \yii\db\Connection null will be returned.

getDescription() public method

public string getDescription ( )
return string

The detailed description of the generator.

getName() public method

public string getName ( )
return string

Name of the code generator

getSchemaNames() protected method (available since version 2.0.5)

protected string[] getSchemaNames ( )
return string[]

All db schema names or an array with a single empty string

throws \yii\base\NotSupportedException
getTableNames() protected method

protected array getTableNames ( )
return array

The table names that match the pattern specified by $tableName.

getTablePrefix() public method (available since version 2.0.5)

Returns the tablePrefix property of the DB connection as specified

See also getDbConnection().

public string getTablePrefix ( )
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

isColumnAutoIncremental() protected method

Checks if any of the specified columns is auto incremental.

protected boolean isColumnAutoIncremental ( $table, $columns )
$table \yii\db\TableSchema

The table schema

$columns array

Columns to check for autoIncrement property

return boolean

Whether any of the specified columns is auto incremental.

isHasManyRelation() protected method (available since version 2.0.5)

Determines if relation is of has many type

protected boolean isHasManyRelation ( $table, $fks )
$table \yii\db\TableSchema
$fks array
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 \yii\gii\generators\model\templatePath.

rules() public method

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 void 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 ( )
validateModelClass() public method

Validates the $modelClass attribute.

public void validateModelClass ( )
validateNamespace() public method

Validates the namespace.

public void validateNamespace ( $attribute )
$attribute string

Namespace variable.

validateTableName() public method

Validates the $tableName attribute.

public void validateTableName ( )