parseDocCommentSummary() protected method Returns the first line of docblock. protected string parseDocCommentSummary ( $reflection )$reflection Reflector

parseDocCommentDetail() protected method Returns full description from the docblock. protected string parseDocCommentDetail ( $reflection )$reflection Reflector

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 array options ( $actionID )$actionID string The action id of the current request return array The names of the options valid for the action

optionAliases() public method (available since version 2.0.8) Returns option alias names. Child classes may override this method to specify alias options. See also \yii\console\options($actionID). public array optionAliases ( )return array The options alias names valid for the action where the keys is alias name for option and value is option name.

isColorEnabled() public method Returns a value indicating whether ANSI color is enabled. ANSI color is enabled only if $color is set true or is not set and the terminal supports ANSI color. public boolean isColorEnabled ( $stream = \STDOUT )$stream resource The stream to check. return boolean Whether to enable ANSI style in output.

getPassedOptionValues() public method Returns the properties corresponding to the passed options public array getPassedOptionValues ( )return array The properties corresponding to the passed options

getPassedOptions() public method Returns the names of valid options passed during execution. public array getPassedOptions ( )return array The names of the options passed during execution

getOptionValues() public method Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. public array getOptionValues ( $actionID )$actionID string The action id of the current request return array Properties corresponding to the options for the action

getHelpSummary() public method Returns one-line short summary describing this controller. You may override this method to return customized summary. The default implementation returns first line from the PHPDoc comment. public string getHelpSummary ( )

getHelp() public method Returns help information for this controller. You may override this method to return customized help. The default implementation returns help information retrieved from the PHPDoc comment. public string getHelp ( )