NewsFeaturesDownloadsDevelopmentSupportAbout Us

ActionInfo Class Reference
[Action]

List of all members.


Public Member Functions

 ActionInfo ($actionParamName, $actionParamValue)
 getActionParamName ()
 getActionParamValue ()

Public Attributes

 $_actionParamName
 $_actionParamValue

Detailed Description

This class carries some information that classes extending the Action class might need, such as with which parameter they were called or which was the name of the parameter in the request.

Definition at line 10 of file actioninfo.class.php.


Member Function Documentation

ActionInfo.ActionInfo ( actionParamName,
actionParamValue 
)

Constructor.

In the following request: controller.php/?action=ViewArticle&articleId=7 the parameter name would be 'action' and the action name would be 'ViewArticle'. The default name for the parameter name is 'action' but it can be changed when constructing the controller. The name of the action is specified by using the action maps when creating the controller.

Parameters:
actionParamName The name of the parameter that was used to trigger the action.
actionParamValue The value of the action parameter that triggered this action.

Definition at line 31 of file actioninfo.class.php.

ActionInfo.getActionParamName (  ) 

Returns the name of the parameter used to trigger this action.

Returns:
The name of the parameter.

Definition at line 42 of file actioninfo.class.php.

ActionInfo.getActionParamValue (  ) 

Returns the vlaue of the parameter that triggered this action.

Returns:
The value of the parameter.

Definition at line 52 of file actioninfo.class.php.


Member Data Documentation

ActionInfo.$_actionParamName

Definition at line 13 of file actioninfo.class.php.

ActionInfo.$_actionParamValue

Definition at line 14 of file actioninfo.class.php.