__construct(string $name, int $mode = null, string $description = '', string|string[]|null $default = null)

Parameters

string	$name	The argument name
int	$mode	The argument mode: self::REQUIRED or self::OPTIONAL
string	$description	A description text
string|string[]|null	$default	The default value (for self::OPTIONAL mode only)

Exceptions

InvalidArgumentException

When argument mode is not valid

string getName()

Returns the argument name.

Return Value

string

The argument name

bool isRequired()

Returns true if the argument is required.

Return Value

bool	true if parameter mode is self::REQUIRED, false otherwise

bool isArray()

Returns true if the argument can take multiple values.

Return Value

bool	true if mode is self::IS_ARRAY, false otherwise

setDefault(string|string[]|null $default = null)

Sets the default value.

Parameters

string|string[]|null

$default

The default value

Exceptions

LogicException

When incorrect default value is given

string|string[]|null getDefault()

Returns the default value.

Return Value

string|string[]|null

The default value

string getDescription()

Returns the description text.

Return Value

string

The description text