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

Liste de tous les membres

Fonctions membres publiques

 __construct (JObservableInterface $observable)
 attachObserver (JObserverInterface $observer)
 getObserverOfClass ($observerClass)
 update ($event, $params)
 doCallObservers ($enabled)

Attributs protégés

 $observers = array()
 $doCallObservers = true

Description détaillée

Définition à la ligne 20 du fichier updater.php.


Documentation des constructeurs et destructeur

JObserverUpdater::__construct ( JObservableInterface  $observable)

Constructor

Paramètres:
JObservableInterface$observableThe observable subject object
Depuis:
3.1.2

Implémente JObserverUpdaterInterface.

Définition à la ligne 45 du fichier updater.php.

{
// Not yet needed, but possible: $this->observable = $observable;
}

Documentation des fonctions membres

JObserverUpdater::attachObserver ( JObserverInterface  $observer)

Adds an observer to the JObservableInterface instance updated by this This method can be called fron JObservableInterface::attachObserver

Paramètres:
JObserverInterface$observerThe observer object
Renvoie:
void
Depuis:
3.1.2

Implémente JObserverUpdaterInterface.

Définition à la ligne 60 du fichier updater.php.

{
$this->observers[get_class($observer)] = $observer;
}
JObserverUpdater::doCallObservers (   $enabled)

Enable/Disable calling of observers (this is useful when calling parent:: function

Paramètres:
boolean$enabledEnable (true) or Disable (false) the observer events
Renvoie:
boolean Returns old state
Depuis:
3.1.2

Implémente JObserverUpdaterInterface.

Définition à la ligne 119 du fichier updater.php.

{
$this->doCallObservers = $enabled;
return $oldState;
}
JObserverUpdater::getObserverOfClass (   $observerClass)

Gets the instance of the observer of class $observerClass

Paramètres:
string$observerClassThe class name of the observer
Renvoie:
JTableObserver|null The observer object of this class if any
Depuis:
3.1.2

Définition à la ligne 74 du fichier updater.php.

{
if (isset($this->observers[$observerClass]))
{
return $this->observers[$observerClass];
}
return null;
}
JObserverUpdater::update (   $event,
  $params 
)

Call all observers for $event with $params

Paramètres:
string$eventName of the event
array$paramsParams of the event
Renvoie:
void
Depuis:
3.1.2

Implémente JObserverUpdaterInterface.

Définition à la ligne 94 du fichier updater.php.

{
if ($this->doCallObservers)
{
foreach ($this->observers as $observer)
{
$eventListener = array($observer, $event);
if (is_callable($eventListener))
{
call_user_func_array($eventListener, $params);
}
}
}
}

Documentation des données membres

JObserverUpdater::$doCallObservers = true
protected

Définition à la ligne 36 du fichier updater.php.

JObserverUpdater::$observers = array()
protected

Définition à la ligne 28 du fichier updater.php.


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