Docs For Class CriticalI

CriticalI_OptionSpec

Description

Specification for a command line option

Located in /Core/lib/CriticalI/OptionSpec.php (line 9)

Class Constant Summary

NONE = 0

OPTIONAL = 2

REQUIRED = 1

Variable Summary

mixed $argument_name

mixed $argument_type

mixed $description

mixed $name

Method Summary

static string usage_text (array $specs)

CriticalI_OptionSpec __construct ([string $name = null], [int $argument_type = self::NONE], [string $argument_name = null], [string $description = null])

Variables

mixed $argument_name (line 16)

NONE, REQUIRED, or OPTIONAL *

access: public

mixed $argument_type (line 15)

access: public

mixed $description (line 17)

access: public

mixed $name (line 14)

access: public

Methods

static usage_text (line 41)

Helper function to produce partial usage text from a list of CriticalI_OptionSpec objects.

access: public

string usage_text (array $specs)

array $specs: The array of CriticalI_OptionSpec objects to produce usage text for

Constructor __construct (line 27)

Constructor

access: public

CriticalI_OptionSpec __construct ([string $name = null], [int $argument_type = self::NONE], [string $argument_name = null], [string $description = null])

string $name: The option name (no leading --)
int $argument_type: Argument type (NONE, REQUIRED, or OPTIONAL)
string $argument_name: The argument name (when applicable), used for help output
string $description: Optional description for help output

Class Constants

NONE = 0 (line 10)

OPTIONAL = 2 (line 12)

REQUIRED = 1 (line 11)

Documentation generated on Wed, 25 Apr 2012 09:46:44 -0700 by phpDocumentor 1.4.3