• 홈
• yii
• console
• controllers
• HelpController

PHP 클래스 yii\console\controllers\HelpController

This command displays the available command list in the application or the detailed instructions about using a specific command. This command can be used as follows on command line: yii help [command name] In the above, if the command name is not provided, all available commands will be displayed. 파일 보기 프로젝트 열기: yiisoft/yii2 1 사용 예제들

공개 메소드들

메소드	설명
actionIndex ( string $command = null ) : integer	Displays available commands or the detailed information about a particular command.
getActions ( Controller $controller ) : array	Returns all available actions of the specified controller.
getCommands ( ) : array	Returns all available command names.

보호된 메소드들

메소드	설명
formatOptionAliases ( Controller $controller, string $option ) : string
formatOptionHelp ( string $name, boolean $required, string $type, mixed $defaultValue, string $comment ) : string	Generates a well-formed string for an argument or option.
getCommandDescriptions ( ) : array	Returns an array of commands an their descriptions.
getCommandHelp ( Controller $controller )	Displays the overall information of the command.
getDefaultHelp ( )	Displays all available commands.
getDefaultHelpHeader ( ) : string	Return a default help header.
getModuleCommands ( Module $module ) : array	Returns available commands of a specified module.
getScriptName ( ) : string
getSubCommandHelp ( Controller $controller, string $actionID )	Displays the detailed information of a command action.
validateControllerClass ( string $controllerClass ) : boolean	Validates if the given class is a valid console controller class.

메소드 상세