Open Monograph Press  3.3.0
Public Member Functions
GridCellProvider Class Reference
Inheritance diagram for GridCellProvider:
AnnouncementTypeGridCellProvider ArrayGridCellProvider ChapterGridCategoryRowCellProvider ColumnBasedGridCellProvider ContextGridCellProvider CustomLocaleGridCellProvider DataObjectGridCellProvider DateGridCellProvider GridCategoryRowCellProvider LanguageGridCellProvider LibraryFileGridCellProvider LiteralGridCellProvider NavigationMenuItemsGridCellProvider NavigationMenusGridCellProvider NotificationsGridCellProvider NullGridCellProvider PluginGalleryGridCellProvider PluginGridCellProvider ReviewFormElementGridCellProvider ReviewFormElementResponseItemListbuilderGridCellProvider ReviewFormGridCellProvider SeriesGridCellProvider StaticPageGridCellProvider UserGroupGridCellProvider UserListbuilderGridCellProvider

Public Member Functions

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

Detailed Description

Base class for a grid column's cell provider.

Grid cell providers provide formatted data to grid columns. For general information about grids, see GridHandler.

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

Constructor & Destructor Documentation

◆ __construct()

GridCellProvider::__construct ( )

Constructor

Reimplemented in IdentificationCodeGridCellProvider, MarketsGridCellProvider, PublicationDateGridCellProvider, RepresentativesGridCellProvider, SalesRightsGridCellProvider, and SpotlightsGridCellProvider.

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

Member Function Documentation

◆ getCellActions()

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
$positionint GRID_ACTION_POSITION_...
Returns
array an array of LinkAction instances

Reimplemented in GridCategoryRowCellProvider, PublicationFormatGridCellProvider, ReviewerGridCellProvider, QueriesGridCellProvider, AuthorReviewerGridCellProvider, PluginGalleryGridCellProvider, LanguageGridCellProvider, QueryNotesGridCellProvider, UserGroupGridCellProvider, PluginGridCellProvider, ReviewFormGridCellProvider, LibraryFileGridCellProvider, SeriesGridCellProvider, StaticPageGridCellProvider, NotificationsGridCellProvider, ChapterGridCategoryRowCellProvider, CustomLocaleGridCellProvider, AnnouncementTypeGridCellProvider, NavigationMenuItemsGridCellProvider, and NavigationMenusGridCellProvider.

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

Referenced by render().

◆ getTemplateVarsFromRowColumn()

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

Reimplemented in PublicationFormatGridCellProvider, NotificationsGridCellProvider, CustomLocaleGridCellProvider, ReviewerGridCellProvider, DataObjectGridCellProvider, QueriesGridCellProvider, StaticPageGridCellProvider, ChapterGridCategoryRowCellProvider, AuthorReviewerGridCellProvider, DateGridCellProvider, AnnouncementTypeGridCellProvider, NavigationMenusGridCellProvider, EventLogGridCellProvider, PKPAuthorGridCellProvider, QueryNotesGridCellProvider, UserSelectGridCellProvider, IdentificationCodeGridCellProvider, MarketsGridCellProvider, PublicationDateGridCellProvider, RepresentativesGridCellProvider, SalesRightsGridCellProvider, SpotlightsGridCellProvider, NavigationMenuItemsGridCellProvider, ColumnBasedGridCellProvider, ArrayGridCellProvider, LiteralGridCellProvider, UserListbuilderGridCellProvider, StageParticipantGridCellProvider, GridCategoryRowCellProvider, ContextGridCellProvider, LibraryFileGridCellProvider, PluginGalleryGridCellProvider, PluginGridCellProvider, UserGroupGridCellProvider, SeriesGridCellProvider, ReviewFormGridCellProvider, ReviewFormElementGridCellProvider, ReviewFormElementResponseItemListbuilderGridCellProvider, and LanguageGridCellProvider.

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

Referenced by render().

◆ render()

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

Reimplemented in GridCategoryRowCellProvider, and NullGridCellProvider.

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

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

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