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

__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

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(mixed $default = null)

Sets the default value.

Parameters

mixed

$default

The default value

Exceptions

LogicException

When incorrect default value is given

mixed getDefault()

Returns the default value.

Return Value

mixed

The default value

string getDescription()

Returns the description text.

Return Value

string

The description text

Links:

http://api.symfony.com/master/Symfony/Component/Console/Input/InputArgument.html

doc_Symfony

2025-01-10 15:47:30

Comments