Gitee
\
app
index
controller
myadmin
controller
middleware
model
validate
Composer
Autoload
think
cache
driver
composer
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
db
builder
connector
exception
debug
exception
facade
log
driver
model
concern
relation
paginator
driver
process
exception
pipes
response
route
dispatch
session
driver
template
driver
taglib
validate
view
driver
traits
controller

\think\console\inputOption

Summary

Methods
Properties
Constants
__construct()
getShortcut()
getName()
acceptValue()
isValueRequired()
isValueOptional()
isArray()
setDefault()
getDefault()
getDescription()
equals()
No public properties found
VALUE_NONE
VALUE_REQUIRED
VALUE_OPTIONAL
VALUE_IS_ARRAY
No protected methods found
No protected properties found
N/A
No private methods found
$name
$shortcut
$mode
$default
$description
N/A

Constants

VALUE_NONE

VALUE_NONE = 1

VALUE_REQUIRED

VALUE_REQUIRED = 2

VALUE_OPTIONAL

VALUE_OPTIONAL = 4

VALUE_IS_ARRAY

VALUE_IS_ARRAY = 8

Properties

$name

$name

$shortcut

$shortcut

$mode

$mode

$default

$default

$description

$description

Methods

__construct()

__construct(string  $name, string|array  $shortcut = null, int  $mode = null, string  $description = '', mixed  $default = null) : mixed

构造方法

Parameters

string $name

选项名
string|array $shortcut

短名称,多个用|隔开或者使用数组
int $mode

选项类型(可选类型为 self::VALUE_*)
string $description

描述
mixed $default

默认值 (类型为 self::VALUE_REQUIRED 或者 self::VALUE_NONE 的时候必须为null)

Throws

\InvalidArgumentException

Returns

mixed —

getShortcut()

getShortcut() : string

获取短名称

Returns

string —

getName()

getName() : string

获取选项名

Returns

string —

acceptValue()

acceptValue() : bool

是否可以设置值

Returns

bool —

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

isValueRequired()

isValueRequired() : bool

是否必须

Returns

bool —

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

isValueOptional()

isValueOptional() : bool

是否可选

Returns

bool —

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

isArray()

isArray() : bool

选项值是否接受数组

Returns

bool —

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

setDefault()

setDefault(mixed  $default = null) : mixed

设置默认值

Parameters

mixed $default

默认值

Throws

\LogicException

Returns

mixed —

getDefault()

getDefault() : mixed

获取默认值

Returns

mixed —

getDescription()

getDescription() : string

获取描述文字

Returns

string —

equals()

equals(\think\console\input\Option  $option) : bool

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

Parameters

\think\console\input\Option $option

Returns

bool —