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 publiques statiques | Fonctions membres protégées | Attributs protégés | Attributs protégés statiques
Référence de la classe JRegistry
+ Graphe d'héritage de JRegistry:
+ Graphe de collaboration de JRegistry:

Liste de tous les membres

Fonctions membres publiques

 __construct ($data=null)
 __clone ()
 __toString ()
 jsonSerialize ()
 def ($key, $default= '')
 exists ($path)
 get ($path, $default=null)
 loadArray ($array)
 loadObject ($object)
 loadFile ($file, $format= 'JSON', $options=array())
 loadString ($data, $format= 'JSON', $options=array())
 merge ($source)
 set ($path, $value)
 toArray ()
 toObject ()
 toString ($format= 'JSON', $options=array())

Fonctions membres publiques statiques

static getInstance ($id)

Fonctions membres protégées

 bindData ($parent, $data)
 asArray ($data)

Attributs protégés

 $data

Attributs protégés statiques

static $instances = array()

Description détaillée

Définition à la ligne 21 du fichier registry.php.

Documentation des constructeurs et destructeur

JRegistry::__construct (   $data = null)

Constructor

Paramètres:
mixed$dataThe data to bind to the new JRegistry object.
Depuis:
11.1

Définition à la ligne 44 du fichier registry.php.

{
// Instantiate the internal data object.
$this->data = new stdClass;
// Optionally load supplied data.
if (is_array($data) || is_object($data))
{
$this->bindData($this->data, $data);
}
elseif (!empty($data) && is_string($data))
{
$this->loadString($data);
}
}

Documentation des fonctions membres

JRegistry::__clone ( )

Magic function to clone the registry object.

Renvoie:
JRegistry
Depuis:
11.1

Définition à la ligne 67 du fichier registry.php.

{
$this->data = unserialize(serialize($this->data));
}
JRegistry::__toString ( )

Magic function to render this object as a string using default args of toString method.

Renvoie:
string
Depuis:
11.1

Définition à la ligne 79 du fichier registry.php.

{
return $this->toString();
}
JRegistry::asArray (   $data)
protected

Method to recursively convert an object of data to an array.

Paramètres:
object$dataAn object of data to return as an array.
Renvoie:
array Array representation of the input object.
Depuis:
11.1

Définition à la ligne 458 du fichier registry.php.

{
$array = array();
foreach (get_object_vars((object) $data) as $k => $v)
{
if (is_object($v))
{
$array[$k] = $this->asArray($v);
}
else
{
$array[$k] = $v;
}
}
return $array;
}
JRegistry::bindData (   $parent,
  $data 
)
protected

Method to recursively bind data to a parent object.

Paramètres:
object$parentThe parent object on which to attach the data values.
mixed$dataAn array or object of data to bind to the parent object.
Renvoie:
void
Depuis:
11.1

Définition à la ligne 423 du fichier registry.php.

Références JArrayHelper\isAssociative().

{
// Ensure the input data is an array.
if (is_object($data))
{
$data = get_object_vars($data);
}
else
{
$data = (array) $data;
}
foreach ($data as $k => $v)
{
if ((is_array($v) && JArrayHelper::isAssociative($v)) || is_object($v))
{
$parent->$k = new stdClass;
$this->bindData($parent->$k, $v);
}
else
{
$parent->$k = $v;
}
}
}

+ Voici le graphe d'appel pour cette fonction :

JRegistry::def (   $key,
  $default = '' 
)

Sets a default value if not already assigned.

Paramètres:
string$keyThe name of the parameter.
mixed$defaultAn optional value for the parameter.
Renvoie:
mixed The value set, or the default if the value was not previously set (or null).
Depuis:
11.1

Définition à la ligne 108 du fichier registry.php.

Référencé par JLinkedinOauth\__construct(), JTwitterOAuth\__construct(), JOpenstreetmapOauth\__construct(), et JFacebookOAuth\__construct().

{
$value = $this->get($key, $default);
$this->set($key, $value);
return $value;
}

+ Voici le graphe des appelants de cette fonction :

JRegistry::exists (   $path)

Check if a registry path exists.

Paramètres:
string$pathRegistry path (e.g. joomla.content.showauthor)
Renvoie:
boolean
Depuis:
11.1

Définition à la ligne 125 du fichier registry.php.

{
// Explode the registry path into an array
if ($nodes = explode('.', $path))
{
// Initialize the current node to be the registry root.
$node = $this->data;
// Traverse the registry to find the correct node for the result.
for ($i = 0, $n = count($nodes); $i < $n; $i++)
{
if (isset($node->$nodes[$i]))
{
$node = $node->$nodes[$i];
}
else
{
break;
}
if ($i + 1 == $n)
{
return true;
}
}
}
return false;
}
JRegistry::get (   $path,
  $default = null 
)

Get a registry value.

Paramètres:
string$pathRegistry path (e.g. joomla.content.showauthor)
mixed$defaultOptional default value, returned if the internal value is null.
Renvoie:
mixed Value of entry or null
Depuis:
11.1

Définition à la ligne 165 du fichier registry.php.

{
$result = $default;
if (!strpos($path, '.'))
{
return (isset($this->data->$path) && $this->data->$path !== null && $this->data->$path !== '') ? $this->data->$path : $default;
}
// Explode the registry path into an array
$nodes = explode('.', $path);
// Initialize the current node to be the registry root.
$node = $this->data;
$found = false;
// Traverse the registry to find the correct node for the result.
foreach ($nodes as $n)
{
if (isset($node->$n))
{
$node = $node->$n;
$found = true;
}
else
{
$found = false;
break;
}
}
if ($found && $node !== null && $node !== '')
{
$result = $node;
}
return $result;
}
static JRegistry::getInstance (   $id)
static

Returns a reference to a global JRegistry object, only creating it if it doesn't already exist.

This method must be invoked as: 

$registry = JRegistry::getInstance($id);
Paramètres:
string$idAn ID for the registry instance
Renvoie:
JRegistry The JRegistry object.
Depuis:
11.1

Définition à la ligne 217 du fichier registry.php.

{
if (empty(self::$instances[$id]))
{
self::$instances[$id] = new JRegistry;
}
return self::$instances[$id];
}
JRegistry::jsonSerialize ( )

Implementation for the JsonSerializable interface. Allows us to pass JRegistry objects to json_encode.

Renvoie:
object
Depuis:
12.2
Note:
The interface is only present in PHP 5.4 and up.

Implémente JsonSerializable.

Définition à la ligne 93 du fichier registry.php.

{
return $this->data;
}
JRegistry::loadArray (   $array)

Load a associative array of values into the default namespace

Paramètres:
array$arrayAssociative array of value to load
Renvoie:
boolean True on success
Depuis:
11.1

Définition à la ligne 236 du fichier registry.php.

Référencé par JTableMenu\bind(), JTableUpdate\bind(), JTableExtension\bind(), JTableUser\bind(), JTableContent\bind(), JTableModule\bind(), et JTableCategory\bind().

{
$this->bindData($this->data, $array);
return true;
}

+ Voici le graphe des appelants de cette fonction :

JRegistry::loadFile (   $file,
  $format = 'JSON',
  $options = array() 
)

Load the contents of a file into the registry

Paramètres:
string$filePath to file to load
string$formatFormat of the file [optional: defaults to JSON]
array$optionsOptions used by the formatter
Renvoie:
boolean True on success
Depuis:
11.1

Définition à la ligne 270 du fichier registry.php.

{
$data = file_get_contents($file);
return $this->loadString($data, $format, $options);
}
JRegistry::loadObject (   $object)

Load the public variables of the object into the default namespace.

Paramètres:
object$objectThe object holding the publics to load
Renvoie:
boolean True on success
Depuis:
11.1

Définition à la ligne 252 du fichier registry.php.

{
$this->bindData($this->data, $object);
return true;
}
JRegistry::loadString (   $data,
  $format = 'JSON',
  $options = array() 
)

Load a string into the registry

Paramètres:
string$dataString to load into the registry
string$formatFormat of the string
array$optionsOptions used by the formatter
Renvoie:
boolean True on success
Depuis:
11.1

Définition à la ligne 288 du fichier registry.php.

Références JRegistryFormat\getInstance().

Référencé par JModelAdmin\getItem(), JApplication\initialise(), JDocumentRendererModule\render(), et JUser\save().

{
// Load a string into the given namespace [or default namespace if not given]
$handler = JRegistryFormat::getInstance($format);
$obj = $handler->stringToObject($data, $options);
$this->loadObject($obj);
return true;
}

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JRegistry::merge (   $source)

Merge a JRegistry object into this one

Paramètres:
JRegistry$sourceSource JRegistry object to merge.
Renvoie:
boolean True on success
Depuis:
11.1

Définition à la ligne 308 du fichier registry.php.

{
if (!$source instanceof JRegistry)
{
return false;
}
// Load the variables into the registry's default namespace.
foreach ($source->toArray() as $k => $v)
{
if (($v !== null) && ($v !== ''))
{
$this->data->$k = $v;
}
}
return true;
}
JRegistry::set (   $path,
  $value 
)

Set a registry value.

Paramètres:
string$pathRegistry Path (e.g. joomla.content.showauthor)
mixed$valueValue of entry
Renvoie:
mixed The value of the that has been set.
Depuis:
11.1

Explode the registry path into an array and remove empty nodes caused by passing in double dotted strings. ex: joomla..test. Finally, re-key the array so it is sequential.

Définition à la ligne 337 du fichier registry.php.

{
$result = null;
/**
* Explode the registry path into an array and remove empty
* nodes caused by passing in double dotted strings. ex: joomla..test.
* Finally, re-key the array so it is sequential.
*/
$nodes = array_values(array_filter(explode('.', $path), 'strlen'));
if ($nodes)
{
// Initialize the current node to be the registry root.
$node = $this->data;
// Traverse the registry to find the correct node for the result.
for ($i = 0, $n = count($nodes) - 1; $i < $n; $i++)
{
if (!isset($node->$nodes[$i]) && ($i != $n))
{
$node->$nodes[$i] = new stdClass;
}
$node = (object) $node->$nodes[$i];
}
// Get the old value if exists so we can return it
$result = $node->$nodes[$i] = $value;
}
return $result;
}
JRegistry::toArray ( )

Transforms a namespace to an array

Renvoie:
array An associative array holding the namespace data
Depuis:
11.1

Définition à la ligne 378 du fichier registry.php.

Référencé par JForm\bind().

{
return (array) $this->asArray($this->data);
}

+ Voici le graphe des appelants de cette fonction :

JRegistry::toObject ( )

Transforms a namespace to an object

Renvoie:
object An an object holding the namespace data
Depuis:
11.1

Définition à la ligne 390 du fichier registry.php.

{
return $this->data;
}
JRegistry::toString (   $format = 'JSON',
  $options = array() 
)

Get a namespace in a given string format

Paramètres:
string$formatFormat to return the string in
mixed$optionsParameters used by the formatter, see formatters for more info
Renvoie:
string Namespace in string format
Depuis:
11.1

Définition à la ligne 405 du fichier registry.php.

Références JRegistryFormat\getInstance().

{
// Return a namespace in a given format
$handler = JRegistryFormat::getInstance($format);
return $handler->objectToString($this->data, $options);
}

+ Voici le graphe d'appel pour cette fonction :

Documentation des données membres

JRegistry::$data
protected

Définition à la ligne 29 du fichier registry.php.

JRegistry::$instances = array()
staticprotected

Définition à la ligne 35 du fichier registry.php.

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