Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct () | |
getCellActions ($request, $row, $column, $position=GRID_ACTION_POSITION_DEFAULT) | |
getTemplateVarsFromRowColumn ($row, $column) | |
render ($request, $row, $column) | |
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.
GridCellProvider::__construct | ( | ) |
Constructor
Reimplemented in IssueGridCellProvider.
Definition at line 24 of file GridCellProvider.inc.php.
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.
$request | Request |
$row | GridRow |
$column | GridColumn |
$position | int GRID_ACTION_POSITION_... |
Reimplemented in GridCategoryRowCellProvider, ReviewerGridCellProvider, QueriesGridCellProvider, ArticleGalleyGridCellProvider, AuthorReviewerGridCellProvider, PluginGalleryGridCellProvider, LanguageGridCellProvider, QueryNotesGridCellProvider, UserGroupGridCellProvider, PluginGridCellProvider, TocGridCellProvider, ReviewFormGridCellProvider, PubIdExportRepresentationsListGridCellProvider, PubIdExportIssuesListGridCellProvider, ExportPublishedSubmissionsListGridCellProvider, LibraryFileGridCellProvider, SectionGridCellProvider, IssueGridCellProvider, StaticPageGridCellProvider, NotificationsGridCellProvider, AnnouncementTypeGridCellProvider, NavigationMenuItemsGridCellProvider, and NavigationMenusGridCellProvider.
Definition at line 95 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.
$row | GridRow |
$column | GridColumn |
Reimplemented in PubIdExportRepresentationsListGridCellProvider, ExportPublishedSubmissionsListGridCellProvider, PubIdExportIssuesListGridCellProvider, NotificationsGridCellProvider, ReviewerGridCellProvider, IssueGridCellProvider, DataObjectGridCellProvider, QueriesGridCellProvider, StaticPageGridCellProvider, AuthorReviewerGridCellProvider, DateGridCellProvider, ArticleGalleyGridCellProvider, AnnouncementTypeGridCellProvider, NavigationMenusGridCellProvider, EventLogGridCellProvider, PaymentsGridCellProvider, PKPAuthorGridCellProvider, QueryNotesGridCellProvider, UserSelectGridCellProvider, NavigationMenuItemsGridCellProvider, TocGridCellProvider, ColumnBasedGridCellProvider, SubscriptionsGridCellProvider, SubscriptionTypesGridCellProvider, ArrayGridCellProvider, LiteralGridCellProvider, UserListbuilderGridCellProvider, PubIdExportSubmissionsListGridCellProvider, StageParticipantGridCellProvider, IssueGalleyGridCellProvider, GridCategoryRowCellProvider, ContextGridCellProvider, LibraryFileGridCellProvider, PluginGalleryGridCellProvider, PluginGridCellProvider, UserGroupGridCellProvider, SectionGridCellProvider, ReviewFormGridCellProvider, ReviewFormElementGridCellProvider, ReviewFormElementResponseItemListbuilderGridCellProvider, PLNStatusGridCellProvider, SwordDepositPointsGridCellProvider, and LanguageGridCellProvider.
Definition at line 76 of file GridCellProvider.inc.php.
Referenced by render().
GridCellProvider::render | ( | $request, | |
$row, | |||
$column | |||
) |
To be used by a GridRow to generate a rendered representation of the element for the given column.
$row | GridRow |
$column | GridColumn |
Reimplemented in GridCategoryRowCellProvider, and NullGridCellProvider.
Definition at line 39 of file GridCellProvider.inc.php.
References getCellActions(), PKPTemplateManager\getManager(), AppLocale\getSupportedFormLocales(), and getTemplateVarsFromRowColumn().