Class yii\gii\console\GenerateController

All Classes | Properties | Methods | Events | Constants

Inheritance	yii\gii\console\GenerateController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Available since version	2.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

Property	Type	Description	Defined By
$action	yii\base\Action\|null	The action that is currently being executed.	yii\base\Controller
$color	boolean\|null	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
$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
$overwrite	boolean	Whether to overwrite all existing code files when in non-interactive mode.	yii\gii\console\GenerateController
$request	yii\base\Request\|array\|string	The request.	yii\base\Controller
$response	yii\base\Response\|array\|string	The response.	yii\base\Controller
$silentExitOnException	boolean\|null	If true - script finish with `ExitCode::OK` in case of exception.	yii\console\Controller

Public Methods

Hide inherited 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()		yii\base\Controller
__get()	{@inheritdoc}	yii\gii\console\GenerateController
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	{@inheritdoc}	yii\gii\console\GenerateController
__unset()	Sets a component property to be null.	yii\base\Component
actionIndex()		yii\gii\console\GenerateController
actions()	{@inheritdoc}	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()	{@inheritdoc}	yii\console\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()	{@inheritdoc}	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()	{@inheritdoc}	yii\gii\console\GenerateController
getActionHelp()	{@inheritdoc}	yii\gii\console\GenerateController
getActionHelpSummary()	{@inheritdoc}	yii\gii\console\GenerateController
getActionOptionsHelp()	{@inheritdoc}	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()	{@inheritdoc}	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()	{@inheritdoc}	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()	{@inheritdoc}	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

Method	Description	Defined By
bindInjectedParams()	Fills parameters based on types and names in action method signature.	yii\base\Controller
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

Event	Type	Description	Defined 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

Constant	Value	Description	Defined 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

Method Details

__get() public method

{@inheritdoc}

public void __get ( $name )
$name

__set() public method

{@inheritdoc}

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

actionIndex() public method

public void actionIndex ( )

actions() public method

{@inheritdoc}

public void actions ( )

createAction() public method

{@inheritdoc}

public void createAction ( $id )
$id

formatHint() protected method

protected void formatHint ( $hint )
$hint

getActionArgsHelp() public method

{@inheritdoc}

public void getActionArgsHelp ( $action )
$action

getActionHelp() public method

{@inheritdoc}

public void getActionHelp ( $action )
$action

getActionHelpSummary() public method

{@inheritdoc}

public void getActionHelpSummary ( $action )
$action

getActionOptionsHelp() public method

{@inheritdoc}

public void getActionOptionsHelp ( $action )
$action

getUniqueID() public method

{@inheritdoc}

public void getUniqueID ( )

init() public method

{@inheritdoc}

public void init ( )

options() public method

{@inheritdoc}

public void options ( $id )
$id