Gitee
\
app
admin
controller
admin
setting
store
model
admin
store
api
behavior
order
controller
balance
bargain
points
recharge
sharing
sharp
shop
user
dealer
wxapp
model
article
bargain
dealer
recharge
sharing
sharp
store
shop
user
wow
wxapp
service
bargain
order
coupon
master
order
order
source
checkout
points
recharge
sharing
order
sharp
order
validate
order
sharing
order
common
behavior
enum
dealer
withdraw
goods
live
order
recharge
order
sharing
sharp
user
balanceLog
grade
log
exception
library
express
printer
engine
party
sms
engine
package
aliyun
storage
engine
wechat
live
wow
model
addons
admin
article
bargain
dealer
recharge
sharing
sharp
store
shop
user
wow
wxapp
service
delivery
goods
source
message
dealer
order
sharing
order
qrcode
bargain
sharp
wechat
wow
wxapp
index
controller
store
controller
apps
bargain
dealer
sharing
order
sharp
wow
content
files
data
bargain
sharing
sharp
market
recharge
setting
statistics
store
upload
user
wxapp
model
addons
bargain
dealer
recharge
store
shop
user
wxapp
service
goods
order
statistics
data
wxapp
task
behavior
bargain
sharing
sharp
user
model
bargain
dealer
recharge
sharing
sharp
user
service
Composer
Autoload
Grafika
DrawingObject
Gd
DrawingObject
Filter
Helper
ImageHash
Imagick
DrawingObject
Filter
ImageHash
Guzzle
Batch
Exception
Cache
Common
Exception
Http
Curl
Exception
Message
Header
QueryAggregator
Inflection
Iterator
Log
Parser
Cookie
Message
UriTemplate
Url
Plugin
Async
Backoff
Cache
Cookie
CookieJar
Exception
CurlAuth
ErrorResponse
Exception
History
Log
Md5
Mock
Oauth
Service
Builder
Command
Factory
LocationVisitor
Request
Response
Description
Exception
Resource
Stream
Tests
Batch
Cache
Common
Cache
Exception
Http
Curl
Exception
Message
Header
Inflection
Iterator
Log
Message
Mock
Parser
Cookie
Message
Parsers
UriTemplate
Plugin
Async
Backoff
Cache
Cookie
CookieJar
CurlAuth
ErrorResponse
History
Log
Md5
Mock
Oauth
Redirect
Service
Builder
Command
LocationVisitor
Request
Response
Description
Exception
Mock
Command
Sub
Model
Resource
Stream
Lvht
MyCLabs
Enum
OSS
Core
Http
Model
Result
Tests
Qcloud
Cos
Exception
Tests
Qiniu
Cdn
Http
Processing
Rtc
Storage
Tests
Symfony
Component
EventDispatcher
Debug
DependencyInjection
Tests
Debug
DependencyInjection
think
cache
driver
composer
config
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
controller
db
builder
connector
exception
debug
exception
log
driver
model
relation
paginator
driver
process
exception
pipes
response
session
driver
template
driver
taglib
view
driver
traits
controller
model
think
wxpay
example

\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