Class: ActionGoToPage

Source Location: /components/button/ActionGoToPage.inc.php

Class Overview

XmlObject
   |
   --Action
      |
      --ActionGoToPage

An action that redirects the user to a different page

Inherited Methods

Class: Action

Action::getCodeToPerformAction(): Returns code to perform this given action. This function is typically overridden by classed extending this one.
Action::getSummary(): Returns a short summary of the action for the user interface
Action::getUserFriendlyName(): Returns a readable name for the user interface; abstract function

Class: XmlObject

XmlObject::__construct()
XmlObject::getDom(): Returns a refernce to the DOMDocument that is at the root of this XML object
XmlObject::getFirstChildNodeByTagName(): Returns a reference to the first child XML node with a particular name
XmlObject::getOrCreateChildNodeByTagName(): Returns a reference to the first child XML node with a particular name.
XmlObject::getXmlNode(): Returns a reference to the DOMNode of this XML object
XmlObject::removeAllChildNodesByTagName(): Deletes all child nodes that have a particular name
XmlObject::setXmlNode(): Sets a refernce to the DOMNode.

Class Details

[line 9]
An action that redirects the user to a different page

[ Top ]

Class Methods

method getCodeToPerformAction [line 58]

string getCodeToPerformAction(
[mixed
$oApp = NULL])

Returns the code to perform Go To Page action. This function does not check for multiple Go To Page action specified by the user. This only means that the latest Go To Page action in the list of action rules that meets the conditions wins and that page will be loaded.

Tags:

return:	returns header("Location: <some url>");
access:	public

Overrides Action::getCodeToPerformAction() (Returns code to perform this given action. This function is typically overridden by classed extending this one.)

[ Top ]

method getPageId [line 33]

string getPageId(
)

Returns the id of the page that the user will be redirected to

Tags:

return:	id of the target redirect page or empty string as default
access:	public

[ Top ]

method getSummary [line 24]

string getSummary(
)

Returns a short summary of the action for the user interface

Tags:

return:	a user-friendly summary for the action
access:	public

Overrides Action::getSummary() (Returns a short summary of the action for the user interface)

[ Top ]

method getUserFriendlyName [line 15]

string getUserFriendlyName(
)

Returns a readable name for the user interface

Tags:

return:	a user-friendly name for the action
static:
access:	public

Overrides Action::getUserFriendlyName() (Returns a readable name for the user interface; abstract function)

[ Top ]

method setPageId [line 45]

void setPageId(
string
$sPageId)

Sets the id of the page that the user will be redirected to

Tags:

access:

public

Parameters:

string

$sPageId

id of the target redirect page

[ Top ]

Documentation generated on Wed, 12 Jan 2005 17:50:16 -0500 by phpDocumentor 1.3.0RC3