1. class
  2. Symfony
  3. Component
  4. Console
  5. Input
  6. InputArgument

InputArgument

class InputArgument

Represents a command line argument.

Constants

REQUIRED

OPTIONAL

IS_ARRAY

Methods

__construct(string $name, int $mode = null, string $description = '', mixed $default = null)

Constructor.

string
getName()

Returns the argument name.

bool
isRequired()

Returns true if the argument is required.

bool
isArray()

Returns true if the argument can take multiple values.

setDefault(mixed $default = null)

Sets the default value.

mixed
getDefault()

Returns the default value.

string
getDescription()

Returns the description text.

Details

at line line 43
__construct(string $name, int $mode = null, string $description = '', mixed $default = null)

Constructor.

Parameters

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

Exceptions

InvalidArgumentException When argument mode is not valid

at line line 63
string getName()

Returns the argument name.

Return Value

string The argument name

at line line 73
bool isRequired()

Returns true if the argument is required.

Return Value

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

at line line 83
bool isArray()

Returns true if the argument can take multiple values.

Return Value

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

at line line 95
setDefault(mixed $default = null)

Sets the default value.

Parameters

mixed $default The default value

Exceptions

LogicException When incorrect default value is given

at line line 117
mixed getDefault()

Returns the default value.

Return Value

mixed The default value

at line line 127
string getDescription()

Returns the description text.

Return Value

string The description text