Gitee
\
Acme
Api
app
admin
controller
agent
article
finance
order
record
routine
setting
store
system
ump
user
wechat
widget
model
article
finance
order
record
routine
store
system
ump
user
wechat
index
controller
routine
controller
model
article
routine
store
user
wap
controller
model
store
user
wap
wechat
controller
basic
behavior
system
wap
wechat
Composer
Autoload
Doctrine
Common
Cache
Tests
Common
Cache
EasyWeChat
Broadcast
Card
Comment
Core
Exceptions
Device
Encryption
Foundation
ServiceProviders
Fundamental
Js
Material
Menu
Message
MiniProgram
Core
Encryption
Material
Notice
QRCode
Server
Sns
Staff
Stats
Notice
OpenPlatform
Api
EventHandlers
Payment
CashCoupon
LuckyMoney
MerchantPay
POI
QRCode
Reply
Semantic
Server
ShakeAround
Staff
Stats
Store
Support
Traits
Url
User
FormBuilder
components
interfaces
traits
component
form
GuzzleHttp
Cookie
Exception
Handler
Promise
Psr7
Monolog
Formatter
Handler
Curl
FingersCrossed
Slack
SyslogUdp
Processor
Overtrue
Socialite
Providers
Phinx
Db
Adapter
Table
Migration
Seed
Util
Pimple
Exception
Psr11
Tests
Fixtures
Psr11
Psr
Container
Http
Message
Log
Test
service
Symfony
Bridge
PsrHttpMessage
Factory
Tests
Factory
Fixtures
Component
HttpFoundation
Exception
File
Exception
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
Tests
File
MimeType
Session
Attribute
Flash
Storage
Handler
Proxy
Polyfill
Mbstring
tests
think
cache
driver
captcha
composer
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
controller
db
builder
connector
exception
debug
exception
image
gif
log
driver
migration
command
migrate
seed
db
model
relation
paginator
driver
process
exception
pipes
response
session
driver
template
driver
taglib
view
driver
traits
controller
model
think

\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 :

Type

$shortcut

$shortcut :

Type

$mode

$mode :

Type

$default

$default :

Type

$description

$description :

Type

Methods

__construct()

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

构造方法

Parameters

string $name

选项名
string|array $shortcut

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

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

描述
mixed $default

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

Throws

\InvalidArgumentException

getShortcut()

getShortcut() : string

获取短名称

Returns

string

getName()

getName() : string

获取选项名

Returns

string

acceptValue()

acceptValue() : boolean

是否可以设置值

Returns

boolean —

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

isValueRequired()

isValueRequired() : boolean

是否必须

Returns

boolean —

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

isValueOptional()

isValueOptional() : boolean

是否可选

Returns

boolean —

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

isArray()

isArray() : boolean

选项值是否接受数组

Returns

boolean —

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

setDefault()

setDefault(mixed  $default = null)

设置默认值

Parameters

mixed $default

默认值

Throws

\LogicException

getDefault()

getDefault() : mixed

获取默认值

Returns

mixed

getDescription()

getDescription() : string

获取描述文字

Returns

string

equals()

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

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

Parameters

\think\console\input\Option $option

Returns

boolean