W3cubDocs

/Symfony 2.8

Symfony\Component\Console\Input\StringInput

class StringInput extends ArgvInput

StringInput represents an input provided as a string.

Usage:

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

Constants

REGEX_STRING
REGEX_QUOTED_STRING

Methods

__construct(string $input, 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()

Checks if the input is interactive.

 from Input
setInteractive(bool $interactive)

Sets the input interactivity.

 from Input
array getArguments()

Returns the argument 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 the options 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).

 from ArgvInput
bool hasParameterOption(string|array $values)

Returns true if the raw parameters (not parsed) contain a value.

 from ArgvInput
mixed getParameterOption(string|array $values, mixed $default = false)

Returns the value of a raw option (not parsed).

 from ArgvInput
string __toString()

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

 from ArgvInput

Details

public __construct(string $input, InputDefinition $definition = null)

Constructor.

Parameters

string $input An array of parameters from the CLI (in the argv format)
InputDefinition $definition A InputDefinition instance

public bind(InputDefinition $definition)

Binds the current Input instance with the given arguments and options.

Parameters

InputDefinition $definition A InputDefinition instance

public validate()

Validates the input.

Exceptions

RuntimeException When not enough arguments are given

public bool isInteractive()

Checks if the input is interactive.

Return Value

bool Returns true if the input is interactive

public setInteractive(bool $interactive)

Sets the input interactivity.

Parameters

bool $interactive If the input should be interactive

public array getArguments()

Returns the argument values.

Return Value

array An array of argument values

public mixed getArgument(string $name)

Returns the argument value for a given argument name.

Parameters

string $name The argument name

Return Value

mixed The argument value

Exceptions

InvalidArgumentException When argument given doesn't exist

public setArgument(string $name, string $value)

Sets an argument value by name.

Parameters

string $name The argument name
string $value The argument value

Exceptions

InvalidArgumentException When argument given doesn't exist

public bool hasArgument(string|int $name)

Returns true if an InputArgument object exists by name or position.

Parameters

string|int $name The InputArgument name or position

Return Value

bool true if the InputArgument object exists, false otherwise

public array getOptions()

Returns the options values.

Return Value

array An array of option values

public mixed getOption(string $name)

Returns the option value for a given option name.

Parameters

string $name The option name

Return Value

mixed The option value

Exceptions

InvalidArgumentException When option given doesn't exist

public setOption(string $name, string|bool $value)

Sets an option value by name.

Parameters

string $name The option name
string|bool $value The option value

Exceptions

InvalidArgumentException When option given doesn't exist

public bool hasOption(string $name)

Returns true if an InputOption object exists by name.

Parameters

string $name The InputOption name

Return Value

bool true if the InputOption object exists, false otherwise

public string escapeToken(string $token)

Escapes a token through escapeshellarg if it contains unsafe chars.

Parameters

string $token

Return Value

string

public string getFirstArgument()

Returns the first argument from the raw parameters (not parsed).

Return Value

string The value of the first argument or null otherwise

public bool hasParameterOption(string|array $values)

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.

Parameters

string|array $values The value(s) to look for in the raw parameters (can be an array)

Return Value

bool true if the value is contained in the raw parameters

public mixed getParameterOption(string|array $values, mixed $default = 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.

Parameters

string|array $values The value(s) to look for in the raw parameters (can be an array)
mixed $default The default value to return if no result is found

Return Value

mixed The option value

public string __toString()

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

Return Value

string

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Console/Input/StringInput.html