Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de l'interface InputInterface
+ Graphe d'héritage de InputInterface:

Fonctions membres publiques

 getFirstArgument ()
 
 hasParameterOption ($values, bool $onlyParams=false)
 
 getParameterOption ($values, $default=false, bool $onlyParams=false)
 
 bind (InputDefinition $definition)
 
 validate ()
 
 getArguments ()
 
 getArgument (string $name)
 
 setArgument (string $name, $value)
 
 hasArgument (string $name)
 
 getOptions ()
 
 getOption (string $name)
 
 setOption (string $name, $value)
 
 hasOption (string $name)
 
 isInteractive ()
 
 setInteractive (bool $interactive)
 

Description détaillée

InputInterface is the interface implemented by all input classes.

Auteur
Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des fonctions membres

◆ bind()

bind ( InputDefinition  $definition)

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

Exceptions
RuntimeException

Implémenté dans CompletionInput, et Input.

Référencé par Application\doRun(), AbstractCommand\execute(), et Command\run().

◆ getArgument()

getArgument ( string  $name)

Returns the argument value for a given argument name.

Renvoie
mixed
Exceptions
InvalidArgumentExceptionWhen argument given doesn't exist

Implémenté dans Input.

Référencé par HelpCommand\execute().

◆ getArguments()

getArguments ( )

Returns all the given arguments merged with the default values.

Renvoie
array<string|bool|int|float|array|null>

Implémenté dans Input.

◆ getFirstArgument()

getFirstArgument ( )

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

Renvoie
string|null

Implémenté dans ArgvInput, et ArrayInput.

◆ getOption()

getOption ( string  $name)

Returns the option value for a given option name.

Renvoie
mixed
Exceptions
InvalidArgumentExceptionWhen option given doesn't exist

Implémenté dans Input.

◆ getOptions()

getOptions ( )

Returns all the given options merged with the default values.

Renvoie
array<string|bool|int|float|array|null>

Implémenté dans Input.

◆ getParameterOption()

getParameterOption (   $values,
  $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.

Paramètres
string | array$valuesThe value(s) to look for in the raw parameters (can be an array)
string | bool | int | float | array | null$defaultThe default value to return if no result is found
bool$onlyParamsOnly check real parameters, skip those following an end of options (–) signal
Renvoie
mixed

Implémenté dans ArgvInput, et ArrayInput.

◆ hasArgument()

hasArgument ( string  $name)

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

Renvoie
bool

Implémenté dans Input.

◆ hasOption()

hasOption ( string  $name)

Returns true if an InputOption object exists by name.

Renvoie
bool

Implémenté dans Input.

◆ hasParameterOption()

hasParameterOption (   $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.

Paramètres
string | array$valuesThe values to look for in the raw parameters (can be an array)
bool$onlyParamsOnly check real parameters, skip those following an end of options (–) signal
Renvoie
bool

Implémenté dans ArgvInput, et ArrayInput.

◆ isInteractive()

isInteractive ( )

Is this input means interactive?

Renvoie
bool

Implémenté dans Input.

◆ setArgument()

setArgument ( string  $name,
  $value 
)

Sets an argument value by name.

Paramètres
mixed$valueThe argument value
Exceptions
InvalidArgumentExceptionWhen argument given doesn't exist

Implémenté dans Input.

◆ setInteractive()

setInteractive ( bool  $interactive)

Sets the input interactivity.

Implémenté dans Input.

◆ setOption()

setOption ( string  $name,
  $value 
)

Sets an option value by name.

Paramètres
mixed$valueThe option value
Exceptions
InvalidArgumentExceptionWhen option given doesn't exist

Implémenté dans Input.

◆ validate()

validate ( )

Validates the input.

Exceptions
RuntimeExceptionWhen not enough arguments are given

Implémenté dans Input.

Référencé par AbstractCommand\execute(), et Command\run().


La documentation de cette interface a été générée à partir du fichier suivant :