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 FOFInput
+ Graphe d'héritage de FOFInput:

Fonctions membres publiques

 __construct ($source=null, array $options=array())
 
 get ($name, $default=null, $filter='cmd', $mask=0)
 
 getData ()
 
 __call ($name, $arguments)
 
- Fonctions membres publiques hérités de JInput
 __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 publiques statiques

static __callStatic ($name, $arguments)
 
static setVar ($name, $value=null, &$input=array(), $overwrite=true)
 

Fonctions membres protégées

 _cleanVar ($var, $mask=0, $type=null)
 
- Fonctions membres protégées hérités de JInput
 loadAllInputs ()
 

Membres hérités additionnels

- Attributs protégés hérités de JInput
 $options = array()
 
 $filter = null
 
 $data = array()
 
 $inputs = array()
 

Documentation des constructeurs et destructeur

◆ __construct()

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

Public constructor. Overridden to allow specifying the global input array to use as a string and instantiate from an objetc holding variables.

Paramètres
array | string | object | null$sourceSource data; set null to use $_REQUEST
array$optionsFilter options

Références $hash, JInput\$options, elseif, JRequest\get(), et null.

Documentation des fonctions membres

◆ __call()

__call (   $name,
  $arguments 
)

Magic method to get filtered input data.

Paramètres
mixed$nameName of the value to get.
string$argumentsDefault value to return if variable does not exist.
Renvoie
boolean The filtered boolean input value.

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

◆ __callStatic()

static __callStatic (   $name,
  $arguments 
)
static

Old static methods are now deprecated. This magic method makes sure there is a continuity in our approach. The downside is that it's only compatible with PHP 5.3.0. Sorry!

Paramètres
string$nameName of the method we're calling
array$argumentsThe arguments passed to the method
Renvoie
mixed

Références $default, $input, $key, $name, $type, et FOFPlatform\getInstance().

◆ _cleanVar()

_cleanVar (   $var,
  $mask = 0,
  $type = null 
)
protected

Custom filter implementation. Works better with arrays and allows the use of a filter mask.

Paramètres
mixed$varThe variable (value) to clean
integer$maskThe clean mask
string$typeThe variable type
Renvoie
mixed

Références $type, elseif, et null.

Référencé par get().

◆ get()

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

Gets a value from the input data. Overridden to allow specifying a filter mask.

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.
int$maskThe filter mask
Renvoie
mixed The filtered input value.

Références $default, JInput\$filter, $name, et _cleanVar().

◆ getData()

getData ( )

Returns a copy of the raw data stored in the class

Renvoie
array

Références JInput\$data.

◆ setVar()

static setVar (   $name,
  $value = null,
$input = array(),
  $overwrite = true 
)
static

Sets an input variable. WARNING: IT SHOULD NO LONGER BE USED!

Paramètres
string$nameThe name of the variable to set
mixed$valueThe value to set it to
array&$inputThe input array or FOFInput object
boolean$overwriteShould I overwrite existing values (default: true)
Renvoie
string Previous value
Obsolète:

Références $input, $name, $value, elseif, FOFPlatform\getInstance(), null, et JRequest\setVar().


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