Class yii\gii\generators\model\Generator

All Classes | Properties | Methods | Events | Constants

Inheritance	yii\gii\generators\model\Generator » yii\gii\Generator » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements	ArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses Traits	yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2-gii/blob/master/generators/model/Generator.php

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

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$baseClass			yii\gii\generators\model\Generator
$db			yii\gii\generators\model\Generator
$enableI18N	boolean	Whether the strings will be generated using `Yii::t()` or normal strings.	yii\gii\Generator
$generateJunctionRelationMode			yii\gii\generators\model\Generator
$generateLabelsFromComments			yii\gii\generators\model\Generator
$generateQuery			yii\gii\generators\model\Generator
$generateRelations			yii\gii\generators\model\Generator
$generateRelationsFromCurrentSchema			yii\gii\generators\model\Generator
$messageCategory	string	The message category used by `Yii::t()` when `$enableI18N` is `true`.	yii\gii\Generator
$modelClass			yii\gii\generators\model\Generator
$ns			yii\gii\generators\model\Generator
$queryBaseClass			yii\gii\generators\model\Generator
$queryClass			yii\gii\generators\model\Generator
$queryNs			yii\gii\generators\model\Generator
$singularize			yii\gii\generators\model\Generator
$standardizeCapitals			yii\gii\generators\model\Generator
$tableName			yii\gii\generators\model\Generator
$template	string	The name of the code template that the user has selected.	yii\gii\Generator
$templates	array	A list of available code templates.	yii\gii\Generator
$useSchemaName			yii\gii\generators\model\Generator
$useTablePrefix			yii\gii\generators\model\Generator

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$classNames			yii\gii\generators\model\Generator
$tableNames			yii\gii\generators\model\Generator

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	Constructor.	yii\base\BaseObject
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
activeAttributes()	Returns the attribute names that are subject to validation in the current scenario.	yii\base\Model
addError()	Adds a new error to the specified attribute.	yii\base\Model
addErrors()	Adds a list of errors.	yii\base\Model
afterValidate()	This method is invoked after validation ends.	yii\base\Model
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
attributeHints()	Returns the attribute hints.	yii\base\Model
attributeLabels()	{@inheritdoc}	yii\gii\generators\model\Generator
attributes()	Returns the list of attribute names.	yii\base\Model
autoCompleteData()	{@inheritdoc}	yii\gii\generators\model\Generator
beforeValidate()	This method is invoked before validation starts.	yii\base\Model
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
clearErrors()	Removes errors for all attributes or a single attribute.	yii\base\Model
createValidators()	Creates validator objects based on the validation rules specified in rules().	yii\base\Model
defaultTemplate()	Returns the root path to the default code template files.	yii\gii\Generator
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
extraFields()	Returns the list of fields that can be expanded further and returned by toArray().	yii\base\ArrayableTrait
fields()	Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.	yii\base\ArrayableTrait
formName()	Returns the form name that this model class should use.	yii\base\Model
formView()	Returns the view file for the input form of the generator.	yii\gii\Generator
generate()	{@inheritdoc}	yii\gii\generators\model\Generator
generateAttributeLabel()	Generates a user friendly attribute label based on the give attribute name.	yii\base\Model
generateLabels()	Generates the attribute labels for the specified table.	yii\gii\generators\model\Generator
generateRelationsClassHints()	Generates the relation class hints for the relation methods	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
getActiveValidators()	Returns the validators applicable to the current \yii\base\scenario.	yii\base\Model
getAttributeHint()	Returns the text hint for the specified attribute.	yii\base\Model
getAttributeLabel()	Returns the text label for the specified attribute.	yii\base\Model
getAttributes()	Returns attribute values.	yii\base\Model
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getDescription()	{@inheritdoc}	yii\gii\generators\model\Generator
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.	yii\base\Model
getErrors()	Returns the errors for all attributes or a single attribute.	yii\base\Model
getFirstError()	Returns the first error of the specified attribute.	yii\base\Model
getFirstErrors()	Returns the first error of every attribute in the model.	yii\base\Model
getIterator()	Returns an iterator for traversing the attributes in the model.	yii\base\Model
getName()	{@inheritdoc}	yii\gii\generators\model\Generator
getScenario()	Returns the scenario that this model is used in.	yii\base\Model
getStickyDataFile()		yii\gii\Generator
getTablePrefix()	Returns the `tablePrefix` property of the DB connection as specified	yii\gii\generators\model\Generator
getTemplatePath()		yii\gii\Generator
getValidators()	Returns all the validators declared in rules().	yii\base\Model
hasErrors()	Returns a value indicating whether there is any validation error.	yii\base\Model
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
hints()	{@inheritdoc}	yii\gii\generators\model\Generator
init()	{@inheritdoc}	yii\gii\Generator
instance()	Returns static class instance, which can be used to obtain meta information.	yii\base\StaticInstanceTrait
isAttributeActive()	Returns a value indicating whether the attribute is active in the current scenario.	yii\base\Model
isAttributeRequired()	Returns a value indicating whether the attribute is required.	yii\base\Model
isAttributeSafe()	Returns a value indicating whether the attribute is safe for massive assignments.	yii\base\Model
isReservedKeyword()		yii\gii\Generator
load()	Populates the model with input data.	yii\base\Model
loadMultiple()	Populates a set of models with the data from end user.	yii\base\Model
loadStickyAttributes()	Loads sticky attributes from an internal file and populates them into the generator.	yii\gii\Generator
off()	Detaches an existing event handler from this component.	yii\base\Component
offsetExists()	Returns whether there is an element at the specified offset.	yii\base\Model
offsetGet()	Returns the element at the specified offset.	yii\base\Model
offsetSet()	Sets the element at the specified offset.	yii\base\Model
offsetUnset()	Sets the element value at the specified offset to null.	yii\base\Model
on()	Attaches an event handler to an event.	yii\base\Component
onUnsafeAttribute()	This method is invoked when an unsafe attribute is being massively assigned.	yii\base\Model
render()	Generates code using the specified code template and parameters.	yii\gii\Generator
requiredTemplates()	{@inheritdoc}	yii\gii\generators\model\Generator
rules()	{@inheritdoc}	yii\gii\generators\model\Generator
safeAttributes()	Returns the attribute names that are safe to be massively assigned in the current scenario.	yii\base\Model
save()	Saves the generated code into files.	yii\gii\Generator
saveStickyAttributes()	Saves sticky attributes into an internal file.	yii\gii\Generator
scenarios()	Returns a list of scenarios and the corresponding active attributes.	yii\base\Model
setAttributes()	Sets the attribute values in a massive way.	yii\base\Model
setScenario()	Sets the scenario for the model.	yii\base\Model
stickyAttributes()	{@inheritdoc}	yii\gii\generators\model\Generator
successMessage()	Returns the message to be displayed when the newly generated code is saved successfully.	yii\gii\Generator
toArray()	Converts the model into an array.	yii\base\ArrayableTrait
trigger()	Triggers an event.	yii\base\Component
validate()	Performs the data validation.	yii\base\Model
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
validateMultiple()	Validates multiple models.	yii\base\Model
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

Method	Description	Defined 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
extractFieldsFor()	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".	yii\base\ArrayableTrait
extractRootFields()	Extracts the root field names from nested fields.	yii\base\ArrayableTrait
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
resolveFields()	Determines which fields can be returned by toArray().	yii\base\ArrayableTrait

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_VALIDATE	yii\base\Event	An event raised at the end of validate()	yii\base\Model
EVENT_BEFORE_VALIDATE	yii\base\ModelEvent	An event raised at the beginning of validate().	yii\base\Model

Constants

Hide inherited constants

Constant	Value	Description	Defined By
JUNCTION_RELATION_VIA_MODEL	'model'		yii\gii\generators\model\Generator
JUNCTION_RELATION_VIA_TABLE	'table'		yii\gii\generators\model\Generator
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
SCENARIO_DEFAULT	'default'	The name of the default scenario.	yii\base\Model

Property Details

$baseClass public property

public $baseClass = 'yii\db\ActiveRecord'

$classNames protected property

protected $classNames = null

$db public property

public $db = 'db'

$generateJunctionRelationMode public property

public $generateJunctionRelationMode = self::JUNCTION_RELATION_VIA_TABLE

$generateLabelsFromComments public property

public $generateLabelsFromComments = false

$generateQuery public property

public $generateQuery = false

$generateRelations public property

public $generateRelations = self::RELATIONS_ALL

$generateRelationsFromCurrentSchema public property

public $generateRelationsFromCurrentSchema = true

$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'

$singularize public property

public $singularize = false

$standardizeCapitals public property

public $standardizeCapitals = false

$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

{@inheritdoc}

public void attributeLabels ( )

autoCompleteData() public method

{@inheritdoc}

public void autoCompleteData ( )

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

{@inheritdoc}

public void generate ( )

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

generateRelationsClassHints() public method (available since version 2.1.4)

Generates the relation class hints for the relation methods

public array generateRelationsClassHints ( $relations, $generateQuery )
$relations	array	The relation array for single table
$generateQuery	boolean	Generates ActiveQuery class (for ActiveQuery namespace available)

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

{@inheritdoc}

public void getDescription ( )

getName() public method

{@inheritdoc}

public void getName ( )

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

public void validateNamespace ( $attribute )
$attribute	string	Namespace variable.

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.

protected boolean isHasManyRelation ( $table, $fks )
$table	yii\db\TableSchema
$fks	array