CommandArgument类 参考

类 CommandArgument 继承关系图:

CommandArgument 的协作图:

Public 成员函数
	__construct (public string $name, public string $description='', string $type='string', public bool $required=false, public string $prompt='', public string $default='', public int $timeout=60, public int $error_prompt_policy=1)
	getTypeErrorPrompt ()
	getErrorQuitPrompt ()
Public 成员函数 继承自 AnnotationBase
	__toString ()
	on (\Closure|callable|string $method)
	getIterator ()
	isInGroup (string $name)
	addGroup (string $name)
	getGroups ()

成员变量
string	$type = 'string'
成员变量 继承自 AnnotationBase
Closure string array	$method = ''
	$class = ''
array	$group = []

Protected 成员函数
	fixTypeName (string $type)

详细描述

Class CommandArgument @Annotation @NamedArgumentConstructor() @Target("ALL")

构造及析构函数说明

__construct()

__construct	(	public string	$name,
		public string	$description = '',
		string	$type = 'string',
		public bool	$required = false,
		public string	$prompt = '',
		public string	$default = '',
		public int	$timeout = 60,
		public int	$error_prompt_policy = 1
	)

参数

string	$name	参数名称（可以是中文）
string	$description	参数描述（默认为空）
bool	$required	参数是否必需，如果是必需，为true（默认为false）
string	$prompt	当参数为必需且缺失时，返回给用户的提示输入的消息（默认为"请输入$name"）
string	$default	当required为false时，未匹配到参数将自动使用default值（默认为空）
int	$timeout	prompt超时时间（默认为60秒）

异常

InvalidArgumentException|ZMKnownException

参数

$name

@Required()

函数调用图:

成员函数说明

fixTypeName()

fixTypeName ( string  $type )

protected

异常

ZMKnownException

函数调用图:

getErrorQuitPrompt()

getErrorQuitPrompt

(

)

getTypeErrorPrompt()

getTypeErrorPrompt

(

)

结构体成员变量说明

$type

string $type = 'string'

---

该类的文档由以下文件生成:

• src/ZM/Annotation/OneBot/CommandArgument.php