## P4A_Object

Description

The base class extended by every p4a object.

Keeps object identifiers (id, name) and any method for event triggering.

- author: Andrea Giardina <andrea.giardina@crealabs.it>
- author: Fabrizio Balliano <fabrizio.balliano@crealabs.it>

Located in /p4a/p4a_object.php (line 47)

Direct descendents

Class | Description
--- | ---
P4A_Collection | P4A - PHP For Applications.
P4A_Data_Field | Every DATA_SOURCE field is a DATA_FIELD.
P4A_Data_Source | P4A - PHP For Applications.
P4A_Mask | The mask is the basic interface object wich contains all widgets and generically every displayed object.
P4A | THE APPLICATION.
P4A_Widget | Base class for objects that permit user interation with the application.

Variable Summary
string $_id
array $_map_actions
string $_name
mixed $_objects
mixed $_parent_id
Method Summary
void actionHandler (string $action, [mixed $param = NULL])
void &build (mixed $class, mixed $name)
void destroy ()
void errorHandler (string $action, [mixed $param = NULL])
void getId ()
string getName ()
string getObjectType ()
void getParentID ()
void implementMethod (string $action, object object &$object, string $method)
void intercept (object object &$object, string $action, string $method)
boolean isActionTriggered (string $action)
void p4a_object ([string $name = NULL], [string $prefix = 'obj'], [string $id = NULL])
void setName (mixed $name)
void setParentID (mixed $object_id)
void void ([mixed $params = NULL])
Variables
string $_id = NULL (line 54)

Object's ID

- access: private

array $_map_actions = array() (line 71)

Keeps the association between an action and its listener.

- access: private

string $_name = NULL (line 64)

Object's name

- access: public

mixed $_objects = array() (line 74)
mixed $_parent_id = NULL (line 57)
Methods
actionHandler (line 186)

Handle an action implemented by the object.

- access: private

void actionHandler (string $action, [mixed $param = NULL])

- string $action: The action to be handled.
- mixed $param: Parameter that will be passed to the action handler.

build (line 98)
void &build (mixed $class, mixed $name)
destroy (line 142)

Destroys the object Retrieves all children objects and destroy them.

- access: public

void destroy ()
errorHandler (line 263)

Handle an error action implemented by the object.

Checks if the the specified action is triggered and calls it, if the action is not triggered calls the general error handler for the object.

- access: private

void errorHandler (string $action, [mixed $param = NULL])

- string $action: The action to be handled.
- mixed $param: Parameter that will be passed to the error handler.

getId (line 132)
void getId ()
getName (line 175)

Returns the object name.

- see: $name
- access: public

string getName ()
getObjectType (line 249)

Returns the "CLASS" type of the object.

- access: public

string getObjectType ()
getParentID (line 126)
void getParentID ()
implementMethod (line 224)

Wrapper for setting an intercepted event on an object.

- access: public

void implementMethod (string $action, object object &$object, string $method)

- string $action: The action's name.
- object object &$object: The object that will intercept the action.
- string $method: The method that will be called.

intercept (line 209)

Tells an object to execute a method when an action is called.

- access: public

void intercept (object object &$object, string $action, string $method)

- object object &$object: The object that has the method.
- string $action: The action triggered by an event.
- string $method: The method that will be executed.

isActionTriggered (line 235)

Tells if an action is triggered.

- access: public

boolean isActionTriggered (string $action)

- string $action: The action.

p4a_object (line 85)

Class constructor.

Sets default properties and store the object in the application object stack.

- access: private

void p4a_object ([string $name = NULL], [string $prefix = 'obj'], [string $id = NULL])

- string $name: Object identifier, when you add an object to another object (such as $p4a) you can access to it by $p4a->object_name.
- string $prefix: Prefix string for ID generation.
- string $id: Object ID identifies an object in the $p4a's object collection. You can set a static ID if you want that all clients uses the same ID (tipically for web sites).

setName (line 164)

Sets the object's name.

- access: public

void setName (mixed $name)
setParentID (line 120)
void setParentID (mixed $object_id)
void (line 295)
void void ([mixed $params = NULL])

Documentation generated on Fri, 26 May 2006 12:43:30 +0200 by phpDocumentor 1.3.0RC5