Properties

$name

$name : 

Type

$aliases

$aliases : 

Type

$definition

$definition : 

Type

$help

$help : 

Type

$description

$description : 

Type

$ignoreValidationErrors

$ignoreValidationErrors : 

Type

$consoleDefinitionMerged

$consoleDefinitionMerged : 

Type

$consoleDefinitionMergedWithArgs

$consoleDefinitionMergedWithArgs : 

Type

$code

$code : 

Type

$synopsis

$synopsis : 

Type

$usages

$usages : 

Type

Methods

__construct()

__construct(string|null  $name = null) 

构造方法

Parameters

string|null $name

命令名称,如果没有设置则比如在 configure() 里设置

Throws

\LogicException

ignoreValidationErrors()

ignoreValidationErrors() 

忽略验证错误

setConsole()

setConsole(\think\Console  $console = null) 

设置控制台

Parameters

\think\Console $console

getConsole()

getConsole() : \think\Console

获取控制台

Returns

\think\Console

isEnabled()

isEnabled() : boolean

是否有效

Returns

boolean

setCode()

setCode(callable  $code) : \think\console\Command

设置执行代码

Parameters

callable $code

callable(InputInterface $input, OutputInterface $output)

Throws

\InvalidArgumentException

Returns

\think\console\Command

mergeConsoleDefinition()

mergeConsoleDefinition(boolean  $mergeArgs = true) 

合并参数定义

Parameters

boolean $mergeArgs

addArgument()

addArgument(string  $name, integer  $mode = null, string  $description = '', mixed  $default = null) : \think\console\Command

添加参数

Parameters

string $name

名称

integer $mode

类型

string $description

描述

mixed $default

默认值

Returns

\think\console\Command

addOption()

addOption(string  $name, string  $shortcut = null, integer  $mode = null, string  $description = '', mixed  $default = null) : \think\console\Command

添加选项

Parameters

string $name

选项名称

string $shortcut

别名

integer $mode

类型

string $description

描述

mixed $default

默认值

Returns

\think\console\Command

setName()

setName(string  $name) : \think\console\Command

设置指令名称

Parameters

string $name

Throws

\InvalidArgumentException

Returns

\think\console\Command

getName()

getName() : string

获取指令名称

Returns

string

setDescription()

setDescription(string  $description) : \think\console\Command

设置描述

Parameters

string $description

Returns

\think\console\Command

getDescription()

getDescription() : string

获取描述

Returns

string

setHelp()

setHelp(string  $help) : \think\console\Command

设置帮助信息

Parameters

string $help

Returns

\think\console\Command

getHelp()

getHelp() : string

获取帮助信息

Returns

string

getProcessedHelp()

getProcessedHelp() : string

描述信息

Returns

string

setAliases()

setAliases(array<mixed,string>  $aliases) : \think\console\Command

设置别名

Parameters

array<mixed,string> $aliases

Throws

\InvalidArgumentException

Returns

\think\console\Command

getAliases()

getAliases() : array

获取别名

Returns

array

getSynopsis()

getSynopsis(boolean  $short = false) : string

获取简介

Parameters

boolean $short

是否简单的

Returns

string

addUsage()

addUsage(string  $usage) : $this

添加用法介绍

Parameters

string $usage

Returns

$this

getUsages()

getUsages() : array

获取用法介绍

Returns

array

configure()

configure() 

配置指令

execute()

execute(\think\console\Input  $input, \think\console\Output  $output) : null|integer

执行指令

Parameters

\think\console\Input $input
\think\console\Output $output

Throws

\LogicException

Returns

null|integer

initialize()

initialize(\think\console\Input  $input, \think\console\Output  $output) 

初始化

Parameters

\think\console\Input $input

An InputInterface instance

\think\console\Output $output

An OutputInterface instance

validateName()

validateName(string  $name) 

验证指令名称

Parameters

string $name

Throws

\InvalidArgumentException