Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
GridCellProvider Class Reference
Inheritance diagram for GridCellProvider:
ArrayGridCellProvider ColumnBasedGridCellProvider DataObjectGridCellProvider FilterGridCellProvider GridCategoryRowCellProvider MapGridCellProvider NullGridCellProvider PKPCitationGridCellProvider

Public Member Functions

getCellActions (&$request, &$row, &$column, $position=GRID_ACTION_POSITION_DEFAULT)
 
 getTemplateVarsFromRowColumn (&$row, $column)
 
 GridCellProvider ()
 
 render (&$request, &$row, &$column)
 

Detailed Description

Base class for a grid column's cell provider.

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

Member Function Documentation

& GridCellProvider::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
Returns
array an array of LinkAction instances

Definition at line 89 of file GridCellProvider.inc.php.

Referenced by render().

GridCellProvider::getTemplateVarsFromRowColumn ( $row,
  $column 
)

Subclasses have to implement this method to extract variables for a given column from a data element so that they may be assigned to template before rendering.

Parameters
$rowGridRow
$columnGridColumn
Returns
array

Definition at line 71 of file GridCellProvider.inc.php.

Referenced by render().

GridCellProvider::GridCellProvider ( )

Constructor

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

GridCellProvider::render ( $request,
$row,
$column 
)

To be used by a GridRow to generate a rendered representation of the element for the given column.

Parameters
$rowGridRow
$columnGridColumn
Returns
string the rendered representation of the element for the given column

Definition at line 36 of file GridCellProvider.inc.php.

References getCellActions(), AppLocale\getSupportedFormLocales(), and getTemplateVarsFromRowColumn().


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