Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JObservable
+ Graphe d'héritage de JObservable:
+ Graphe de collaboration de JObservable:

Liste de tous les membres

Fonctions membres publiques

 __construct ()
 getState ()
 notify ()
 attach ($observer)
 detach ($observer)
- Fonctions membres publiques inherited from JObject
 __construct ($properties=null)
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)

Attributs protégés

 $_observers = array()
 $_state = null
 $_methods = array()
- Attributs protégés inherited from JObject
 $_errors = array()

Description détaillée

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


Documentation des constructeurs et destructeur

JObservable::__construct ( )

Constructor

Note: Make Sure it's not directly instantiated

Obsolète:
12.3

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

{
$this->_observers = array();
}

Documentation des fonctions membres

JObservable::attach (   $observer)

Attach an observer object

Paramètres:
object$observerAn observer object to attach
Renvoie:
void
Depuis:
11.1
Obsolète:
12.3

Définition à la ligne 104 du fichier observable.php.

{
if (is_array($observer))
{
if (!isset($observer['handler']) || !isset($observer['event']) || !is_callable($observer['handler']))
{
return;
}
// Make sure we haven't already attached this array as an observer
foreach ($this->_observers as $check)
{
if (is_array($check) && $check['event'] == $observer['event'] && $check['handler'] == $observer['handler'])
{
return;
}
}
$this->_observers[] = $observer;
end($this->_observers);
$methods = array($observer['event']);
}
else
{
if (!($observer instanceof JObserver))
{
return;
}
// Make sure we haven't already attached this object as an observer
$class = get_class($observer);
foreach ($this->_observers as $check)
{
if ($check instanceof $class)
{
return;
}
}
$this->_observers[] = $observer;
$methods = array_diff(get_class_methods($observer), get_class_methods('JPlugin'));
}
$key = key($this->_observers);
foreach ($methods as $method)
{
$method = strtolower($method);
if (!isset($this->_methods[$method]))
{
$this->_methods[$method] = array();
}
$this->_methods[$method][] = $key;
}
}
JObservable::detach (   $observer)

Detach an observer object

Paramètres:
object$observerAn observer object to detach.
Renvoie:
boolean True if the observer object was detached.
Depuis:
11.1
Obsolète:
12.3

Définition à la ligne 173 du fichier observable.php.

{
$retval = false;
$key = array_search($observer, $this->_observers);
if ($key !== false)
{
unset($this->_observers[$key]);
$retval = true;
foreach ($this->_methods as &$method)
{
$k = array_search($key, $method);
if ($k !== false)
{
unset($method[$k]);
}
}
}
return $retval;
}
JObservable::getState ( )

Get the state of the JObservable object

Renvoie:
mixed The state of the object.
Depuis:
11.1
Obsolète:
12.3

Définition à la ligne 70 du fichier observable.php.

{
return $this->_state;
}
JObservable::notify ( )

Update each attached observer object and return an array of their return values

Renvoie:
array Array of return values from the observers
Depuis:
11.1
Obsolète:
12.3

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

{
// Iterate through the _observers array
foreach ($this->_observers as $observer)
{
$return[] = $observer->update();
}
return $return;
}

Documentation des données membres

JObservable::$_methods = array()
protected

Définition à la ligne 48 du fichier observable.php.

JObservable::$_observers = array()
protected

Définition à la ligne 30 du fichier observable.php.

JObservable::$_state = null
protected

Définition à la ligne 39 du fichier observable.php.


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