1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. Console
  7. \
  8. Input
  9. \
  10. StreamableInputInterface

StreamableInputInterface

interface StreamableInputInterface implements InputInterface

StreamableInputInterface is the interface implemented by all input classes that have an input stream.

Methods

string|null
getFirstArgument()

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

from InputInterface
bool
hasParameterOption(string|array $values, bool $onlyParams = false)

Returns true if the raw parameters (not parsed) contain a value.

from InputInterface
mixed
getParameterOption(string|array $values, mixed $default = false, bool $onlyParams = false)

Returns the value of a raw option (not parsed).

from InputInterface
bind(InputDefinition $definition)

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

from InputInterface
validate()

Validates the input.

from InputInterface
array
getArguments()

Returns all the given arguments merged with the default values.

from InputInterface
string|string[]|null
getArgument(string $name)

Returns the argument value for a given argument name.

from InputInterface
setArgument(string $name, string|string[]|null $value)

Sets an argument value by name.

from InputInterface
bool
hasArgument(string|int $name)

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

from InputInterface
array
getOptions()

Returns all the given options merged with the default values.

from InputInterface
string|string[]|bool|null
getOption(string $name)

Returns the option value for a given option name.

from InputInterface
setOption(string $name, string|string[]|bool|null $value)

Sets an option value by name.

from InputInterface
bool
hasOption(string $name)

Returns true if an InputOption object exists by name.

from InputInterface
bool
isInteractive()

Is this input means interactive?

from InputInterface
setInteractive(bool $interactive)

Sets the input interactivity.

from InputInterface
setStream(resource $stream)

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

resource|null
getStream()

Returns the input stream.

Details

string|null getFirstArgument()

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

Return Value

string|null 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. Does not necessarily return the correct result for short options when multiple flags are combined in the same option.

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. Does not necessarily return the correct result for short options when multiple flags are combined in the same option.

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

Exceptions

RuntimeException

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

string|string[]|null getArgument(string $name)

Returns the argument value for a given argument name.

Parameters

string $name The argument name

Return Value

string|string[]|null The argument value

Exceptions

InvalidArgumentException When argument given doesn't exist

setArgument(string $name, string|string[]|null $value)

Sets an argument value by name.

Parameters

string $name The argument name
string|string[]|null $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

string|string[]|bool|null getOption(string $name)

Returns the option value for a given option name.

Parameters

string $name The option name

Return Value

string|string[]|bool|null The option value

Exceptions

InvalidArgumentException When option given doesn't exist

setOption(string $name, string|string[]|bool|null $value)

Sets an option value by name.

Parameters

string $name The option name
string|string[]|bool|null $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

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

resource|null getStream()

Returns the input stream.

Return Value

resource|null