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) Constructor.
	bind(InputDefinition $definition) Binds the current Input instance with the given arguments and options.	from Input
	validate() Validates if arguments given are correct.	from Input
bool	isInteractive() Is this input means interactive?	from Input
	setInteractive(bool $interactive) Sets the input interactivity.	from Input
array	getArguments() Returns all the given arguments merged with the default values.	from Input
mixed	getArgument(string $name) Gets argument by 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 all the given options merged with the default values.	from Input
mixed	getOption(string $name) Gets an option by 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, bool $onlyParams = false) Returns true if the raw parameters (not parsed) contain a value.	from ArgvInput
mixed	getParameterOption(string\|array $values, mixed $default = false, bool $onlyParams = 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

__construct(string $input)

Constructor.

Parameters

string

$input

An array of parameters from the CLI (in the argv format)

bind(InputDefinition $definition)

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

Parameters

InputDefinition

$definition

A InputDefinition instance

validate()

Validates if arguments given are correct.

Throws an exception when not enough arguments are given.

Exceptions

RuntimeException

bool isInteractive()

Is this input means interactive?

Return Value

bool

setInteractive(bool $interactive)

Sets the input interactivity.

Parameters

bool

$interactive

If the input should be interactive

array getArguments()

Returns all the given arguments merged with the default values.

Return Value

array

mixed getArgument(string $name)

Gets argument by name.

Parameters

string

$name

The name of the argument

Return Value

mixed

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

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

array getOptions()

Returns all the given options merged with the default values.

Return Value

array

mixed getOption(string $name)

Gets an option by name.

Parameters

string

$name

The name of the option

Return Value

mixed

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

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

string escapeToken(string $token)

Escapes a token through escapeshellarg if it contains unsafe chars.

Parameters

string

$token

Return Value

string

string getFirstArgument()

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

Return Value

string

The value of the first argument or null otherwise

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.

Parameters

string\|array	$values	The values to look for in the raw parameters (can be an array)
bool	$onlyParams	Only check real parameters, skip those following an end of options (--) signal

Return Value

bool	true if the value is contained in the raw parameters

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.

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
bool	$onlyParams	Only check real parameters, skip those following an end of options (--) signal

Return Value

mixed

The option value

string __toString()

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

Return Value

string

Links:

http://api.symfony.com/master/Symfony/Component/Console/Input/StringInput.html

doc_Symfony

2016-10-28 06:33:15

Comments