| Methods |
public
|
__construct(?InputDefinition $definition = null)
|
#
|
public
|
bind(InputDefinition $definition): void
Binds the current Input instance with the given arguments and options.
Binds the current Input instance with the given arguments and options.
Overriden by
Implements
|
#
|
abstract
protected
|
parse(): void
Processes command line arguments.
Processes command line arguments.
Implemented by
|
#
|
public
|
validate(): void
Validates the input.
|
#
|
public
|
isInteractive(): bool
Is this input means interactive?
Is this input means interactive?
Implements
|
#
|
public
|
setInteractive(bool $interactive): void
Sets the input interactivity.
Sets the input interactivity.
Implements
|
#
|
public
|
getArguments(): array
Returns all the given arguments merged with the default values.
Returns all the given arguments merged with the default values.
Implements
|
#
|
public
|
getArgument(string $name): mixed
Returns the argument value for a given argument name.
Returns the argument value for a given argument name.
Implements
|
#
|
public
|
setArgument(string $name, mixed $value): void
Sets an argument value by name.
Sets an argument value by name.
Implements
|
#
|
public
|
hasArgument(string $name): bool
Returns true if an InputArgument object exists by name or position.
Returns true if an InputArgument object exists by name or position.
Implements
|
#
|
public
|
getOptions(): array
Returns all the given options merged with the default values.
Returns all the given options merged with the default values.
Implements
|
#
|
public
|
getOption(string $name): mixed
Returns the option value for a given option name.
Returns the option value for a given option name.
Implements
|
#
|
public
|
setOption(string $name, mixed $value): void
Sets an option value by name.
Sets an option value by name.
Implements
|
#
|
public
|
hasOption(string $name): bool
Returns true if an InputOption object exists by name.
Returns true if an InputOption object exists by name.
Implements
|
#
|
public
|
escapeToken(string $token): string
Escapes a token through escapeshellarg if it contains unsafe chars.
Escapes a token through escapeshellarg if it contains unsafe chars.
|
#
|
public
|
setStream(resource $stream): void
Sets the input stream to read from when interacting with the user.
Sets the input stream to read from when interacting with the user.
This is mainly useful for testing purpose.
Parameters
Implements
|
#
|
public
|
getStream(): resource
Returns the input stream.
Returns the input stream.
Implements
|
#
|