InputInterface

interface InputInterface

InputInterface is the interface implemented by all input classes.

Methods

string	getFirstArgument() Returns the first argument from the raw parameters (not parsed).
bool	hasParameterOption(string\|array $values, bool $onlyParams = false) Returns true if the raw parameters (not parsed) contain a value.
mixed	getParameterOption(string\|array $values, mixed $default = false, bool $onlyParams = false) Returns the value of a raw option (not parsed).
	bind(InputDefinition $definition) Binds the current Input instance with the given arguments and options.
	validate() Validates the input.
array	getArguments() Returns all the given arguments merged with the default values.
mixed	getArgument(string $name) Returns the argument value for a given argument name.
	setArgument(string $name, string $value) Sets an argument value by name.
bool	hasArgument(string\|int $name) Returns true if an InputArgument object exists by name or position.
array	getOptions() Returns all the given options merged with the default values.
mixed	getOption(string $name) Returns the option value for a given option name.
	setOption(string $name, string\|bool $value) Sets an option value by name.
bool	hasOption(string $name) Returns true if an InputOption object exists by name.
bool	isInteractive() Is this input means interactive?
	setInteractive(bool $interactive) Sets the input interactivity.

Details

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

bind(InputDefinition $definition)

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

Parameters

InputDefinition

$definition

A InputDefinition instance

validate()

Validates the input.

Exceptions

RuntimeException

When not enough arguments are given

array getArguments()

Returns all the given arguments merged with the default values.

Return Value

array

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

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)

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

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

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

Links:

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

doc_Symfony

2016-10-28 06:21:20

Comments