Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
LinkAction Class Reference

Public Member Functions

getActionRequest ()
 
 getHoverTitle ()
 
 getId ()
 
 getImage ()
 
 getTitle ()
 
 LinkAction ($id, &$actionRequest, $title=null, $image=null)
 

Detailed Description

Base class defining an action that can be performed by the user in the user interface.

Definition at line 20 of file LinkAction.inc.php.

Member Function Documentation

& LinkAction::getActionRequest ( )

Get the action handler.

Returns
LinkActionRequest

Definition at line 65 of file LinkAction.inc.php.

LinkAction::getHoverTitle ( )

Get a title for display when a user hovers over the link action. Default to the regular title if it is set.

Returns
string

Definition at line 82 of file LinkAction.inc.php.

References getId().

LinkAction::getId ( )

Get the action id.

Returns
string

Definition at line 57 of file LinkAction.inc.php.

Referenced by getHoverTitle().

LinkAction::getImage ( )

Get the action image.

Returns
string

Definition at line 93 of file LinkAction.inc.php.

LinkAction::getTitle ( )

Get the localized action title.

Returns
string

Definition at line 73 of file LinkAction.inc.php.

LinkAction::LinkAction (   $id,
$actionRequest,
  $title = null,
  $image = null 
)

Constructor

Parameters
$idstring
$actionRequestLinkActionRequest The action to be taken when the link action is activated.
$titlestring (optional) The localized title of the action.
$imagestring (optional) The name of an icon for the action.

Definition at line 41 of file LinkAction.inc.php.


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