PHPFUI/InstaDoc
 
Copied!

ArrayInput represents an input provided as an array.

Usage:

$input = new ArrayInput(['command' => 'foo:bar', 'foo' => 'bar', '--bar' => 'foobar']);

CloneableInstantiable
Methods
public __construct(array $parameters, ?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) : void
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()
 
  • return resource
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) : void
public Symfony\Component\Console\Input\Input::setInteractive(bool $interactive) : void
public Symfony\Component\Console\Input\Input::setOption(string $name, ?mixed $value) : void
public Symfony\Component\Console\Input\Input::setStream( $stream) : void
 
  • param resource $stream
public Symfony\Component\Console\Input\Input::validate() : void
Properties
protected array Symfony\Component\Console\Input\Input::$arguments = []
protected Symfony\Component\Console\Input\InputDefinition Symfony\Component\Console\Input\Input::$definition
protected bool Symfony\Component\Console\Input\Input::$interactive = true
protected array Symfony\Component\Console\Input\Input::$options = []
protected Symfony\Component\Console\Input\Input::$stream = NULL
 
  • var resource
Methods
protected parse() : void
Properties
private array $parameters
Methods
private addArgument(string|int $name, ?mixed $value) : void
 

Adds an argument value.

  • throws \InvalidArgumentException When argument given doesn't exist
private addLongOption(string $name, ?mixed $value) : void
 

Adds a long option value.

  • throws \InvalidOptionException When option given doesn't exist
  • throws \InvalidOptionException When a required value is missing
private addShortOption(string $shortcut, ?mixed $value) : void
 

Adds a short option value.

  • throws \InvalidOptionException When option given doesn't exist
© 2025 Bruce Wells