Abstract Class yii\gii\Generator
This is the base class for all generator classes.
A generator instance is responsible for taking user inputs, validating them, and using them to generate the corresponding code based on a set of code template files.
A generator class typically needs to implement the following methods:
- getName(): returns the name of the generator
- getDescription(): returns the detailed description of the generator
- generate(): generates the code based on the current user input and the specified code template files. This is the place where main code generation code resides.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $enableI18N | boolean | Whether the strings will be generated using Yii::t() or normal strings. |
yii\gii\Generator |
| $messageCategory | string | The message category used by Yii::t() when $enableI18N is true. |
yii\gii\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 |
Public 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\Generator |
| attributes() | Returns the list of attribute names. | yii\base\Model |
| autoCompleteData() | Returns the list of auto complete values. | yii\gii\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() | Generates the code based on the current user input and the specified code template files. | yii\gii\Generator |
| generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. | yii\base\Model |
| generateString() | Generates a string depending on enableI18N property | yii\gii\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() | yii\gii\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() | yii\gii\Generator | |
| getScenario() | Returns the scenario that this model is used in. | yii\base\Model |
| getStickyDataFile() | yii\gii\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\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() | Returns a list of code template files that are required. | yii\gii\Generator |
| rules() | {@inheritdoc} | yii\gii\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\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 |
| validateMessageCategory() | Checks if message category is not empty when I18N is enabled. | yii\gii\Generator |
| validateMultiple() | Validates multiple models. | yii\base\Model |
| validateNewClass() | An inline validator that checks if the attribute value refers to a valid namespaced class name. | yii\gii\Generator |
| validateTemplate() | Validates the template selection. | yii\gii\Generator |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| 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 |
| resolveFields() | Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait |
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
| Constant | Value | Description | Defined By |
|---|---|---|---|
| SCENARIO_DEFAULT | 'default' | The name of the default scenario. | yii\base\Model |
Property Details
Whether the strings will be generated using Yii::t() or normal strings.
The message category used by Yii::t() when $enableI18N is true.
Defaults to app.
The name of the code template that the user has selected. The value of this property is internally managed by this class.
A list of available code templates. The array keys are the template names, and the array values are the corresponding template paths or path aliases.
Method Details
{@inheritdoc}
| public void attributeLabels ( ) |
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 |
|---|---|---|
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. |
|---|---|---|
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. |
|---|---|---|
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. |
|---|---|---|
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 |
| public string getDescription ( ) | ||
| return | string | The detailed description of the generator. |
|---|---|---|
| public abstract string getName ( ) | ||
| return | string | Name of the code generator |
|---|---|---|
| public string getStickyDataFile ( ) | ||
| return | string | The file path that stores the sticky attribute values. |
|---|---|---|
| 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 |
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 |
|---|---|---|
{@inheritdoc}
| public void init ( ) |
| public boolean isReservedKeyword ( $value ) | ||
| $value | string | The attribute to be validated |
| return | boolean | Whether the value is a reserved PHP keyword. |
|---|---|---|
Loads sticky attributes from an internal file and populates them into the generator.
| public void loadStickyAttributes ( ) |
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 \yii\gii\templatePath. |
| $params | array | List of parameters to be passed to the template file. |
| return | string | The generated code |
|---|---|---|
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\templatePath. |
|---|---|---|
{@inheritdoc}
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 ( ) |
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. |
|---|---|---|
Saves sticky attributes into an internal file.
| public void saveStickyAttributes ( ) |
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 |
|---|---|---|
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. |
|---|---|---|
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 |
Checks if message category is not empty when I18N is enabled.
| public void validateMessageCategory ( ) |
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 |
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 ( ) |