InputInterface is the interface implemented by all input classes.
- author Fabien Potencier
- Implements
Stringable
Methods |
public abstract __toString() : string Returns a stringified representation of the args passed to the command. InputArguments MUST be escaped as well as the InputOption values passed to the command. |
public abstract bind(Symfony Binds the current Input instance with the given arguments and options.
|
public abstract getArgument(string $name) : ?mixed Returns the argument value for a given argument name.
|
public abstract getArguments() : array Returns all the given arguments merged with the default values.
|
public abstract getFirstArgument() : ?string Returns the first argument from the raw parameters (not parsed). |
public abstract getOption(string $name) : ?mixed Returns the option value for a given option name.
|
public abstract getOptions() : array Returns all the given options merged with the default values.
|
public abstract getParameterOption(array|string $values, array|string|int|float|bool|?null $default = false, bool $onlyParams = false) : ?mixed 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.
|
public abstract hasArgument(string $name) : bool Returns true if an InputArgument object exists by name or position. |
public abstract hasOption(string $name) : bool Returns true if an InputOption object exists by name. |
public abstract hasParameterOption(array|string $values, bool $onlyParams = false) : bool 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.
|
public abstract isInteractive() : bool Is this input means interactive? |
public abstract setArgument(string $name, ?mixed $value) : void Sets an argument value by name.
|
public abstract setInteractive(bool $interactive) : void Sets the input interactivity. |
public abstract setOption(string $name, ?mixed $value) : void Sets an option value by name.
|
public abstract validate() : void Validates the input.
|