Input

__construct(InputDefinition $definition = null)

Constructor.

Parameters

InputDefinition

$definition

A InputDefinition instance

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

bool isInteractive()

Checks if the input is interactive.

Return Value

bool

setInteractive(bool $interactive)

Sets the input interactivity.

Parameters

bool

$interactive

If the input should be interactive

array getArguments()

Returns the argument values.

Return Value

array

mixed getArgument(string $name)

Returns the argument value for a given argument name.

Parameters

string

$name

The name of the argument

Return Value

mixed

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 the options values.

Return Value

array

mixed getOption(string $name)

Returns the option value for a given option name.

Parameters

string

$name

The name of the option

Return Value

mixed

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

string escapeToken(string $token)

Escapes a token through escapeshellarg if it contains unsafe chars.

Parameters

string

$token

Return Value

string