PHPFUI/InstaDoc
 
Copied!

StringInput represents an input provided as a string.

Usage:

$input = new StringInput('foo --bar="foobar"');

CloneableInstantiable
Constants
public Symfony\Component\Console\Input\StringInput::REGEX_QUOTED_STRING = '(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)')'
public Symfony\Component\Console\Input\StringInput::REGEX_UNQUOTED_STRING = '([^\s\\]+?)'
Methods
public __construct(string $input)
 
  • param string $input A string representing the parameters from the CLI
public Symfony\Component\Console\Input\ArgvInput::__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 Symfony\Component\Console\Input\ArgvInput::getFirstArgument() : ?string
public Symfony\Component\Console\Input\Input::getOption(string $name) : ?mixed
public Symfony\Component\Console\Input\Input::getOptions() : array
public Symfony\Component\Console\Input\ArgvInput::getParameterOption(array|string $values, array|string|int|float|bool|?null $default = false, bool $onlyParams = false) : ?mixed
public Symfony\Component\Console\Input\ArgvInput::getRawTokens(bool $strip = false) : array
 

Returns un-parsed and not validated tokens.

  • param bool $strip Whether to return the raw parameters (false) or the values after the command name (true)
  • return list<string>
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 Symfony\Component\Console\Input\ArgvInput::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 Symfony\Component\Console\Input\ArgvInput::parse() : void
protected Symfony\Component\Console\Input\ArgvInput::parseToken(string $token, bool $parseOptions) : bool
protected Symfony\Component\Console\Input\ArgvInput::setTokens(array $tokens) : void
 
  • param list<string> $tokens
Methods
private tokenize(string $input) : array
 

Tokenizes a string.

  • return list<string>
  • throws \InvalidArgumentException When unable to parse input (should never happen)
© 2025 Bruce Wells