Docs For Class JObserverUpdater

Description

Implements interfaces:

JObserverUpdaterInterface

Observer updater pattern implementation for Joomla

link: http://docs.joomla.org/JObserverUpdater
since: 3.1.2

Located in /libraries/joomla/observer/updater.php (line 20)

Variable Summary

boolean $doCallObservers

JObserverInterface $observers

Method Summary

JObserverUpdater __construct (JObservableInterface $observable)

void attachObserver (JObserverInterface $observer)

boolean doCallObservers (boolean $enabled)

JTableObserver|null getObserverOfClass (string $observerClass)

void update (string $event, array $params)

Variables

boolean $doCallObservers = true (line 36)

Process observers (useful when a class extends significantly an observerved method, and calls observers itself

since: 3.1.2
access: protected

JObserverInterface $observers = array() (line 28)

Generic JObserverInterface observers for this JObservableInterface

since: 3.1.2
access: protected

Methods

Constructor __construct (line 45)

Constructor

since: 3.1.2
access: public

JObserverUpdater __construct (JObservableInterface $observable)

JObservableInterface $observable: The observable subject object

Implementation of:

JObserverUpdaterInterface::__construct(): Constructor

attachObserver (line 60)

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

since: 3.1.2
access: public

void attachObserver (JObserverInterface $observer)

JObserverInterface $observer: The observer object

Implementation of:

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

doCallObservers (line 119)

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

return: Returns old state
since: 3.1.2
access: public

boolean doCallObservers (boolean $enabled)

boolean $enabled: Enable (true) or Disable (false) the observer events

Implementation of:

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

getObserverOfClass (line 74)

Gets the instance of the observer of class $observerClass

return: The observer object of this class if any
since: 3.1.2
access: public

JTableObserver|null getObserverOfClass (string $observerClass)

string $observerClass: The class name of the observer

update (line 94)

Call all observers for $event with $params

since: 3.1.2
access: public

void update (string $event, array $params)

string $event: Name of the event
array $params: Params of the event

Implementation of:

JObserverUpdaterInterface::update(): Call all observers for $event with $params