Class yii\gii\generators\model\Generator

Inheritanceyii\gii\generators\model\Generator » yii\gii\Generator » yii\base\Model » yii\base\Component » yii\base\Object
ImplementsArrayAccess, IteratorAggregate, yii\base\Arrayable, yii\base\Configurable
Uses Traitsyii\base\ArrayableTrait
Available since version2.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

PropertyTypeDescriptionDefined By
$activeValidators yii\validators\Validator[] The validators applicable to the current $scenario. yii\base\Model
$attributes array Attribute values (name => value). yii\base\Model
$baseClass yii\gii\generators\model\Generator
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$db yii\gii\generators\model\Generator
$description string The detailed description of the generator. yii\gii\generators\model\Generator
$enableI18N boolean Whether the strings will be generated using Yii::t() or normal strings. yii\gii\Generator
$errors array Errors for all attributes or the specified attribute. yii\base\Model
$firstErrors array The first errors. yii\base\Model
$generateLabelsFromComments yii\gii\generators\model\Generator
$generateQuery yii\gii\generators\model\Generator
$generateRelations yii\gii\generators\model\Generator
$generateRelationsFromCurrentSchema yii\gii\generators\model\Generator
$iterator ArrayIterator An iterator for traversing the items in the list. yii\base\Model
$messageCategory string The message category used by Yii::t() when $enableI18N is true. yii\gii\Generator
$modelClass yii\gii\generators\model\Generator
$name string Name of the code generator 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
$scenario string The scenario that this model is in. yii\base\Model
$stickyDataFile string The file path that stores the sticky attribute values. yii\gii\Generator
$tableName yii\gii\generators\model\Generator
$tablePrefix string yii\gii\generators\model\Generator
$template string The name of the code template that the user has selected. yii\gii\Generator
$templatePath string The root path of the template files that are currently being used. 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
$validators ArrayObject|yii\validators\Validator[] All the validators declared in the model. yii\base\Model

Public Methods

Hide inherited methods

MethodDescriptionDefined 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\Object
__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() Returns the attribute labels. yii\gii\generators\model\Generator
attributes() Returns the list of attribute names. yii\base\Model
autoCompleteData() Returns the list of auto complete values. 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\Object
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() Generates the code based on the current user input and the specified code template files. 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
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 $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() yii\gii\generators\model\Generator
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() 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() Returns the list of hint messages. yii\gii\generators\model\Generator
init() Initializes the object. yii\base\Object
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() Returns a list of code template files that are required. yii\gii\generators\model\Generator
rules() Returns the validation rules for attributes. 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() 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
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

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

EventTypeDescriptionDefined 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

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
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'
$description public read-only property

The detailed description of the generator.

$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
$name public read-only property

Name of the code generator

public string getName ( )
$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
$tablePrefix public read-only property
$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

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

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)

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 getDbDriverName ( )
return string

Driver name of db connection.

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 $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\gii\generators\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\gii\generators\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 ( )
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 ( )