\Vegas\Cli\TaskOption

__construct()

__construct( $name,  $shortName, string $description)

Constructor

Parameters

getName()

getName() : string

Returns full name of option

Returns

getShortName()

getShortName() : string

Returns short name of option

Returns

getDescription()

getDescription() : string

Return description of option

Returns

setValidator()

setValidator(callable $validator)

Sets validator function

Parameters

matchParam()

matchParam( $paramName) : boolean

Checks if parameter name matches to long or short name of option

Parameters

Returns

setRequired()

setRequired(boolean $required) : $this

Determines if option is required

Parameters

Returns

isRequired()

isRequired() : boolean

Determines if option is required

Returns

validate()

validate( $value) : boolean|mixed

Validates option value

Parameters

Returns

getValue()

getValue( $args, null $default) : mixed

Looks for value of option in specified arguments array.

When option is not found then returns default value.

Parameters

Returns