Docs For Class ActionRule

constructor __construct [line 14]

ActionRule __construct(
[mixed
$oParentComponent = NULL], [mixed
$oActionRuleNode = NULL])

Construct a new action rule

Tags:

access:

public

Overrides XmlObject::__construct() (parent method not documented)

[ Top ]

method createNewActionByTypeFactory [line 222]

Action createNewActionByTypeFactory(
String
$sActionType)

Factory method to create new action objects depending on the type, e.g. "actionGoToPage"

Tags:

return:	An object of a class derived from "Action", e.g. ActionGoToPage
access:	public

Parameters:

String

$sActionType

Type of the action that should be returned, e.g. "actionSendEmail"

[ Top ]

method createNewActionsNode [line 79]

DOMNode createNewActionsNode(
)

Creates an XML node that can hold actions, i.e. "<actions>"

Tags:

return:	XML node that holds actions
access:	public

[ Top ]

method createNewCondition [line 92]

Condition createNewCondition(
)

Creates a new condition, i.e. '<condition fieldId="firstName" operator="isEmpty"/>'

Tags:

return:	Object that holds the condition
access:	public

[ Top ]

method createNewConditionsNode [line 66]

DOMNode createNewConditionsNode(
)

Creates an XML node that can hold conditions, i.e. "<conditions>"

Tags:

return:	XML node that holds conditions
access:	public

[ Top ]

method deleteAllActions [line 161]

void deleteAllActions(
)

Deletes all actions defined for this action rule

Tags:

access:

public

[ Top ]

method deleteAllConditions [line 151]

void deleteAllConditions(
)

Deletes all conditions defined for this action rule

Tags:

access:

public

[ Top ]

method getActionFactory [line 202]

Action getActionFactory(
String
$sActionType, [DOMNode
$oXmlNode = NULL])

Factory method to create action objects depending on the type, e.g. "actionGoToPage"

Tags:

return:	An object of a class derived from "Action", e.g. ActionGoToPage
static:
access:	public

Parameters:

String	$sActionType	Type of the action that should be returned, e.g. "actionSendEmail"
DOMNode	$oXmlNode	XML node containing the data for this action

[ Top ]

method getActions [line 182]

array getActions(
)

Returns an array of "action" objects

Tags:

return:	of objects of type Action
access:	public

[ Top ]

method getConditionByPosition [line 260]

Condition getConditionByPosition(
int
$iPosition)

Returns a condition from the XML

Tags:

return:	object that contains the condition indicated by the position or NULL
access:	public

Parameters:

int

$iPosition

position of the condition within the XML, starting with 0

[ Top ]

method getConditions [line 126]

array getConditions(
)

Returns an array of "condition" objects

Tags:

return:	of objects of type Condition
access:	public

[ Top ]

method getConditionsConnector [line 38]

string getConditionsConnector(
)

Returns either the keyword "and" or the keyword "or" which represent the boolean connector used to connect the conditions of this action rule

Tags:

return:	the keyword "and" or the keyword "or"; default is "and"
access:	public

[ Top ]

method getFirstActionByType [line 285]

Action getFirstActionByType(
string
$sActionType)

Returns an object of type "ActionX" where X is "SaveToDatabase", "GoToPage" etc.

Returns the first action of a certain type within an action rule or a newly created or NULL

Tags:

return:	Object that represents the first action of this type within the action rule
access:	public

Parameters:

string

$sActionType

Type of the action object that should be returned, for example "actionGoToPage"

[ Top ]

method getParentComponent [line 28]

Component getParentComponent(
)

Returns the parent Component of this object

Tags:

return:	A reference to the component containing this object
access:	public

[ Top ]

method getPosition [line 239]

int getPosition(
)

Returns the position of this action rule within the list of all action rules in the XML starting with 0

Tags:

return:	position of the action rule within the XML files, starting with 0
access:	public

[ Top ]

method hasConditions [line 108]

bool hasConditions(
)

Returns TRUE if the action rule has conditions, FALSE otherwise

Tags:

return:	indicator whether or not this action rule has any conditions
access:	public

[ Top ]

method setConditionsConnector [line 52]

void setConditionsConnector(
string
$sConnector)

Sets either the keyword "and" or the keyword "or" which represent the boolean connector used to connect the conditions of this action rule

Tags:

access:

public

Parameters:

string

$sConnector

the keyword "and" or the keyword "or"

[ Top ]

Class: ActionRule

Class Overview

Methods

Inherited Methods

Class: XmlObject

Class Details

Class Methods

constructor __construct [line 14]

Tags:

method createNewActionByTypeFactory [line 222]

Tags:

Parameters:

method createNewActionsNode [line 79]

Tags:

method createNewCondition [line 92]

Tags:

method createNewConditionsNode [line 66]

Tags:

method deleteAllActions [line 161]

Tags:

method deleteAllConditions [line 151]

Tags:

method getActionFactory [line 202]

Tags:

Parameters:

method getActions [line 182]

Tags:

method getConditionByPosition [line 260]

Tags:

Parameters:

method getConditions [line 126]

Tags:

method getConditionsConnector [line 38]

Tags:

method getFirstActionByType [line 285]

Tags:

Parameters:

method getParentComponent [line 28]

Tags:

method getPosition [line 239]

Tags:

method hasConditions [line 108]

Tags:

method setConditionsConnector [line 52]

Tags:

Parameters: