| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 151 lines (4 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
InputInterface:: (15 methods):
getFirstArgument()
hasParameterOption()
getParameterOption()
bind()
validate()
getArguments()
getArgument()
setArgument()
hasArgument()
getOptions()
getOption()
setOption()
hasOption()
isInteractive()
setInteractive()
Interface: InputInterface - X-Ref
InputInterface is the interface implemented by all input classes.| getFirstArgument() X-Ref |
| Returns the first argument from the raw parameters (not parsed). return: string|null |
| hasParameterOption($values, bool $onlyParams = false) X-Ref |
| 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. param: string|array $values The values to look for in the raw parameters (can be an array) param: bool $onlyParams Only check real parameters, skip those following an end of options (--) signal return: bool |
| getParameterOption($values, $default = false, bool $onlyParams = false) X-Ref |
| 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. param: string|array $values The value(s) to look for in the raw parameters (can be an array) param: string|bool|int|float|array|null $default The default value to return if no result is found param: bool $onlyParams Only check real parameters, skip those following an end of options (--) signal return: mixed |
| bind(InputDefinition $definition) X-Ref |
| Binds the current Input instance with the given arguments and options. |
| validate() X-Ref |
| Validates the input. |
| getArguments() X-Ref |
| Returns all the given arguments merged with the default values. return: array<string|bool|int|float|array|null> |
| getArgument(string $name) X-Ref |
| Returns the argument value for a given argument name. return: mixed |
| setArgument(string $name, $value) X-Ref |
| Sets an argument value by name. param: mixed $value The argument value |
| hasArgument(string $name) X-Ref |
| Returns true if an InputArgument object exists by name or position. return: bool |
| getOptions() X-Ref |
| Returns all the given options merged with the default values. return: array<string|bool|int|float|array|null> |
| getOption(string $name) X-Ref |
| Returns the option value for a given option name. return: mixed |
| setOption(string $name, $value) X-Ref |
| Sets an option value by name. param: mixed $value The option value |
| hasOption(string $name) X-Ref |
| Returns true if an InputOption object exists by name. return: bool |
| isInteractive() X-Ref |
| Is this input means interactive? return: bool |
| setInteractive(bool $interactive) X-Ref |
| Sets the input interactivity. |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |