public string getDescription ( )

public boolean $enableI18N = false

public string $messageCategory = 'app'

public abstract string getName ( )

public string getStickyDataFile ( )

public string $template = 'default'

public string getTemplatePath ( )

public array $templates = []

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

defaultTemplate() public method

Returns the root path to the default code template files.

The default implementation will return the "templates" subdirectory of the directory containing the generator class file.

public string defaultTemplate ( )
return	string	The root path to the default code template files.

formView() public method

Returns the view file for the input form of the generator.

The default implementation will return the "form.php" file under the directory that contains the generator class file.

public string formView ( )
return	string	The view file for the input form of the generator.

generate() public abstract 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 abstract yii\gii\CodeFile[] generate ( )
return	yii\gii\CodeFile[]	A list of code files to be created.

generateString() public method

Generates a string depending on enableI18N property

public string generateString ( $string = '', $placeholders = [] )
$string	string	The text be generated
$placeholders	array	The placeholders to use by Yii::t()

getDescription() public method

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

getName() public abstract method

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

getStickyDataFile() public method

public string getStickyDataFile ( )
return	string	The file path that stores the sticky attribute values.

getTemplatePath() public method

public string getTemplatePath ( )
return	string	The root path of the template files that are currently being used.
throws	yii\base\InvalidConfigException	if $template is invalid

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

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

isReservedKeyword() public method

public boolean isReservedKeyword ( $value )
$value	string	The attribute to be validated
return	boolean	Whether the value is a reserved PHP keyword.

loadStickyAttributes() public method

Loads sticky attributes from an internal file and populates them into the generator.

public void loadStickyAttributes ( )

render() public method

Generates code using the specified code template and parameters.

Note that the code template will be used as a PHP file.

public string render ( $template, $params = [] )
$template	string	The code template file. This must be specified as a file path relative to $templatePath.
$params	array	List of parameters to be passed to the template file.
return	string	The generated code

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

save() public method

Saves the generated code into files.

public boolean save ( $files, $answers, &$results )
$files	yii\gii\CodeFile[]	The code files to be saved
$answers	array
$results	string	This parameter receives a value from this method indicating the log messages generated while saving the code files.
return	boolean	Whether files are successfully saved without any error.

saveStickyAttributes() public method

Saves sticky attributes into an internal file.

public void saveStickyAttributes ( )

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

successMessage() public method

Returns the message to be displayed when the newly generated code is saved successfully.

Child classes may override this method to customize the message.

public string successMessage ( )
return	string	The message to be displayed when the newly generated code is saved successfully.

validateClass() public method

An inline validator that checks if the attribute value refers to an existing class name.

If the extends option is specified, it will also check if the class is a child class of the class represented by the extends option.

public void validateClass ( $attribute, $params )
$attribute	string	The attribute being validated
$params	array	The validation options

validateMessageCategory() public method

Checks if message category is not empty when I18N is enabled.

public void validateMessageCategory ( )

validateNewClass() public method

An inline validator that checks if the attribute value refers to a valid namespaced class name.

The validator will check if the directory containing the new class file exist or not.

public void validateNewClass ( $attribute, $params )
$attribute	string	The attribute being validated
$params	array	The validation options

validateTemplate() public method

Validates the template selection.

This method validates whether the user selects an existing template and the template contains all required template files as specified in requiredTemplates().

public void validateTemplate ( )