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

Public Member Functions

 __construct ($isCurrentUserAssignedAuthor)
 
 _getStatusText ($state, $row)
 
 _getStatusWithRecommendation ($statusKey, $reviewAssignment)
 
 getCellActions ($request, $row, $column, $position=GRID_ACTION_POSITION_DEFAULT)
 
 getCellState ($row, $column)
 
 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

 $_isCurrentUserAssignedAuthor
 
- Data Fields inherited from DataObjectGridCellProvider
 $_locale = null
 

Detailed Description

Base class for a cell provider that can retrieve labels for reviewer grid rows.

Definition at line 21 of file ReviewerGridCellProvider.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ReviewerGridCellProvider::__construct (   $isCurrentUserAssignedAuthor)

Constructor

Parameters
$isCurrentUserAssignedAuthorboolean Is the current user assigned as an author to this submission?

Definition at line 34 of file ReviewerGridCellProvider.inc.php.

Member Function Documentation

◆ _getStatusText()

ReviewerGridCellProvider::_getStatusText (   $state,
  $row 
)

Provide meaningful locale keys for the various grid status states.

Parameters
string$state
$rowGridRow
Returns
string

Definition at line 155 of file ReviewerGridCellProvider.inc.php.

References _getStatusWithRecommendation().

Referenced by getTemplateVarsFromRowColumn().

◆ _getStatusWithRecommendation()

ReviewerGridCellProvider::_getStatusWithRecommendation (   $statusKey,
  $reviewAssignment 
)

Retrieve a formatted HTML string that displays the state of the review with the review recommendation if one exists. Or return just the state. Only works with some states.

Parameters
string$statusKeyLocale key for status text
ReviewAssignment$reviewAssignment
Returns
string

Definition at line 190 of file ReviewerGridCellProvider.inc.php.

Referenced by _getStatusText().

◆ getCellActions()

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

Get cell actions associated with this row/column combination

Parameters
$rowGridRow
$columnGridColumn
Returns
array an array of LinkAction instances

Reimplemented from GridCellProvider.

Definition at line 101 of file ReviewerGridCellProvider.inc.php.

References getCellState(), and DAORegistry\getDAO().

◆ getCellState()

ReviewerGridCellProvider::getCellState (   $row,
  $column 
)

Gathers the state of a given cell given a $row/$column combination

Parameters
$rowGridRow
$columnGridColumn
Returns
string

Definition at line 48 of file ReviewerGridCellProvider.inc.php.

Referenced by getCellActions(), and getTemplateVarsFromRowColumn().

◆ getTemplateVarsFromRowColumn()

ReviewerGridCellProvider::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 69 of file ReviewerGridCellProvider.inc.php.

References _getStatusText(), and getCellState().

Field Documentation

◆ $_isCurrentUserAssignedAuthor

boolean ReviewerGridCellProvider::$_isCurrentUserAssignedAuthor

Is the current user assigned as an author to this submission

Definition at line 27 of file ReviewerGridCellProvider.inc.php.


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