class Input implements InputInterface, StreamableInputInterface

Input is the base class for all concrete Input classes.

Three concrete classes are provided by default:

  • ArgvInput: The input comes from the CLI arguments (argv)
  • StringInput: The input is provided as a string
  • ArrayInput: The input is provided as an array

Methods

__construct(InputDefinition $definition = null)

Constructor.

bind(InputDefinition $definition)

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

validate()

Validates the input.

bool
isInteractive()

Is this input means interactive?

setInteractive(bool $interactive)

Sets the input interactivity.

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.

string
escapeToken(string $token)

Escapes a token through escapeshellarg if it contains unsafe chars.

setStream(resource $stream)

Sets the input stream to read from when interacting with the user.

resource|null
getStream()

Returns the input stream.

Details

at line line 44
__construct(InputDefinition $definition = null)

Constructor.

Parameters

InputDefinition $definition A InputDefinition instance

at line line 57
bind(InputDefinition $definition)

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

Parameters

InputDefinition $definition A InputDefinition instance

at line line 74
validate()

Validates the input.

Exceptions

RuntimeException When not enough arguments are given

at line line 91
bool isInteractive()

Is this input means interactive?

Return Value

bool

at line line 99
setInteractive(bool $interactive)

Sets the input interactivity.

Parameters

bool $interactive If the input should be interactive

at line line 107
array getArguments()

Returns all the given arguments merged with the default values.

Return Value

array

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

at line line 127
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 139
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 147
array getOptions()

Returns all the given options merged with the default values.

Return Value

array

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

at line line 167
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 179
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 191
string escapeToken(string $token)

Escapes a token through escapeshellarg if it contains unsafe chars.

Parameters

string $token

Return Value

string

at line line 199
setStream(resource $stream)

Sets the input stream to read from when interacting with the user.

This is mainly useful for testing purpose.

Parameters

resource $stream The input stream

at line line 207
resource|null getStream()

Returns the input stream.

Return Value

resource|null