Class: ActionList

Source Location: /actnlist.inc.php

Class Overview

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

A list of actions for processing web requests.

Author(s):

Variables

Methods

Inherited Variables

Class: Component

Component::$alreadycreated
Component::$components
Component::$lastresourceread
Component::$owner
Component::$reallastresourceread
Component::$_childnames
Component::$_controlstate
Component::$_name
Component::$_namepath
Component::$_tag

Class: Object

Object::$input

Inherited Methods

Class: Component

Component::__construct(): Component constructor
Component::ajaxCall(): Dumps the javascript code to make an ajax call to the server.
Component::callEvent(): Calls a server event.
Component::defaultName()
Component::defaultTag()
Component::dumpChildrenFormItems(): This method is called by the page just after dumping the starting form tag.
Component::dumpChildrenHeaderCode(): Dumps the header code for all the children
Component::dumpChildrenJavascript(): Dumps the javascript code for all the children
Component::dumpFormItems(): Dumps code just after the form tag, useful to dump hidden fields for state retrieving for non visible components
Component::dumpHeaderCode(): Dumps header code required
Component::dumpHiddenKeyFields(): Dumps hidden field values for the key record
Component::dumpJavascript(): Dumps the javascript code needed by this component
Component::dumpJSEvent(): Dumps javascript code for an event
Component::fixupProperty(): Resolves the right reference to an object property
Component::generateAjaxEvent(): Returns the javascript code to generate an ajax call.
Component::getName(): Specifies the name for the component. The name is used as an identifier and should be unique.
Component::getTag(): A versatile property of every Component that can be used in any way you want
Component::hasValidDataField(): Returns true if a valid data field is attached to the component
Component::init(): Initializes a component
Component::insertComponent(): Inserts a component into the component's collection
Component::loaded(): Initializes the component after the form file has been read into memory.
Component::loadedChildren(): Calls childrens loaded
Component::loadResource(): Loads this component from a string
Component::preinit(): Method called before init()
Component::readAccessibility(): Provides accessibility info to the embedded RPC engine.
Component::readComponentCount(): Indicates the number of components owned by the component.
Component::readComponents(): Lists all the components owned by this component.
Component::readControlState(): A flag to know the state of the control, csLoading, csDesigning
Component::readDataFieldValue(): This property returns the value of the datafield if any.
Component::readFromResource(): Reads a component from a resource file
Component::readNamePath(): Specifies the path to uniquely identify a component, qualified by the owner when required.
Component::readOwner(): Indicates the component that is responsible for streaming and freeing this component.
Component::removeComponent(): Removes a component from the component's collection
Component::serializeChildren(): Serializes all children
Component::setName()
Component::setTag()
Component::unserializeChildren(): Unserializes all children by calling unserialize for all the components
Component::updateDataField(): Updates the field on the dataset attached, if any
Component::writeControlState()

Class: Persistent

Persistent::allowserialize(): This method provides an opportunity for the component developer to prevent the serialization/unserialization of a property.
Persistent::assign(): Assigns the source properties to this object.
Persistent::assignError(): Raises an assignation error.
Persistent::assignTo(): Assigns this object to another object.
Persistent::inSession(): This method determines if this object exists in the current session.
Persistent::readNamePath(): Used to serialize/unserialize. It returns the full path to identify this component.
Persistent::readOwner(): Owner of the component.
Persistent::serialize(): Stores this object into the session.
Persistent::unserialize(): This method uses PHP reflection to iterate through published properties (the ones starting with get) and retrieve the properties stored by a previous serialize() call.

Class: Object

Object::__construct(): Constructs an object and initializes its data before the object is first used.
Object::className(): Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
Object::classNameIs(): Determines whether an object is of a specific type.
Object::classParent(): Returns the type of the immediate ancestor of a class.
Object::inheritsFrom(): Determines the relationship of two object types.
Object::methodExists(): Check if a method exists declared on this object instance.
Object::readProperty(): Reads a property from the streams
Object::__get(): To virtualize properties
Object::__set(): To virtualize properties

Class Details

[line 56]
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.

If an ActionList1 is defined in unit1.php, and the Actions property contains an entry called "showmessage", the following URL will trigger an OnExecute:

http://localhost/unit1.php/?ActionList1=showmessage

Then, you can use the $params["action"] of the OnExecute event handler to distinguish between actions and write your working code.

<?php
function ActionList1Execute($sender, $params)
{
if ($params['action']=='youraction') echo "Now execute your action!";
}
?>

Tags:

see:	ActionList::getOnExecute()
link:	http://www.qadram.com/vcl4php/docwiki/index.php/Developer%27s_Guide_::_Using_ActionLists

[ Top ]

Class Variables

$_actions = array()

[line 58]

Tags:

access:

protected

Type:

mixed

[ Top ]

$_onexecute = null

[line 59]

Tags:

access:

protected

Type:

mixed

[ Top ]

Class Methods

constructor __construct [line 62]

ActionList __construct(
[
$aowner = null])

Overrides Component::__construct() (Component constructor)

Parameters:

$aowner

[ Top ]

method addAction [line 100]

void addAction(
string
$action)

Adds a new action to the Actions array.

Use this method to add a new operation to be processed by this component. ActionList will only fire OnExecute if the value for the action parameter is found on this list.

<?php
//Add the action to the list so it's available to be used
$this->ActionList1->addAction('youraction');
//Now you can use in your links ActionList1=youraction to fire the
//OnExecute event
?>

Tags:

see:

ActionList::deleteAction()

Parameters:

string

$action

Name of the action to be added

[ Top ]

method defaultActions [line 267]

void defaultActions(
)

[ Top ]

method defaultOnExecute [line 242]

void defaultOnExecute(
)

[ Top ]

method deleteAction [line 123]

void deleteAction(
string
$action)

Deletes an action from the Actions array.

Use this method to delete an existing operation from the Actions property, it doesn't perform any check to know if the property exists or not.

<?php
//After this line, youraction won't be a valid action any more
$this->ActionList1->deleteAction('youraction');
?>

Tags:

see:

ActionList::addAction()

Parameters:

string

$action

Name of the action to be deleted

[ Top ]

method executeAction [line 159]

bool executeAction(
string
$action)

Forces a call to the OnExecute event, if attached and if the action to be called exists on the Actions array

This method fires the OnExecute event, provided all conditions are met. First, the OnExecute event must be assigned, after that, $action specified must exist on the Actions array.

<?php
//Executing this line will cause the OnExecute event to be fired
$this->ActionList1->executeAction('youraction');
function ActionList1Execute($sender, $params)
{
if ($params['action']=='youraction') echo "Now execute your action!";
}
?>

Tags:

return:	Returns the value returned by the event handler, it can also return false if no conditions for execution are met
see:	ActionList::addAction(), ActionList::deleteAction(), ActionList::getOnExecute()

Parameters:

string

$action

Name of the action to execute

[ Top ]

method expandActionToURL [line 195]

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

Adds an action to the URL sent

Use this method to easily generate the parameter you need to add to an URL to force the execution of an specific action.

Currently only one action per ActionList and URL can be added, if more actions on the same list are added, the behavior is undefined.

<?php
$url='http://www.yourwebsite.com/form1.php';
$this->ActionList1->expandActionToURL('youraction',$url);
//Now $url contains http://www.yourwebsite.com/form1.php?ActionList1=youraction
?>

Tags:

return:

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

Parameters:

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

[ Top ]

method getActions [line 265]

array getActions(
)

Array holding all the actions in the list.

This property represents a list of all the action the component allows you to use to control the flow of your program.

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

<?php
function ActionList1Execute($sender, $params)
{
if ($params['action']=='youraction') echo "Now execute your action!";
}
?>

Tags:

see:

ActionList::addAction(), ActionList::deleteAction()

[ Top ]

method getOnExecute [line 240]

mixed getOnExecute(
)

Fired when a web request contains a parameter named like the component name and the value is an action contained on the Actions array.

This event allows you to split the logic process of your application in actions, so you can freely use links in your web pages that fire events on your code.

To know which action to execute, user the $params parameter, which is an array, and the action key, this way:

<?php
//Executing this line will cause the OnExecute event to be fired
$this->ActionList1->executeAction('youraction');
function ActionList1Execute($sender, $params)
{
if ($params['action']=='youraction') echo "Now execute your action!";
}
?>

Tags:

see:

ActionList::addAction(), ActionList::deleteAction(), ActionList::executeAction()

[ Top ]

method init [line 68]

void init(
)

Overrides Component::init() (Initializes a component)

[ Top ]

method setActions [line 266]

void setActions(

$value)

Parameters:

$value

[ Top ]

method setOnExecute [line 241]

void setOnExecute(

$value)

Parameters:

$value

[ Top ]

Documentation generated on Sat, 13 Jun 2009 10:50:54 -0700 by phpDocumentor 1.4.1