Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JInput
+ Graphe d'héritage de JInput:

Fonctions membres publiques

 __construct ($source=null, array $options=array())
 
 __get ($name)
 
 count ()
 
 get ($name, $default=null, $filter='cmd')
 
 getArray (array $vars=array(), $datasource=null)
 
 set ($name, $value)
 
 def ($name, $value)
 
 __call ($name, $arguments)
 
 getMethod ()
 
 serialize ()
 
 unserialize ($input)
 

Fonctions membres protégées

 loadAllInputs ()
 

Attributs protégés

 $options = array()
 
 $filter = null
 
 $data = array()
 
 $inputs = array()
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $source = null,
array  $options = array() 
)

Constructor.

Paramètres
array$sourceSource data (Optional, default is $_REQUEST)
array$optionsArray of configuration parameters (Optional)
Depuis
11.1

Références $options.

Documentation des fonctions membres

◆ __call()

__call (   $name,
  $arguments 
)

Magic method to get filtered input data.

Paramètres
string$nameName of the filter type prefixed with 'get'.
array$arguments[0] The name of the variable [1] The default value.
Renvoie
mixed The filtered input value.
Depuis
11.1

Références $default, $filter, $name, et null.

◆ __get()

__get (   $name)

Magic method to get an input object

Paramètres
mixed$nameName of the input object to retrieve.
Renvoie
JInput The request input object
Depuis
11.1

Références $className, $GLOBALS, $name, et null.

◆ count()

count ( )

Get the number of variables.

Renvoie
integer The number of variables in the input.
Depuis
12.2
Voir également
Countable::count()

◆ def()

def (   $name,
  $value 
)

Define a value. The value will only be set if there's no value for the name or if it is null.

Paramètres
string$nameName of the value to define.
mixed$valueValue to assign to the input.
Renvoie
void
Depuis
12.1

Références $name, et $value.

◆ get()

get (   $name,
  $default = null,
  $filter = 'cmd' 
)

Gets a value from the input data.

Paramètres
string$nameName of the value to get.
mixed$defaultDefault value to return if variable does not exist.
string$filterFilter to apply to the value.
Renvoie
mixed The filtered input value.
Depuis
11.1

Références $default, $filter, et $name.

◆ getArray()

getArray ( array  $vars = array(),
  $datasource = null 
)

Gets an array of values from the request.

Paramètres
array$varsAssociative array of keys and filter types to apply. If empty and datasource is null, all the input data will be returned but filtered using the default case in JFilterInput::clean.
mixed$datasourceArray to retrieve data from, or null
Renvoie
mixed The filtered input data.
Depuis
11.1

Références $data, $results, elseif, et null.

◆ getMethod()

getMethod ( )

Gets the request method.

Renvoie
string The request method.
Depuis
11.1

◆ loadAllInputs()

loadAllInputs ( )
protected

Method to load all of the global inputs.

Renvoie
void
Depuis
12.1

Références $data, et $GLOBALS.

◆ serialize()

serialize ( )

Method to serialize the input.

Renvoie
string The serialized input.
Depuis
12.1

◆ set()

set (   $name,
  $value 
)

Sets a value

Paramètres
string$nameName of the value to set.
mixed$valueValue to assign to the input.
Renvoie
void
Depuis
11.1

Références $name, et $value.

◆ unserialize()

unserialize (   $input)

Method to unserialize the input.

Paramètres
string$inputThe serialized input.
Renvoie
JInput The input object.
Depuis
12.1

Références $input.

Documentation des champs

◆ $data

$data = array()
protected

Référencé par FOFInput\getData().

◆ $filter

$filter = null
protected

Référencé par FOFInput\__call(), et FOFInput\get().

◆ $inputs

$inputs = array()
protected

◆ $options

$options = array()
protected

Référencé par FOFInput\__construct().


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