W3cubDocs

/Symfony 2.8

Symfony\Component\Console\Input\Input

abstract class Input implements InputInterface

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()

Checks if the input is interactive.
setInteractive(bool $interactive)

Sets the input interactivity.
array getArguments()

Returns the argument 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 the options 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.

Details

public __construct(InputDefinition $definition = null)

Constructor.

Parameters

InputDefinition $definition A InputDefinition instance

public bind(InputDefinition $definition)

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

Parameters

InputDefinition $definition A InputDefinition instance

public validate()

Validates the input.

Exceptions

RuntimeException When not enough arguments are given

public bool isInteractive()

Checks if the input is interactive.

Return Value

bool Returns true if the input is interactive

public setInteractive(bool $interactive)

Sets the input interactivity.

Parameters

bool $interactive If the input should be interactive

public array getArguments()

Returns the argument values.

Return Value

array An array of argument values

public 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

public 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

public 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

public array getOptions()

Returns the options values.

Return Value

array An array of option values

public 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

public 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

public 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

public string escapeToken(string $token)

Escapes a token through escapeshellarg if it contains unsafe chars.

Parameters

string $token

Return Value

string

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Console/Input/Input.html