Gitee
\
Adbar
AlibabaCloud
Tea
Exception
FileForm
FileForm
Tests
Alipay
EasySDK
Base
Image
Models
OAuth
Models
Qrcode
Models
Video
Models
Kernel
Exceptions
Util
Marketing
OpenLife
Models
Pass
Models
TemplateMessage
Models
Member
Identification
Models
Payment
App
Models
Common
Models
FaceToFace
Models
Huabei
Models
Page
Models
Wap
Models
Security
TextRisk
Models
Test
base
image
oauth
video
Base
marketing
openlife
pass
templatemessage
member
identification
multipleFactory
payment
common
facetoface
huabei
security
textrisk
util
generic
Util
AES
Generic
Models
app
controller
middleware
model
validate
BaconQrCode
Common
Encoder
Exception
Renderer
Color
Eye
Image
Module
EdgeIterator
Path
RendererStyle
BaconQrCodeTest
Common
Encoder
BarcodeBakery
Barcode
Common
Drawer
BigintTest
BugHonorFileTimeTest
Complex
Composer
Autoload
DASPRiD
Enum
Exception
EnumTest
Endroid
QrCode
Exception
Factory
Tests
Writer
GuzzleHttp
Cookie
Exception
Handler
Promise
Psr7
JmesPath
Khanamiryan
QrCodeTests
League
Flysystem
Adapter
Polyfill
Cached
Storage
Plugin
Util
MimeTypeDetection
Matrix
Decomposition
Operators
MyCLabs
Enum
PHPUnit
org
PhpOffice
PhpSpreadsheet
Calculation
Database
Engine
Engineering
Internal
Logical
MathTrig
Statistical
Token
Cell
Chart
Renderer
Collection
Document
Helper
Reader
Gnumeric
Ods
Security
Xls
Color
Style
Xlsx
Xml
RichText
Shared
Escher
DgContainer
SpgrContainer
DggContainer
BstoreContainer
BSE
JAMA
OLE
PPS
Trend
Style
ConditionalFormatting
Worksheet
AutoFilter
Column
Drawing
Writer
Ods
Cell
Pdf
Xls
Xlsx
Pimple
Exception
Psr11
Tests
Fixtures
Psr11
Psr
Cache
Container
Http
Client
Message
Log
Test
SimpleCache
Songshenzong
Support
Test
Core
Traits
spec
League
Flysystem
Cached
Stringy
Symfony
Component
OptionsResolver
Debug
Exception
PropertyAccess
Exception
PropertyInfo
DependencyInjection
Extractor
Util
String
Exception
Inflector
Slugger
VarDumper
Caster
Cloner
Command
Descriptor
Dumper
ContextProvider
Exception
Server
Test
Polyfill
Ctype
Intl
Grapheme
Normalizer
Mbstring
Php72
Php73
Php80
think
cache
driver
console
command
make
optimize
input
output
descriptor
driver
formatter
question
contract
db
builder
concern
connector
exception
event
exception
facade
file
filesystem
driver
helper
initializer
log
driver
middleware
model
concern
relation
paginator
driver
response
route
dispatch
service
session
driver
template
driver
exception
taglib
tests
trace
validate
view
driver
ZipStream
Exception
Option
ZipStreamTest
Zxing
Common
Detector
Reedsolomon
Qrcode
Decoder
Detector

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

选项名

Type

string —

$shortcut

$shortcut : string

选项短名称

Type

string —

$mode

$mode : int

选项类型

Type

int —

$default

$default : mixed

选项默认值

Type

mixed —

$description

$description : string

选项描述

Type

string —

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 —