Symfony2 API
Class

Symfony\Component\Console\Input\InputArgument

class InputArgument

Represents a command line argument.

Constants

REQUIRED

OPTIONAL

IS_ARRAY

Methods

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

Constructor.
string getName()

Returns the argument name.
Boolean isRequired()

Returns true if the argument is required.
Boolean 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 44
public __construct(string $name, integer $mode = null, string $description = '', mixed $default = null)

Constructor.

Parameters

string $name The argument name
integer $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 64
public string getName()

Returns the argument name.

Return Value

string The argument name

at line 74
public Boolean isRequired()

Returns true if the argument is required.

Return Value

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

at line 84
public Boolean isArray()

Returns true if the argument can take multiple values.

Return Value

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

at line 96
public setDefault(mixed $default = null)

Sets the default value.

Parameters

mixed $default The default value

Exceptions

LogicException When incorrect default value is given

at line 118
public mixed getDefault()

Returns the default value.

Return Value

mixed The default value

at line 128
public string getDescription()

Returns the description text.

Return Value

string The description text