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 the input. | 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) Returns the argument value for a given argument 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) Returns the option value for a given option 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, bool $onlyParams = false) Returns true if the raw parameters (not parsed) contain a value. | |
mixed | getParameterOption(string|array $values, mixed $default = false, bool $onlyParams = false) Returns the value of a raw option (not parsed). | |
string | __toString() Returns a stringified representation of the args passed to the command. |
Details
__construct(array $parameters, InputDefinition $definition = null)
Constructor.
bind(InputDefinition $definition)
Binds the current Input instance with the given arguments and options.
validate()
Validates the input.
bool isInteractive()
Is this input means interactive?
setInteractive(bool $interactive)
Sets the input interactivity.
array getArguments()
Returns all the given arguments merged with the default values.
mixed getArgument(string $name)
Returns the argument value for a given argument name.
setArgument(string $name, string $value)
Sets an argument value by name.
bool hasArgument(string|int $name)
Returns true if an InputArgument object exists by name or position.
array getOptions()
Returns all the given options merged with the default values.
mixed getOption(string $name)
Returns the option value for a given option name.
setOption(string $name, string|bool $value)
Sets an option value by name.
bool hasOption(string $name)
Returns true if an InputOption object exists by name.
string escapeToken(string $token)
Escapes a token through escapeshellarg if it contains unsafe chars.
string getFirstArgument()
Returns the first argument from the raw parameters (not parsed).
bool hasParameterOption(string|array $values, bool $onlyParams = false)
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.
mixed getParameterOption(string|array $values, mixed $default = false, bool $onlyParams = 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.
string __toString()
Returns a stringified representation of the args passed to the command.
Please login to continue.