1. interface
  2. Symfony
  3. Component
  4. Console
  5. Input
  6. InputInterface

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 if arguments given are correct.

array
getArguments()

Returns all the given arguments merged with the default values.

mixed
getArgument(string $name)

Gets argument by 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)

Gets an option by 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

at line line 26
string getFirstArgument()

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

Return Value

string The value of the first argument or null otherwise

at line line 39
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

at line line 53
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

at line line 60
bind(InputDefinition $definition)

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

Parameters

InputDefinition $definition A InputDefinition instance

at line line 69
validate()

Validates if arguments given are correct.

Throws an exception when not enough arguments are given.

Exceptions

RuntimeException

at line line 76
array getArguments()

Returns all the given arguments merged with the default values.

Return Value

array

at line line 85
mixed getArgument(string $name)

Gets argument by name.

Parameters

string $name The name of the argument

Return Value

mixed

at line line 95
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

at line line 104
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

at line line 111
array getOptions()

Returns all the given options merged with the default values.

Return Value

array

at line line 120
mixed getOption(string $name)

Gets an option by name.

Parameters

string $name The name of the option

Return Value

mixed

at line line 130
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

at line line 139
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

at line line 146
bool isInteractive()

Is this input means interactive?

Return Value

bool

at line line 153
setInteractive(bool $interactive)

Sets the input interactivity.

Parameters

bool $interactive If the input should be interactive