Open Journal Systems  3.3.0
QueriesGridCellProvider Class Reference
Inheritance diagram for QueriesGridCellProvider:
DataObjectGridCellProvider GridCellProvider

Public Member Functions

 __construct ($submission, $stageId, $queriesAccessHelper)
 
 getCellActions ($request, $row, $column, $position=GRID_ACTION_POSITION_DEFAULT)
 
 getRequestArgs ($row)
 
 getTemplateVarsFromRowColumn ($row, $column)
 
- Public Member Functions inherited from DataObjectGridCellProvider
 getLocale ()
 
 setLocale ($locale)
 
- Public Member Functions inherited from GridCellProvider
 __construct ()
 
 render ($request, $row, $column)
 

Data Fields

 $_queriesAccessHelper
 
 $_stageId
 
 $_submission
 
- Data Fields inherited from DataObjectGridCellProvider
 $_locale = null
 

Detailed Description

Base class for a cell provider that can retrieve labels for queries.

Definition at line 18 of file QueriesGridCellProvider.inc.php.

Constructor & Destructor Documentation

◆ __construct()

QueriesGridCellProvider::__construct (   $submission,
  $stageId,
  $queriesAccessHelper 
)

Constructor

Parameters
$submissionSubmission
$stageIdint
$queriesAccessHelperQueriesAccessHelper

Definition at line 43 of file QueriesGridCellProvider.inc.php.

Member Function Documentation

◆ getCellActions()

QueriesGridCellProvider::getCellActions (   $request,
  $row,
  $column,
  $position = GRID_ACTION_POSITION_DEFAULT 
)

Subclasses can override this template method to provide cell specific actions.

NB: The default implementation delegates to the grid column for cell-specific actions. Another thinkable implementation would be row-specific actions in which case action instantiation should be delegated to the row.

Parameters
$requestRequest
$rowGridRow
$columnGridColumn
$positionint GRID_ACTION_POSITION_...
Returns
array an array of LinkAction instances

Reimplemented from GridCellProvider.

Definition at line 96 of file QueriesGridCellProvider.inc.php.

References getRequestArgs().

◆ getRequestArgs()

QueriesGridCellProvider::getRequestArgs (   $row)

Get request arguments.

Parameters
$rowGridRow
Returns
array

Definition at line 131 of file QueriesGridCellProvider.inc.php.

Referenced by getCellActions().

◆ getTemplateVarsFromRowColumn()

QueriesGridCellProvider::getTemplateVarsFromRowColumn (   $row,
  $column 
)

Extracts variables for a given column from a data element so that they may be assigned to template before rendering.

Parameters
$rowGridRow
$columnGridColumn
Returns
array

Reimplemented from DataObjectGridCellProvider.

Definition at line 60 of file QueriesGridCellProvider.inc.php.

References PKPApplication\get().

Field Documentation

◆ $_queriesAccessHelper

QueriesAccessHelper QueriesGridCellProvider::$_queriesAccessHelper

Definition at line 35 of file QueriesGridCellProvider.inc.php.

◆ $_stageId

int QueriesGridCellProvider::$_stageId

Definition at line 29 of file QueriesGridCellProvider.inc.php.

◆ $_submission

Submission QueriesGridCellProvider::$_submission

Definition at line 23 of file QueriesGridCellProvider.inc.php.


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