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
Binds the current Input instance with the given arguments and options.
Returns true if an InputArgument object exists by name or position.
Escapes a token through escapeshellarg if it contains unsafe chars.
Returns the first argument from the raw parameters (not parsed).
Returns true if the raw parameters (not parsed) contain a value.
Returns the value of a raw option (not parsed).
Returns a stringified representation of the args passed to the command.
Details
at line line 52
__construct(array $argv = null, InputDefinition $definition = null)
Constructor.
in Input at line line 58
bind(InputDefinition $definition)
Binds the current Input instance with the given arguments and options.
in Input at line line 77
validate()
Validates if arguments given are correct.
Throws an exception when not enough arguments are given.
in Input at line line 96
bool
isInteractive()
Is this input means interactive?
in Input at line line 106
setInteractive(bool $interactive)
Sets the input interactivity.
in Input at line line 116
array
getArguments()
Returns all the given arguments merged with the default values.
in Input at line line 130
mixed
getArgument(string $name)
Gets argument by name.
in Input at line line 147
setArgument(string $name, string $value)
Sets an argument value by name.
in Input at line line 163
bool
hasArgument(string|int $name)
Returns true if an InputArgument object exists by name or position.
in Input at line line 173
array
getOptions()
Returns all the given options merged with the default values.
in Input at line line 187
mixed
getOption(string $name)
Gets an option by name.
in Input at line line 204
setOption(string $name, string|bool $value)
Sets an option value by name.
in Input at line line 220
bool
hasOption(string $name)
Returns true if an InputOption object exists by name.
in Input at line line 232
string
escapeToken(string $token)
Escapes a token through escapeshellarg if it contains unsafe chars.
at line line 260
string
getFirstArgument()
Returns the first argument from the raw parameters (not parsed).
at line line 282
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.
at line line 312
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.
at line line 342
string
__toString()
Returns a stringified representation of the args passed to the command.