Class: ActionList

Source Location: /actnlist.inc.php

Class Overview

Object
   |
   --Persistent
      |
      --Component
         |
         --ActionList

ActionList Class

Class Details

[line 41]
ActionList Class

A list of actions for processing web requests. Currently the ActionList is just a list of strings (actions) and when matched by a web request the OnExecute event is fired.

Example: If an ActionList1 is defined in unit1.php and the list contains the string "showmessage" following URL will trigger an OnExecute: http://localhost/unit1.php/?ActionList1=showmessage Use the $params["action"] of the OnExecute event handler to distinguish between actions.

[ Top ]

Properties Actions [published]	Events OnExecute [published]	JS Events [none]
Methods __construct addAction deleteAction executeAction expandActionToURL init	Constants [none]

Inherited Properties Class: Component Component::ComponentCount Indicates how many components this component is owner Component::Components Component list containing all the components owned by this component Component::ControlState A flag to know the state of the control, csLoading, csDesigning Component::DataFieldValue This function returns the value of the datafield, if any Component::Name Name for the component, to be used as an identifier, should be unique Component::NamePath The path to uniquely identify a component, qualified by the owner when required Component::Owner The owner of this component, usually the page component, but the owner of pages is the application object Component::Tag A versatily property of every Component that can be used in any way you want Class: Persistent Persistent::NamePath Used to serialize/unserialize Persistent::Owner Owner of the component, in Persistent always return null	Inherited Events	Inherited JS Events
Inherited Methods Class: Component Component::__construct Constructor Component::ajaxCall Returns the js event attribute to call the server using ajax Component::callEvent Calls a server event Component::dumpChildrenHeaderCode Dump the header code for all the children Component::dumpChildrenJavascript Dump the javascript code for all the children Component::dumpHeaderCode To dump header code required Component::dumpHiddenKeyFields This function dumps out the key fields for the current row, useful to Component::dumpJavascript To dump the javascript code needed by this component Component::fixupProperty This method returns the right object (or the input string if object not found) for an object name Should be used on the loaded method for object properties to find the right reference Component::generateAjaxEvent Returns the js event attribute to call the server using Ajax we use xajax to handle all the ajax stuff. Component::hasValidDataField This function returns true if the datafield is valid Component::init To initialize a component, the right place to process events Component::insertComponent Insert a component into the components collection Component::loaded A virtual method to get notified when the object has been fully loaded from a stream Component::loadedChildren Calls childrens loaded recursively Component::loadResource Load this component from a string Component::preinit To initialize a component, called before init() Component::readAccessibility Overwrite this method to provide accessibility info for the RPC engine Component::readFromResource Read a component from a resource file Component::removeComponent Remove a component from the components collection Component::serializeChildren Serialize all children Component::unserializeChildren Unserialize all children Component::updateDataField Checks if there is any datafield attached to the component Class: Persistent Persistent::assign Assing the source properties to this object Persistent::assignError Raises an assignation error Persistent::assignTo Assign this object to another object Persistent::serialize Stores this object into the session, it uses PHP reflection system to get published properties, the ones that will be stored. Persistent::unserialize Read this object properties from the session, only published properties will be recovered, components need an owner to be unserialized. Class: Object Object::__construct Constructor Object::className Returns the name of the object class Object::classNameIs Check if the object is from a specific class Object::classParent Returns the parent class of the object Object::inheritsFrom Check if the object inherits from a specific class Object::methodExists Check if a method exists Object::readProperty Reads a property from the streams Object::__get To virtualize properties Object::__set To virtualize properties

Properties

property Actions : array [line 155]

Array of all actions in the list.

Use addAction() and deleteAction() to modify the array easily.

[ Top ]

Events

property OnExecute [line 139]

OnExecute event Occurs when a web request contained an action of the list.

Use the $params argument passed to the event handler to get the name of the executed action (e.g. $params["action"]).

[ Top ]

Javascript Events

Methods

constructor __construct [line 47]

ActionList __construct(
[
$aowner = null])

Overrides Component::__construct (Constructor)

Parameters:

$aowner

[ Top ]

void addAction [line 68]

void addAction(
string
$action)

Add a new action to the Actions array.

Parameters:

string

$action

Name of the action.

[ Top ]

void deleteAction [line 77]

void deleteAction(
string
$action)

Deletes an action from the Actions array.

Parameters:

string

$action

Name of the action.

[ Top ]

bool executeAction [line 92]

bool executeAction(
string
$action)

Generates an OnExecute event.

Tags:

return:

Returns true if the OnExecute event was successfully called, false otherwise.

Parameters:

string

$action

Name of the action.

[ Top ]

bool expandActionToURL [line 114]

bool expandActionToURL(
string
$action, 
&$url, string
$url)

Add an action to an URL.

Note: Currently only one action per ActionList and URL can be added. If more actions of the same list are added the behavior is undefined.

Tags:

return:

Returns true if the action was successfully added to the URL, false otherwise.

Parameters:

string	$action	Name of the action.
string	$url	An URL to another script. If empty the same script as ActionList is defined will be called.
	&$url

[ Top ]

void init [line 53]

void init(
)

Overrides Component::init (To initialize a component, the right place to process events)

[ Top ]

Documentation generated on Tue, 27 Mar 2007 13:33:13 +0200 by phpDocumentor 1.3.1

Class: ActionList

Class Overview

Class Details

Properties

Events

JS Events

Methods

Constants

Inherited Properties

Class: Component

Class: Persistent

Inherited Events

Inherited JS Events

Inherited Methods

Class: Component

Class: Persistent

Class: Object

Properties

property Actions : array [line 155]

Events

property OnExecute [line 139]

Javascript Events

Methods

constructor __construct [line 47]

Parameters:

void addAction [line 68]

Parameters:

void deleteAction [line 77]

Parameters:

bool executeAction [line 92]

Tags:

Parameters:

bool expandActionToURL [line 114]

Tags:

Parameters:

void init [line 53]