\Inhere\Console\ConcernInputOptionsTrait

getOpt()

getOpt(string  $name, null  $default = null) : boolean|mixed|null

get (long/short)opt value eg: -e dev --name sam

Parameters

Returns

getOption()

getOption(string  $name, mixed  $default = null) : mixed

Alias of the getOpt()

Parameters

Returns

getRequiredOpt()

getRequiredOpt(string  $name, string  $errMsg = '') : mixed

Get a required option value

Parameters

Returns

getStringOpt()

getStringOpt(string  $name, string  $default = '') : string

Get an string option(long/short) value

Parameters

Returns

getSameStringOpt()

getSameStringOpt(array<mixed,string>  $names, string  $default = '') : string

Get an string option(long/short) value

Parameters

Returns

getIntOpt()

getIntOpt(string  $name, integer  $default) : integer

Get an int option(long/short) value

Parameters

Returns

getBoolOpt()

getBoolOpt(string  $name, boolean  $default = false) : boolean

Get (long/short)option value(bool) eg: -h --help

Parameters

Returns

getSameBoolOpt()

getSameBoolOpt(array<mixed,string>  $names, boolean  $default = false) : boolean

Get (long/short)option value(bool) eg: -h --help

Parameters

Returns

boolOpt()

boolOpt(string  $name, boolean  $default = false) : boolean

Alias of the getBoolOpt()

Parameters

Returns

hasOpt()

hasOpt(  $name) : boolean

check option exists

Parameters

Returns

getSameOpt()

getSameOpt(array  $names, mixed  $default = null) : boolean|mixed|null

Get same opts value eg: -h --help

$input->sameOpt(['h','help']);

Parameters

Returns

sameOpt()

sameOpt(array  $names, null  $default = null) : boolean|mixed|null

Alias of the getSameOpt()

Parameters

Returns

getOpts()

getOpts() : array

Returns

getOptions()

getOptions() : array

Returns

clearOpts()

clearOpts() 

clear (l/s)opts

sOpt()

sOpt(string  $name, null  $default = null) : mixed|null

Get short-opt value

Parameters

Returns

shortOpt()

shortOpt(string  $name, null  $default = null) : mixed|null

Alias of the sOpt()

Parameters

Returns

getShortOpt()

getShortOpt(string  $name, null  $default = null) : mixed|null

Alias of the sOpt()

Parameters

Returns

hasSOpt()

hasSOpt(string  $name) : boolean

Check short-opt exists

Parameters

Returns

findOneShortOpts()

findOneShortOpts(array<mixed,string>  $names) : string

Check multi short-opt exists

Parameters

Returns

sBoolOpt()

sBoolOpt(string  $name, boolean  $default = false) : boolean

get short-opt value(bool)

Parameters

Returns

getShortOpts()

getShortOpts() : array

Returns

setSOpt()

setSOpt(string  $name, mixed  $value) 

Parameters

getSOpts()

getSOpts() : array

Returns

setSOpts()

setSOpts(array  $sOpts, boolean  $replace = false) 

Parameters

clearSOpts()

clearSOpts() 

clear s-opts

lOpt()

lOpt(string  $name, null  $default = null) : mixed|null

Alias of the getLongOpt()

Parameters

Returns

longOpt()

longOpt(string  $name, null  $default = null) : mixed|null

Alias of the getLongOpt()

Parameters

Returns

getLongOpt()

getLongOpt(string  $name, null  $default = null) : mixed|null

Get long-opt value

Parameters

Returns

hasLOpt()

hasLOpt(string  $name) : boolean

check long-opt exists

Parameters

Returns

lBoolOpt()

lBoolOpt(string  $name, boolean  $default = false) : boolean

get long-opt value(bool)

Parameters

Returns

getLongOpts()

getLongOpts() : array

Returns

setLOpt()

setLOpt(string  $name,   $value) 

Parameters

getLOpts()

getLOpts() : array

Returns

setLOpts()

setLOpts(array  $lOpts, boolean  $replace = false) 

Parameters

clearLOpts()

clearLOpts() 

clear lang opts