ArgvInput represents an input coming from the CLI arguments.


$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.

  • author Fabien Potencier
  • see
  • see
public __construct(?array $argv = NULL, ?Symfony\Component\Console\Input\InputDefinition $definition = NULL)
public __toString() : string

Returns a stringified representation of the args passed to the command.

public Symfony\Component\Console\Input\Input::bind(Symfony\Component\Console\Input\InputDefinition $definition)
public Symfony\Component\Console\Input\Input::escapeToken(string $token) : string

Escapes a token through escapeshellarg if it contains unsafe chars.

public Symfony\Component\Console\Input\Input::getArgument(string $name) : ?mixed
public Symfony\Component\Console\Input\Input::getArguments() : array
public getFirstArgument() : ?string
public Symfony\Component\Console\Input\Input::getOption(string $name) : ?mixed
public Symfony\Component\Console\Input\Input::getOptions() : array
public getParameterOption(array|string $values, array|string|int|float|bool|?null $default = false, bool $onlyParams = false) : ?mixed
public Symfony\Component\Console\Input\Input::getStream()
public Symfony\Component\Console\Input\Input::hasArgument(string $name) : bool
public Symfony\Component\Console\Input\Input::hasOption(string $name) : bool
public hasParameterOption(array|string $values, bool $onlyParams = false) : bool
public Symfony\Component\Console\Input\Input::isInteractive() : bool
public Symfony\Component\Console\Input\Input::setArgument(string $name, ?mixed $value)
public Symfony\Component\Console\Input\Input::setInteractive(bool $interactive)
public Symfony\Component\Console\Input\Input::setOption(string $name, ?mixed $value)
public Symfony\Component\Console\Input\Input::setStream( $stream)
public Symfony\Component\Console\Input\Input::validate()
protected Symfony\Component\Console\Input\Input::$arguments
protected Symfony\Component\Console\Input\Input::$definition
protected Symfony\Component\Console\Input\Input::$interactive
protected Symfony\Component\Console\Input\Input::$options
protected Symfony\Component\Console\Input\Input::$stream
protected parse()
protected parseToken(string $token, bool $parseOptions) : bool
protected setTokens(array $tokens)
private array $parsed
private array $tokens
private addLongOption(string $name, ?mixed $value)

Adds a long option value.

private addShortOption(string $shortcut, ?mixed $value)

Adds a short option value.

private parseArgument(string $token)

Parses an argument.

private parseLongOption(string $token)

Parses a long option.

private parseShortOption(string $token)

Parses a short option.

private parseShortOptionSet(string $name)

Parses a short option set.

© 2023 Bruce Wells
Search Namespaces \ Classes