Class yii\gii\generators\controller\Generator
| Inheritance | yii\gii\generators\controller\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/controller/Generator.php |
This generator will generate a controller and one or a few action view files.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $actions | string | List of action IDs separated by commas or spaces | yii\gii\generators\controller\Generator |
| $baseClass | string | The base class of the controller | yii\gii\generators\controller\Generator |
| $controllerClass | string | The controller class name | yii\gii\generators\controller\Generator |
| $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 |
| $viewPath | string | The controller's view path | yii\gii\generators\controller\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\generators\controller\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() | {@inheritdoc} | yii\gii\generators\controller\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 |
| getActionIDs() | Normalizes $actions into an array of action IDs. | yii\gii\generators\controller\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 |
| getControllerFile() | yii\gii\generators\controller\Generator | |
| getControllerID() | yii\gii\generators\controller\Generator | |
| getControllerNamespace() | yii\gii\generators\controller\Generator | |
| getControllerSubPath() | This method will return sub path for controller if it is located in subdirectory of application controllers dir | yii\gii\generators\controller\Generator |
| getDescription() | {@inheritdoc} | yii\gii\generators\controller\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\controller\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 |
| getViewFile() | yii\gii\generators\controller\Generator | |
| 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\controller\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\controller\Generator |
| rules() | {@inheritdoc} | yii\gii\generators\controller\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\controller\Generator |
| successMessage() | {@inheritdoc} | yii\gii\generators\controller\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
List of action IDs separated by commas or spaces
The base class of the controller
The controller class name
The controller's view path
Method Details
{@inheritdoc}
| public void attributeLabels ( ) |
{@inheritdoc}
| public void generate ( ) |
Normalizes $actions into an array of action IDs.
| public array getActionIDs ( ) | ||
| return | array | An array of action IDs entered by the user |
|---|---|---|
| public string getControllerFile ( ) | ||
| return | string | The controller class file path |
|---|---|---|
| public string getControllerID ( ) | ||
| return | string | The controller ID |
|---|---|---|
| public string getControllerNamespace ( ) | ||
| return | string | The namespace of the controller class |
|---|---|---|
This method will return sub path for controller if it is located in subdirectory of application controllers dir
| public string getControllerSubPath ( ) | ||
| return | string | The controller sub path |
|---|---|---|
{@inheritdoc}
| public void getDescription ( ) |
{@inheritdoc}
| public void getName ( ) |
| public string getViewFile ( $action ) | ||
| $action | string | The action ID |
| return | string | The action view file path |
|---|---|---|
{@inheritdoc}
| public void hints ( ) |
{@inheritdoc}
| public void requiredTemplates ( ) |
{@inheritdoc}
| public void rules ( ) |
{@inheritdoc}
| public void stickyAttributes ( ) |
{@inheritdoc}
| public void successMessage ( ) |