Class yii\gii\console\GenerateController

Inheritanceyii\gii\console\GenerateController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2-gii/blob/master/console/GenerateController.php

This is the command line version of Gii - a code generator.

You can use this command to generate models, controllers, etc. For example, to generate an ActiveRecord model based on a DB table, you can run:

$ ./yii gii/model --tableName=city --modelClass=City

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$action yii\base\Action The action that is currently being executed. yii\base\Controller
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$color boolean Whether to enable ANSI color in the output. yii\console\Controller
$defaultAction string The ID of the action that is used when the action ID is not specified in the request. yii\base\Controller
$generators array A list of the available code generators yii\gii\console\GenerateController
$help boolean Whether to display help information about current command. yii\console\Controller
$helpSummary string yii\console\Controller
$id string The ID of this controller. yii\base\Controller
$interactive boolean Whether to run the command interactively. yii\console\Controller
$layout null|string|false The name of the layout to be applied to this controller's views. yii\base\Controller
$module yii\gii\Module yii\gii\console\GenerateController
$modules yii\base\Module[] All ancestor modules that this controller is located within. yii\base\Controller
$overwrite boolean Whether to overwrite all existing code files when in non-interactive mode. yii\gii\console\GenerateController
$passedOptionValues array The properties corresponding to the passed options yii\console\Controller
$passedOptions array The names of the options passed during execution yii\console\Controller
$route string The route (module ID, controller ID and action ID) of the current request. yii\base\Controller
$uniqueID yii\gii\console\GenerateController
$uniqueId string The controller ID that is prefixed with the module ID (if any). yii\base\Controller
$view yii\base\View|yii\web\View The view object that can be used to render views or view files. yii\base\Controller
$viewPath string The directory containing the view files for this controller. yii\base\Controller

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() yii\base\Controller
__get() Returns the value of a component property. yii\gii\console\GenerateController
__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\gii\console\GenerateController
__unset() Sets a component property to be null. yii\base\Component
actionIndex() yii\gii\console\GenerateController
actions() Declares external actions for the controller. yii\gii\console\GenerateController
afterAction() This method is invoked right after an action is executed. yii\base\Controller
ansiFormat() Formats a string with ANSI codes. yii\console\Controller
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeAction() This method is invoked right before an action is executed. yii\base\Controller
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
bindActionParams() Binds the parameters to the action. yii\console\Controller
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
confirm() Asks user to confirm by typing y or n. yii\console\Controller
createAction() Creates an action based on the given action ID. yii\gii\console\GenerateController
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
findLayoutFile() Finds the applicable layout file. yii\base\Controller
getActionArgsHelp() Returns the help information for the anonymous arguments for the action. yii\gii\console\GenerateController
getActionHelp() Returns the detailed help information for the specified action. yii\gii\console\GenerateController
getActionHelpSummary() Returns a one-line short summary describing the specified action. yii\gii\console\GenerateController
getActionOptionsHelp() Returns the help information for the options for the action. yii\gii\console\GenerateController
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getHelp() Returns help information for this controller. yii\console\Controller
getHelpSummary() Returns one-line short summary describing this controller. yii\console\Controller
getModules() Returns all ancestor modules of this controller. yii\base\Controller
getOptionValues() Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. yii\console\Controller
getPassedOptionValues() Returns the properties corresponding to the passed options. yii\console\Controller
getPassedOptions() Returns the names of valid options passed during execution. yii\console\Controller
getRoute() Returns the route of the current request. yii\base\Controller
getUniqueID() yii\gii\console\GenerateController
getUniqueId() Returns the unique ID of the controller. yii\base\Controller
getView() Returns the view object that can be used to render views or view files. yii\base\Controller
getViewPath() Returns the directory containing view files for this controller. yii\base\Controller
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
init() Initializes the object. yii\gii\console\GenerateController
isColorEnabled() Returns a value indicating whether ANSI color is enabled. yii\console\Controller
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
optionAliases() Returns option alias names. yii\console\Controller
options() Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. yii\gii\console\GenerateController
prompt() Prompts the user for input and validates it. yii\console\Controller
render() Renders a view and applies layout if available. yii\base\Controller
renderContent() Renders a static string by applying a layout. yii\base\Controller
renderFile() Renders a view file. yii\base\Controller
renderPartial() Renders a view without applying layout. yii\base\Controller
run() Runs a request specified in terms of a route. yii\base\Controller
runAction() Runs an action with the specified action ID and parameters. yii\console\Controller
select() Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. yii\console\Controller
setView() Sets the view object to be used by this controller. yii\base\Controller
setViewPath() Sets the directory that contains the view files. yii\base\Controller
stderr() Prints a string to STDERR. yii\console\Controller
stdout() Prints a string to STDOUT. yii\console\Controller
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
formatHint() yii\gii\console\GenerateController
getActionMethodReflection() yii\console\Controller
parseDocCommentDetail() Returns full description from the docblock. yii\console\Controller
parseDocCommentSummary() Returns the first line of docblock. yii\console\Controller
parseDocCommentTags() Parses the comment block into tags. yii\console\Controller

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised right after executing a controller action. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised right before executing a controller action. yii\base\Controller

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
EXIT_CODE_ERROR 1 Deprecated since 2.0.13. Use \yii\gii\console\ExitCode::UNSPECIFIED_ERROR instead. yii\console\Controller
EXIT_CODE_NORMAL 0 Deprecated since 2.0.13. Use \yii\gii\console\ExitCode::OK instead. yii\console\Controller

Property Details

$generators public property

A list of the available code generators

public array $generators = []
$module public property
public yii\gii\Module $module null
$overwrite public property

Whether to overwrite all existing code files when in non-interactive mode. Defaults to false, meaning none of the existing code files will be overwritten. This option is used only when --interactive=0.

public boolean $overwrite false
$uniqueID public read-only property
public void getUniqueID ( )

Method Details

__get() public method

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

__set() public method

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

actionIndex() public method

public void actionIndex ( )
actions() public method

Declares external actions for the controller.

This method is meant to be overwritten to declare external actions for the controller. It should return an array, with array keys being action IDs, and array values the corresponding action class names or action configuration arrays. For example,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() will be used later to create the requested action using the configuration provided here.

public void actions ( )
createAction() public method

Creates an action based on the given action ID.

The method first checks if the action ID has been declared in actions(). If so, it will use the configuration declared there to create the action object. If not, it will look for a controller method whose name is in the format of actionXyz where xyz is the action ID. If found, an yii\base\InlineAction representing that method will be created and returned.

public yii\base\Action|null createAction ( $id )
$id string

The action ID.

return yii\base\Action|null

The newly created action instance. Null if the ID doesn't resolve into any action.

formatHint() protected method

protected void formatHint ( $hint )
$hint
getActionArgsHelp() public method

Returns the help information for the anonymous arguments for the action.

The returned value should be an array. The keys are the argument names, and the values are the corresponding help information. Each value must be an array of the following structure:

  • required: boolean, whether this argument is required.
  • type: string, the PHP type of this argument.
  • default: string, the default value of this argument
  • comment: string, the comment of this argument

The default implementation will return the help information extracted from the doc-comment of the parameters corresponding to the action method.

public array getActionArgsHelp ( $action )
$action yii\base\Action
return array

The help information of the action arguments

getActionHelp() public method

Returns the detailed help information for the specified action.

public string getActionHelp ( $action )
$action yii\base\Action

Action to get help for

return string

The detailed help information for the specified action.

getActionHelpSummary() public method

Returns a one-line short summary describing the specified action.

public string getActionHelpSummary ( $action )
$action yii\base\Action

Action to get summary for

return string

A one-line short summary describing the specified action.

getActionOptionsHelp() public method

Returns the help information for the options for the action.

The returned value should be an array. The keys are the option names, and the values are the corresponding help information. Each value must be an array of the following structure:

  • type: string, the PHP type of this argument.
  • default: string, the default value of this argument
  • comment: string, the comment of this argument

The default implementation will return the help information extracted from the doc-comment of the properties corresponding to the action options.

public array getActionOptionsHelp ( $action )
$action yii\base\Action
return array

The help information of the action options

getUniqueID() public method

public void getUniqueID ( )
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 ( )
options() public method

Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.

Child classes may override this method to specify possible options.

Note that the values setting via options are not available until beforeAction() is being called.

public string[] options ( $id )
$id
return string[]

The names of the options valid for the action