Dataface_ActionTool Class Reference

Public Member Functions
	Dataface_ActionTool ($conf=null)
	_loadActionsINIFile ()
	_loadTableActions ($tablename)
&	getAction ($params, $action=null)
	getActions ($params=array(), $actions=null)
	_compareActions ($a, $b)
	addAction ($name, $action)
	removeAction ($name)
Static Public Member Functions
static &	getInstance ($conf=null)
Data Fields
	$actions = array()
	$tableActions = array()

---

Detailed Description

A tool to manage actions within the application.

Definition at line 26 of file ActionTool.php.

---

Member Function Documentation

_compareActions	(	$	a,
		$	b
	)

Comparison function used for sorting actions.

Definition at line 279 of file ActionTool.php.

_loadActionsINIFile

(

)

Definition at line 44 of file ActionTool.php.

_loadTableActions

(

$

tablename

)

Definition at line 74 of file ActionTool.php.

addAction	(	$	name,
		$	action
	)

Adds an action to the action tool.

Parameters:

$name	The name of the action.
$action	An array representing the action.

Definition at line 289 of file ActionTool.php.

Dataface_ActionTool

(

$

conf = null

)

Definition at line 32 of file ActionTool.php.

& getAction	(	$	params,
		$	action = null
	)

Returns a specified action without evaluating the permissions or condition fields.

Parameters:

$params

Associative array: Options: name => The name of the action to retrieve table => The name of the table on which the action is defined.

Returns:

Action associative array.

Definition at line 92 of file ActionTool.php.

getActions	(	$	params = array(),
		$	actions = null
	)

Returns an array of all actions as specified by $params. $params must be an array. It may contain the following options: record => A reference to a record for which the actions apply (This may be a related record) table => The name of a table on which the actions apply. relationship => The name of a relationship on which the action is applied. (requires that table also be set - or may use dotted name) to include the table name and the relationship name in one string. category => The name of the category of actions to be retrieved.

Definition at line 160 of file ActionTool.php.

static& getInstance

(

$

conf = null

)

[static]

Returns a reference to the singleton ActionTool instance.

Parameters:

$conf

Optional configuration array with action definitions.

Definition at line 318 of file ActionTool.php.

removeAction

(

$

name

)

Removes the action with the specified name.

Definition at line 306 of file ActionTool.php.

---

Field Documentation

$actions = array()

Definition at line 29 of file ActionTool.php.

$tableActions = array()

Definition at line 30 of file ActionTool.php.

---

The documentation for this class was generated from the following file:

• Dataface/ActionTool.php