Gitee
\
Inhere
Console
BuiltIn
Component
Animation
Formatter
Interact
Progress
Concern
Contract
Examples
Command
Controller
Exception
Flag
IO
Input
Output
Util
ConsoleTest
IO

\Inhere\Console\IO\InputInputOption

Class InputOption - definition a input option

Summary

Methods
Properties
Constants
make()
__construct()
hasMode()
getType()
setType()
getMode()
setMode()
getName()
setName()
getDefault()
setDefault()
getDescription()
setDescription()
toArray()
isArray()
isOptional()
isRequired()
isBoolean()
getAlias()
setAlias()
getShortcut()
setShortcutsByString()
getShortcuts()
setShortcuts()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$name
$description
$mode
$type
$default
$alias
$shortcuts
$shortcut
N/A

Properties

$name

$name : string

Type

string

$description

$description : string

Type

string

$mode

$mode : integer

Type

integer

$type

$type : string

The argument data type. (eg: 'int', 'bool', 'string', 'array', 'mixed')

Type

string

$default

$default : mixed

The default value

Type

mixed

$alias

$alias : string

alias name

Type

string

$shortcuts

$shortcuts : array

Shortcuts of the option. eg: ['a', 'b']

Type

array

$shortcut

$shortcut : string

eg: 'a|b'

Type

string

Methods

make()

make(string  $name, integer  $mode, string  $description = '', null  $default = null) : static

Parameters

string $name
integer $mode

see Input::ARG* or Input::OPT*
string $description
null $default

Returns

static

__construct()

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

Class constructor.

Parameters

string $name
integer $mode

see Input::ARG* or Input::OPT*
string $description
mixed $default

The default value

  • for Input::ARG_OPTIONAL mode only
  • must be null for InputOption::OPT_BOOL

hasMode()

hasMode(integer  $mode) : boolean

Parameters

integer $mode

Returns

boolean

getType()

getType() : string

Returns

string

setType()

setType(string  $type)

Parameters

string $type

getMode()

getMode() : integer

Returns

integer

setMode()

setMode(integer  $mode)

Parameters

integer $mode

getName()

getName() : string

Returns

string

setName()

setName(string  $name)

Parameters

string $name

getDefault()

getDefault() : mixed

Returns

mixed

setDefault()

setDefault(mixed  $default)

Parameters

mixed $default

getDescription()

getDescription() : string

Returns

string

setDescription()

setDescription(string  $description)

Parameters

string $description

toArray()

toArray() : array

Returns

array

isArray()

isArray() : boolean

Returns

boolean

isOptional()

isOptional() : boolean

Returns

boolean

isRequired()

isRequired() : boolean

Returns

boolean

isBoolean()

isBoolean() : boolean

Returns

boolean

getAlias()

getAlias() : string

Returns

string

setAlias()

setAlias(string  $alias)

Parameters

string $alias

getShortcut()

getShortcut() : string

Returns

string

setShortcutsByString()

setShortcutsByString(string  $shortcut)

Parameters

string $shortcut

getShortcuts()

getShortcuts() : array

Returns

array

setShortcuts()

setShortcuts(array  $shortcuts)

Parameters

array $shortcuts