API Documentation (v0.9.0-alpha)

Avolutions\Command\Option

Contains the definition of a Command Option.

Properties

Property Visibility Type Description
$default public mixed Default value of the Option.
$help public string Help text for the Option.
$name public string Name of the Option.
$short public string Short name of the Option.

Methods

Method Visibility Description
__construct() public Creates a new Option definition.

Property Details

$default

Default value of the Option.

public mixed $default
$help

Help text for the Option.

public string $help
$name

Name of the Option.

public string $name
$short

Short name of the Option.

public string $short

Method Details

__construct()

Creates a new Option definition.

public __construct(string $name[, string $short = '' ][, string $help = '' ][, bool $default = false ]) : mixed
Parameters

string $name
Name of the Option.

string $short (optional)
Short name of the Option.

string $help (optional)
Help text for the Argument.

bool $default (optional)
Default value of the Option.