Option

class Option

An option

Copyright: 2016 Appertly contributors

License: MIT

Constructors / Destructors

Public
Returns	Signature and Description
`void`	`__construct`(`string $spec`, `string $description`) Creates a new Option

Instance Methods

Public
Returns	Signature and Description
`string`	`getDescription`() Gets the option description.
`ImmSet`<`string`>	`getLongs`() Gets the option long aliases
`ImmSet`<`string`>	`getShorts`() Gets the option short aliases.
`string`	`getType`() Gets the option type.
`bool`	`isIncremental`() Whether the option is incremental
`bool`	`isMultiple`() Whether the option can be used multiple times
`bool`	`isOptional`() Whether the option can take a value
`bool`	`isRequired`() Whether the option requires a value
`bool`	`isSolo`() Whether the option takes no value
`mixed`	`parse`(`mixed $value`) Parses an incoming value based on the type defined

Method Details

__construct

public function __construct(string $spec, string $description)

Creates a new Option

Parameters
Name	Type	Description
`$spec`	`string`	The option specification
`$description`	`string`	A human readable description

getDescription

public function getDescription()

Gets the option description.

Returns
Type	Description
`string`	The description

getLongs

public function getLongs()

Gets the option long aliases

Returns
Type	Description
`ImmSet`<`string`>	The long aliases

getShorts

public function getShorts()

Gets the option short aliases.

Returns
Type	Description
`ImmSet`<`string`>	The short aliases

getType

public function getType()

Gets the option type.

Returns
Type	Description
`string`	The type: s, i, f, d

isIncremental

public function isIncremental()

Whether the option is incremental

Returns
Type	Description
`bool`	the option incremental

isMultiple

public function isMultiple()

Whether the option can be used multiple times

Returns
Type	Description
`bool`	true if the option is multiple

isOptional

public function isOptional()

Whether the option can take a value

Returns
Type	Description
`bool`	true if the option can take a value

isRequired

public function isRequired()

Whether the option requires a value

Returns
Type	Description
`bool`	true if the option requires a value

isSolo

public function isSolo()

Whether the option takes no value

Returns
Type	Description
`bool`	true if the option takes no value

parse

public function parse(mixed $value)

Parses an incoming value based on the type defined

Parameters
Name	Type	Description
`$value`	`mixed`	The incoming value

Returns
Type	Description
`mixed`	The converted value