Symfony2 API
Class

Symfony\Component\Console\Input\ArrayInput

class ArrayInput extends Input

ArrayInput represents an input provided as an array.

Usage:

$input = new ArrayInput(array('name' => 'foo', '--bar' => 'foobar'));

Methods

__construct(array $parameters, 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
Boolean isInteractive()

Is this input means interactive?

 from Input
setInteractive(Boolean $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
Boolean hasArgument(string|integer $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 $value)

Sets an option value by name.

 from Input
Boolean hasOption(string $name)

Returns true if an InputOption object exists by name.

 from Input
string getFirstArgument()

Returns the first argument from the raw parameters (not parsed).
Boolean 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).

Details

at line 37
public __construct(array $parameters, InputDefinition $definition = null)

Constructor.

Parameters

array $parameters An array of parameters
InputDefinition $definition A InputDefinition instance

in Input at line 52
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 71
public validate()

Validates if arguments given are correct.

Throws an exception when not enough arguments are given.

Exceptions

RuntimeException

in Input at line 83
public Boolean isInteractive()

Is this input means interactive?

Return Value

Boolean Returns true if the input is interactive

in Input at line 93
public setInteractive(Boolean $interactive)

Sets the input interactivity.

Parameters

Boolean $interactive If the input should be interactive

in Input at line 103
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 117
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 134
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 150
public Boolean hasArgument(string|integer $name)

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

Parameters

string|integer $name The InputArgument name or position

Return Value

Boolean true if the InputArgument object exists, false otherwise

in Input at line 160
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 174
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 191
public setOption(string $name, string $value)

Sets an option value by name.

Parameters

string $name The option name
string $value The option value

Exceptions

InvalidArgumentException When option given doesn't exist

in Input at line 207
public Boolean hasOption(string $name)

Returns true if an InputOption object exists by name.

Parameters

string $name The InputOption name

Return Value

Boolean true if the InputOption object exists, false otherwise

at line 49
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 70
public Boolean 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 values to look for in the raw parameters (can be an array)

Return Value

Boolean true if the value is contained in the raw parameters

at line 98
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