Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres protégées | Attributs protégés
Référence de la classe JInput
+ Graphe d'héritage de JInput:

Liste de tous les membres

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()

Description détaillée

Définition à la ligne 41 du fichier input.php.

Documentation des constructeurs et destructeur

JInput::__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

Définition à la ligne 83 du fichier input.php.

Références JFilterInput\getInstance().

{
if (isset($options['filter']))
{
$this->filter = $options['filter'];
}
else
{
$this->filter = JFilterInput::getInstance();
}
if (is_null($source))
{
$this->data = &$_REQUEST;
}
else
{
$this->data = $source;
}
// Set the options for the class.
$this->options = $options;
}

+ Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

JInput::__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

Définition à la ligne 277 du fichier input.php.

{
if (substr($name, 0, 3) == 'get')
{
$filter = substr($name, 3);
$default = null;
if (isset($arguments[1]))
{
$default = $arguments[1];
}
return $this->get($arguments[0], $default, $filter);
}
}
JInput::__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

Définition à la ligne 116 du fichier input.php.

Références $GLOBALS.

{
if (isset($this->inputs[$name]))
{
return $this->inputs[$name];
}
$className = 'JInput' . ucfirst($name);
if (class_exists($className))
{
$this->inputs[$name] = new $className(null, $this->options);
return $this->inputs[$name];
}
$superGlobal = '_' . strtoupper($name);
if (isset($GLOBALS[$superGlobal]))
{
$this->inputs[$name] = new JInput($GLOBALS[$superGlobal], $this->options);
return $this->inputs[$name];
}
// TODO throw an exception
}
JInput::count ( )

Get the number of variables.

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

Définition à la ligne 152 du fichier input.php.

{
return count($this->data);
}
JInput::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

Définition à la ligne 257 du fichier input.php.

{
if (isset($this->data[$name]))
{
return;
}
$this->data[$name] = $value;
}
JInput::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éimplémentée dans JInputFiles.

Définition à la ligne 168 du fichier input.php.

{
if (isset($this->data[$name]))
{
return $this->filter->clean($this->data[$name], $filter);
}
return $default;
}
JInput::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

Définition à la ligne 190 du fichier input.php.

{
if (empty($vars) && is_null($datasource))
{
$vars = $this->data;
}
$results = array();
foreach ($vars as $k => $v)
{
if (is_array($v))
{
if (is_null($datasource))
{
$results[$k] = $this->getArray($v, $this->get($k, null, 'array'));
}
else
{
$results[$k] = $this->getArray($v, $datasource[$k]);
}
}
else
{
if (is_null($datasource))
{
$results[$k] = $this->get($k, null, $v);
}
elseif (isset($datasource[$k]))
{
$results[$k] = $this->filter->clean($datasource[$k], $v);
}
else
{
$results[$k] = $this->filter->clean(null, $v);
}
}
}
return $results;
}
JInput::getMethod ( )

Gets the request method.

Renvoie:
string The request method.
Depuis:
11.1

Définition à la ligne 301 du fichier input.php.

{
$method = strtoupper($_SERVER['REQUEST_METHOD']);
return $method;
}
JInput::loadAllInputs ( )
protected

Method to load all of the global inputs.

Renvoie:
void
Depuis:
12.1

Définition à la ligne 361 du fichier input.php.

Références $GLOBALS.

{
static $loaded = false;
if (!$loaded)
{
// Load up all the globals.
foreach ($GLOBALS as $global => $data)
{
// Check if the global starts with an underscore.
if (strpos($global, '_') === 0)
{
// Convert global name to input name.
$global = strtolower($global);
$global = substr($global, 1);
// Get the input.
$this->$global;
}
}
$loaded = true;
}
}
JInput::serialize ( )

Method to serialize the input.

Renvoie:
string The serialized input.
Depuis:
12.1

Réimplémentée dans JInputCli.

Définition à la ligne 315 du fichier input.php.

{
// Load all of the inputs.
$this->loadAllInputs();
// Remove $_ENV and $_SERVER from the inputs.
$inputs = $this->inputs;
unset($inputs['env']);
unset($inputs['server']);
// Serialize the options, data, and inputs.
return serialize(array($this->options, $this->data, $inputs));
}
JInput::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éimplémentée dans JInputFiles.

Définition à la ligne 242 du fichier input.php.

{
$this->data[$name] = $value;
}
JInput::unserialize (   $input)

Method to unserialize the input.

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

Réimplémentée dans JInputCli.

Définition à la ligne 338 du fichier input.php.

Références JFilterInput\getInstance().

{
// Unserialize the options, data, and inputs.
list($this->options, $this->data, $this->inputs) = unserialize($input);
// Load the filter.
if (isset($this->options['filter']))
{
$this->filter = $this->options['filter'];
}
else
{
$this->filter = JFilterInput::getInstance();
}
}

+ Voici le graphe d'appel pour cette fonction :

Documentation des données membres

JInput::$data = array()
protected

Définition à la ligne 65 du fichier input.php.

JInput::$filter = null
protected

Définition à la ligne 57 du fichier input.php.

JInput::$inputs = array()
protected

Définition à la ligne 73 du fichier input.php.

JInput::$options = array()
protected

Définition à la ligne 49 du fichier input.php.

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