Docs for class JObservable

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

JObservable

Description

Abstract observable class to implement the observer design pattern

since: 1.5
author: Louis Landry <[email protected]>
abstract:

Located in /joomla/base/observer.php (line 70)

 JObject

 JObservable   (Subpackage Base)

Direct descendents

Class	Description
JEditor	JEditor class to handle WYSIWYG editors
JEventDispatcher	Class to handle dispatching of events.

Method Summary

JObservable __construct ()

void attach ( &$observer, object $observer)

boolean detach (object $observer)

mixed getState ()

array notify ()

Methods

Constructor __construct (line 92)

Constructor

JObservable __construct ()

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

Redefined in descendants as:

JEditor::__construct() : constructor
JEventDispatcher::__construct() : Constructor

attach (line 131)

Attach an observer object

since: 1.5
access: public

void attach ( &$observer, object $observer)

object $observer: An observer object to attach
&$observer

detach (line 156)

Detach an observer object

return: True if the observer object was detached
since: 1.5
access: public

boolean detach (object $observer)

object $observer: An observer object to detach

getState (line 103)

Get the state of the JObservable object

return: The state of the object
since: 1.5
access: public

mixed getState ()

notify (line 114)

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

return: Array of return values from the observers
since: 1.5
access: public

array notify ()

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()

Documentation generated on Mon, 05 Mar 2007 21:12:12 +0000 by phpDocumentor 1.3.1