Open Journal Systems  3.3.0
DownloadFileLinkAction Class Reference
Inheritance diagram for DownloadFileLinkAction:
FileLinkAction LinkAction

Public Member Functions

 __construct ($request, $submissionFile, $stageId=null, $label=null)
 
 getLabel ($submissionFile)
 
- Public Member Functions inherited from FileLinkAction
 __construct ($id, $actionRequest, $title=null, $image=null, $tooltip=null)
 
 getActionArgs ($submissionFile, $stageId=null)
 
- Public Member Functions inherited from LinkAction
 getActionRequest ()
 
 getHoverTitle ()
 
 getId ()
 
 getImage ()
 
 getTitle ()
 
 getToolTip ()
 
 setTitle ($title)
 

Data Fields

 $label
 
- Data Fields inherited from LinkAction
 $_actionRequest
 
 $_id
 
 $_image
 
 $_title
 
 $_toolTip
 

Detailed Description

An action to download a file.

Definition at line 17 of file DownloadFileLinkAction.inc.php.

Constructor & Destructor Documentation

◆ __construct()

DownloadFileLinkAction::__construct (   $request,
  $submissionFile,
  $stageId = null,
  $label = null 
)

Constructor

Parameters
$requestRequest
$submissionFileSubmissionFile the submission file to link to.
$stageIdint (optional)
$labelstring (optional) Label to use instead of filename

Definition at line 32 of file DownloadFileLinkAction.inc.php.

References $label, and getLabel().

Member Function Documentation

◆ getLabel()

DownloadFileLinkAction::getLabel (   $submissionFile)

Get the label for the file download action.

Parameters
$submissionFileSubmissionFile
Returns
string

Definition at line 59 of file DownloadFileLinkAction.inc.php.

References $label.

Referenced by __construct().

Field Documentation

◆ $label

string DownloadFileLinkAction::$label

Optional label to use instead of file name

Definition at line 22 of file DownloadFileLinkAction.inc.php.

Referenced by __construct(), and getLabel().


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