Symfony\Component\Console\Input\InputInterface

interface InputInterface

Methods

string	getFirstArgument() Returns the first argument from the raw parameters (not parsed).
bool	hasParameterOption(string|array $values) Returns true if the raw parameters (not parsed) contain a value.
mixed	getParameterOption(string|array $values, mixed $default = 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

public string getFirstArgument()

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

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.

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.

public bind(InputDefinition $definition)

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

public validate()

Validates if arguments given are correct.

Throws an exception when not enough arguments are given.

public array getArguments()

Returns all the given arguments merged with the default values.

public mixed getArgument(string $name)

Gets argument by name.

public setArgument(string $name, string $value)

Sets an argument value by name.

public bool hasArgument(string|int $name)

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

public array getOptions()

Returns all the given options merged with the default values.

public mixed getOption(string $name)

Gets an option by name.

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

Sets an option value by name.

public bool hasOption(string $name)

Returns true if an InputOption object exists by name.

public bool isInteractive()

Is this input means interactive?

public setInteractive(bool $interactive)

Sets the input interactivity.