Symfony2 API
Class

Symfony\Component\Console\Input\ArgvInput

class ArgvInput extends Input

ArgvInput represents an input coming from the CLI arguments.

Usage:

$input = new ArgvInput();

By default, the $_SERVER['argv'] array is used for the input values.

This can be overridden by explicitly passing the input values in the constructor:

$input = new ArgvInput($_SERVER['argv']);

If you pass it yourself, don't forget that the first element of the array is the name of the running application.

When passing an argument to the constructor, be sure that it respects the same rules as the argv one. It's almost always better to use the StringInput when you want to provide your own input.

Methods

__construct(array $argv = null, InputDefinition $definition = null)

Constructor.

bind(InputDefinition $definition)

Binds the current Input instance with the given arguments and options.

from Input
validate()

Validates if arguments given are correct.

from Input
bool isInteractive()

Is this input means interactive?

from Input
setInteractive(bool $interactive)

Sets the input interactivity.

from Input
array getArguments()

Returns all the given arguments merged with the default values.

from Input
mixed getArgument(string $name)

Gets argument by name.

from Input
setArgument(string $name, string $value)

Sets an argument value by name.

from Input
bool hasArgument(string|int $name)

Returns true if an InputArgument object exists by name or position.

from Input
array getOptions()

Returns all the given options merged with the default values.

from Input
mixed getOption(string $name)

Gets an option by name.

from Input
setOption(string $name, string|bool $value)

Sets an option value by name.

from Input
bool hasOption(string $name)

Returns true if an InputOption object exists by name.

from Input
string escapeToken(string $token)

Escapes a token through escapeshellarg if it contains unsafe chars

from Input
string getFirstArgument()

Returns the first argument from the raw parameters (not parsed).

bool hasParameterOption(string|array $values)

Returns true if the raw parameters (not parsed) contain a value.

mixed getParameterOption(string|array $values, mixed $default = false)

Returns the value of a raw option (not parsed).

string __toString()

Returns a stringified representation of the args passed to the command

Details

at line 54
public __construct(array $argv = null, InputDefinition $definition = null)

Constructor.

Parameters

array $argv An array of parameters from the CLI (in the argv format)
InputDefinition $definition A InputDefinition instance

in Input at line 55
public bind(InputDefinition $definition)

Binds the current Input instance with the given arguments and options.

Parameters

InputDefinition $definition A InputDefinition instance

in Input at line 74
public validate()

Validates if arguments given are correct.

Throws an exception when not enough arguments are given.

Exceptions

RuntimeException

in Input at line 86
public bool isInteractive()

Is this input means interactive?

Return Value

bool Returns true if the input is interactive

in Input at line 96
public setInteractive(bool $interactive)

Sets the input interactivity.

Parameters

bool $interactive If the input should be interactive

in Input at line 106
public array getArguments()

Returns all the given arguments merged with the default values.

Return Value

array An array of argument values

in Input at line 120
public mixed getArgument(string $name)

Gets argument by name.

Parameters

string $name The argument name

Return Value

mixed The argument value

in Input at line 137
public setArgument(string $name, string $value)

Sets an argument value by name.

Parameters

string $name The argument name
string $value The argument value

Exceptions

InvalidArgumentException When argument given doesn't exist

in Input at line 153
public bool hasArgument(string|int $name)

Returns true if an InputArgument object exists by name or position.

Parameters

string|int $name The InputArgument name or position

Return Value

bool true if the InputArgument object exists, false otherwise

in Input at line 163
public array getOptions()

Returns all the given options merged with the default values.

Return Value

array An array of option values

in Input at line 177
public mixed getOption(string $name)

Gets an option by name.

Parameters

string $name The option name

Return Value

mixed The option value

in Input at line 194
public setOption(string $name, string|bool $value)

Sets an option value by name.

Parameters

string $name The option name
string|bool $value The option value

Exceptions

InvalidArgumentException When option given doesn't exist

in Input at line 210
public bool hasOption(string $name)

Returns true if an InputOption object exists by name.

Parameters

string $name The InputOption name

Return Value

bool true if the InputOption object exists, false otherwise

in Input at line 222
public string escapeToken(string $token)

Escapes a token through escapeshellarg if it contains unsafe chars

Parameters

string $token

Return Value

string

at line 262
public string getFirstArgument()

Returns the first argument from the raw parameters (not parsed).

Return Value

string The value of the first argument or null otherwise

at line 283
public bool hasParameterOption(string|array $values)

Returns true if the raw parameters (not parsed) contain a value.

This method is to be used to introspect the input parameters before they have been validated. It must be used carefully.

Parameters

string|array $values The value(s) to look for in the raw parameters (can be an array)

Return Value

bool true if the value is contained in the raw parameters

at line 309
public mixed getParameterOption(string|array $values, mixed $default = false)

Returns the value of a raw option (not parsed).

This method is to be used to introspect the input parameters before they have been validated. It must be used carefully.

Parameters

string|array $values The value(s) to look for in the raw parameters (can be an array)
mixed $default The default value to return if no result is found

Return Value

mixed The option value

at line 334
public string __toString()

Returns a stringified representation of the args passed to the command

Return Value

string