Frames No frames

Summary: Field | Method | Constr Detail: Field | Method | Constr

think\console\input\Option

library\think\console\input\Option.php at line 14

Class Option

Option

public class Option

Constant Summary
final static int	VALUE_IS_ARRAY
final static int	VALUE_NONE
final static int	VALUE_OPTIONAL
final static int	VALUE_REQUIRED

Constructor Summary
void	__construct(string name, string\|array shortcut, int mode, string description, mixed default) 构造方法

Method Summary
string	getShortcut() 获取短名称
string	getName() 获取选项名
bool	acceptValue() 是否可以设置值
bool	isValueRequired() 是否必须
bool	isValueOptional() 是否可选
bool	isArray() 选项值是否接受数组
void	setDefault(mixed default) 设置默认值
mixed	getDefault() 获取默认值
string	getDescription() 获取描述文字
bool	equals(Option option) 检查所给选项是否是当前这个

Constant Detail

library\think\console\input\Option.php at line 20

VALUE_IS_ARRAY

public final static int VALUE_IS_ARRAY = 8

library\think\console\input\Option.php at line 17

VALUE_NONE

public final static int VALUE_NONE = 1

library\think\console\input\Option.php at line 19

VALUE_OPTIONAL

public final static int VALUE_OPTIONAL = 4

library\think\console\input\Option.php at line 18

VALUE_REQUIRED

public final static int VALUE_REQUIRED = 2

Constructor Detail

library\think\console\input\Option.php at line 37

__construct

public void __construct(string name, string|array shortcut, int mode, string description, mixed default)

构造方法

Parameters:: name - 选项名; shortcut - 短名称,多个用|隔开或者使用数组; mode - 选项类型(可选类型为 self::VALUE_*); description - 描述; default - 默认值 (类型为 self::VALUE_REQUIRED 或者 self::VALUE_NONE 的时候必须为null)
Throws:: \InvalidArgumentException

Method Detail

library\think\console\input\Option.php at line 86

getShortcut

public string getShortcut()

获取短名称

library\think\console\input\Option.php at line 95

getName

public string getName()

获取选项名

library\think\console\input\Option.php at line 104

acceptValue

public bool acceptValue()

是否可以设置值

Returns:: 类型不是 self::VALUE_NONE 的时候返回true,其他均返回false

library\think\console\input\Option.php at line 113

isValueRequired

public bool isValueRequired()

是否必须

Returns:: 类型是 self::VALUE_REQUIRED 的时候返回true,其他均返回false

library\think\console\input\Option.php at line 122

isValueOptional

public bool isValueOptional()

是否可选

Returns:: 类型是 self::VALUE_OPTIONAL 的时候返回true,其他均返回false

library\think\console\input\Option.php at line 131

isArray

public bool isArray()

选项值是否接受数组

Returns:: 类型是 self::VALUE_IS_ARRAY 的时候返回true,其他均返回false

library\think\console\input\Option.php at line 141

setDefault

public void setDefault(mixed default)

设置默认值

Parameters:: default - 默认值
Throws:: \LogicException

library\think\console\input\Option.php at line 162

getDefault

public mixed getDefault()

获取默认值

library\think\console\input\Option.php at line 171

getDescription

public string getDescription()

获取描述文字

library\think\console\input\Option.php at line 181

equals

public bool equals(Option option)

检查所给选项是否是当前这个

Frames No frames

Summary: Field | Method | Constr Detail: Field | Method | Constr