Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($dataProvider=null) | |
addAction ($action, $position=GRID_ACTION_POSITION_ABOVE) | |
addColumn ($column) | |
authorize ($request, &$args, $roleAssignments) | |
fetchCell (&$args, $request) | |
fetchGrid ($args, $request) | |
fetchRow ($args, $request) | |
fetchRows ($args, $request) | |
getActions ($position=GRID_ACTION_POSITION_ABOVE) | |
getColumn ($columnId) | |
& | getColumns () |
& | getColumnsByFlag ($flag) |
getColumnsCount ($flag=null) | |
getDataElementSequence ($gridDataElement) | |
getDataProvider () | |
getEmptyRowText () | |
getFeatures () | |
getFootNote () | |
& | getGridDataElements ($request) |
getGridRangeInfo ($request, $rangeName, $contextData=null) | |
getIsSubcomponent () | |
getItemIterator () | |
getJSHandler () | |
getPublishChangeEvents () | |
getRequestArg ($key) | |
getRequestArgs () | |
getRequestedRow ($request, $args) | |
getSelectName () | |
getTemplate () | |
getTitle () | |
getUrls () | |
hasColumn ($columnId) | |
hasGridDataElements ($request) | |
initialize ($request, $args=null) | |
isDataElementSelected ($gridDataElement) | |
renderRow ($request, $row) | |
saveSequence ($args, $request) | |
setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence) | |
setEmptyRowText ($emptyRowText) | |
setFootNote ($footNote) | |
setGridDataElements ($data) | |
setTemplate ($template) | |
setTitle ($title) | |
setUrls ($request, $extraUrls=array()) | |
Public Member Functions inherited from PKPHandler | |
__construct () | |
addPolicy ($authorizationPolicy, $addToTop=false) | |
addRoleAssignment ($roleIds, $operations) | |
getApiToken () | |
& | getAuthorizedContext () |
& | getAuthorizedContextObject ($assocType) |
& | getDispatcher () |
getFirstUserContext ($user, $contexts) | |
getId () | |
getLastAuthorizationMessage () | |
getRoleAssignment ($roleId) | |
getRoleAssignments () | |
getSiteRedirectContext ($request) | |
getTargetContext ($request, &$contextsCount=null) | |
index ($args, $request) | |
initialize ($request) | |
markRoleAssignmentsChecked () | |
requireSSL () | |
setApiToken ($apiToken) | |
setDispatcher ($dispatcher) | |
setEnforceRestrictedSite ($enforceRestrictedSite) | |
setId ($id) | |
setupTemplate ($request) | |
validate ($requiredContexts=null, $request=null) | |
Data Fields | |
$_actions = array(GRID_ACTION_POSITION_DEFAULT => array()) | |
$_columns = array() | |
$_constants = [] | |
$_data | |
$_dataProvider | |
$_emptyRowText = 'grid.noItems' | |
$_features | |
$_footNote = '' | |
$_itemIterator | |
$_template | |
$_title = '' | |
$_urls | |
Data Fields inherited from PKPHandler | |
$_authorizationDecisionManager | |
$_checks = array() | |
$_dispatcher | |
$_enforceRestrictedSite = true | |
$_id | |
$_isBackendPage = false | |
$_roleAssignments = array() | |
$_roleAssignmentsChecked = false | |
Protected Member Functions | |
callFeaturesHook ($hookName, $args) | |
doSpecificFetchGridActions ($args, $request, $templateMgr) | |
& | getDataElementFromRequest ($request, &$elementId) |
getFilterForm () | |
getFilterSelectionData ($request) | |
getRowDataElement ($request, &$rowId) | |
getRowInstance () | |
getRowsSequence ($request) | |
initFeatures ($request, $args) | |
isFilterFormCollapsible () | |
loadData ($request, $filter) | |
noAutocompleteResults () | |
renderFilter ($request, $filterData=array()) | |
renderGridBodyPartsInternally ($request) | |
renderRowInternally ($request, $row) | |
renderRowsInternally ($request, &$elements) | |
setFirstDataColumn () | |
Additional Inherited Members | |
Static Public Member Functions inherited from PKPHandler | |
static | getPageParamName ($rangeName) |
static | getRangeInfo ($request, $rangeName, $contextData=null) |
static | hashPageContext ($request, $contextData=array()) |
Protected Attributes inherited from PKPHandler | |
$_apiToken = null | |
This class defines basic operations for handling HTML grids. Grids are used to implement a standardized listing of elements, as would commonly be laid out in an HTML table, permitting rows, columns, row actions (such as "delete" and "edit" actions, which operate on a single row), and grid actions (such as "new element", which operates on the grid as a whole), and other functionality to be implemented consistently.
An implemented grid consists of several classes, with a subclass of GridHandler as the centerpiece. Each row is described by an instance of a GridRow, which is generally extended for the row in question; each column is described by an instance of GridColumn (for which several generic columns are implemented). Often grids will make use of a specific subclass of DataProvider in order to prepare data for display in the grid.
Actions (be they row or grid actions) are implemented by LinkAction instances.
There are several subclasses of GridHandler that provide generalized grids of particular forms, such as CategoryGridHandler and ListbuilderHandler.
The JavaScript front-end is described at https://pkp.sfu.ca/wiki/index.php?title=JavaScript_widget_controllers#Grids.
For a concrete example of a grid handler (and related classes), see AnnouncementTypeGridHandler.
Definition at line 58 of file GridHandler.inc.php.
GridHandler::__construct | ( | $dataProvider = null | ) |
Constructor.
$dataProvider | GridDataProvider An optional data provider for the grid. If no data provider is given then the grid assumes that child classes will override default method implementations. |
Reimplemented in PluginGridHandler, CategoryGridHandler, and LibraryFileGridHandler.
Definition at line 144 of file GridHandler.inc.php.
GridHandler::addAction | ( | $action, | |
$position = GRID_ACTION_POSITION_ABOVE |
|||
) |
Add an action.
$action | Mixed a single action. |
$position | string The position of the action. |
Definition at line 266 of file GridHandler.inc.php.
Referenced by FutureIssueGridHandler\initialize(), NotificationsGridHandler\initialize(), SubmissionChecklistGridHandler\initialize(), SectionGridHandler\initialize(), GenreGridHandler\initialize(), FileListGridHandler\initialize(), PluginGridHandler\initialize(), SubmissionDocumentsFilesGridHandler\initialize(), ReviewFormGridHandler\initialize(), ExportableUsersGridHandler\initialize(), SubscriptionsGridHandler\initialize(), SubscriptionTypesGridHandler\initialize(), SwordDepositPointsGridHandler\initialize(), UserGridHandler\initialize(), ContextGridHandler\initialize(), ListbuilderHandler\initialize(), CustomBlockGridHandler\initialize(), AdminLanguageGridHandler\initialize(), AnnouncementTypeGridHandler\initialize(), StaticPageGridHandler\initialize(), ReviewFormElementsGridHandler\initialize(), CategoryCategoryGridHandler\initialize(), NavigationMenuItemsGridHandler\initialize(), NavigationMenusGridHandler\initialize(), LibraryFileGridHandler\initialize(), IssueGalleyGridHandler\initialize(), StageParticipantGridHandler\initialize(), UserGroupGridHandler\initialize(), AuthorGridHandler\initialize(), ArticleGalleyGridHandler\initialize(), SubmissionFilesGridHandler\initialize(), QueriesGridHandler\initialize(), SelectableSubmissionFileListCategoryGridHandler\initialize(), PKPReviewerGridHandler\initialize(), and initialize().
GridHandler::addColumn | ( | $column | ) |
Add a column.
$column | mixed A single GridColumn instance. |
Definition at line 335 of file GridHandler.inc.php.
Referenced by CategoryGridHandler\__construct(), BackIssueGridHandler\_addCenterColumns(), PubIdExportSubmissionsListGridHandler\addAdditionalColumns(), LanguageGridHandler\addManagementColumns(), LanguageGridHandler\addNameColumn(), LanguageGridHandler\addPrimaryColumn(), InstitutionalSubscriptionsGridHandler\initialize(), IndividualSubscriptionsGridHandler\initialize(), ReviewFormElementResponseItemListbuilderHandler\initialize(), NotificationsGridHandler\initialize(), SubmissionChecklistGridHandler\initialize(), SectionGridHandler\initialize(), GenreGridHandler\initialize(), FileListGridHandler\initialize(), PluginGridHandler\initialize(), ReviewFormGridHandler\initialize(), PluginGalleryGridHandler\initialize(), PaymentsGridHandler\initialize(), ExportableUsersGridHandler\initialize(), SubscriberSelectGridHandler\initialize(), SubscriptionTypesGridHandler\initialize(), PLNStatusGridHandler\initialize(), SwordDepositPointsGridHandler\initialize(), AuthorReviewerGridHandler\initialize(), ContextGridHandler\initialize(), TocGridHandler\initialize(), UserGridHandler\initialize(), UserSelectGridHandler\initialize(), ExportPublishedSubmissionsListGridHandler\initialize(), PubIdExportRepresentationsListGridHandler\initialize(), CustomBlockGridHandler\initialize(), PubIdExportIssuesListGridHandler\initialize(), AdminLanguageGridHandler\initialize(), AnnouncementTypeGridHandler\initialize(), StaticPageGridHandler\initialize(), ReviewFormElementsGridHandler\initialize(), CategoryCategoryGridHandler\initialize(), IssueGridHandler\initialize(), NavigationMenusGridHandler\initialize(), NavigationMenuItemsGridHandler\initialize(), LibraryFileGridHandler\initialize(), QueryNotesGridHandler\initialize(), IssueGalleyGridHandler\initialize(), StageParticipantGridHandler\initialize(), UserGroupGridHandler\initialize(), AuthorGridHandler\initialize(), ArticleGalleyGridHandler\initialize(), SubmissionEventLogGridHandler\initialize(), SubmissionFilesGridHandler\initialize(), QueriesGridHandler\initialize(), SelectableSubmissionFileListCategoryGridHandler\initialize(), and PKPReviewerGridHandler\initialize().
GridHandler::authorize | ( | $request, | |
& | $args, | ||
$roleAssignments | |||
) |
Authorize this request.
Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.
NB: This method will be called once for every request only.
$request | Request |
$args | array request arguments |
$roleAssignments | array the operation role assignment, see getRoleAssignment() for more details. |
Reimplemented from PKPHandler.
Reimplemented in SelectableSubmissionFileListCategoryGridHandler, ReviewFormGridHandler, QueriesGridHandler, AuthorReviewerGridHandler, SubmissionFilesGridHandler, PluginGalleryGridHandler, AuthorGridHandler, PLNStatusGridHandler, ArticleGalleyGridHandler, SubmissionEventLogGridHandler, PKPReviewerGridHandler, QueryNotesGridHandler, StageParticipantGridHandler, SettingsPluginGridHandler, UserGroupGridHandler, CategoryCategoryGridHandler, SetupListbuilderHandler, StaticPageGridHandler, IssueGridHandler, SubmissionFileEventLogGridHandler, AdminPluginGridHandler, UserGridHandler, AdminLanguageGridHandler, ManageProofFilesGridHandler, NavigationMenuItemsGridHandler, ReviewFormElementsGridHandler, CustomBlockGridHandler, LimitReviewFilesGridHandler, SwordDepositPointsGridHandler, PubIdExportIssuesListGridHandler, PubIdExportRepresentationsListGridHandler, SubscriptionTypesGridHandler, SubscriberSelectGridHandler, NavigationMenusGridHandler, UserSelectGridHandler, ExportPublishedSubmissionsListGridHandler, SubscriptionsGridHandler, TocGridHandler, AnnouncementTypeGridHandler, ExportableUsersGridHandler, IssueGalleyGridHandler, PaymentsGridHandler, ContextGridHandler, and ManageLanguageGridHandler.
Definition at line 604 of file GridHandler.inc.php.
References PKPHandler\addPolicy(), PKPHandler\getAuthorizedContext(), and getDataProvider().
|
protected |
Call the passed hook in all attached features.
$hookName | string |
$args | array Arguments provided by this handler. |
Definition at line 996 of file GridHandler.inc.php.
References getFeatures().
Referenced by fetchGrid(), fetchRow(), fetchRows(), getGridDataElements(), getGridRangeInfo(), getRequestArgs(), initialize(), loadData(), saveSequence(), and setGridDataElements().
|
protected |
Override this method if your subclass needs to perform different actions than the ones implemented here. This method is called by GridHandler::fetchGrid()
$args | array |
$request | PKPRequest |
$templateMgr | PKPTemplateManager |
Reimplemented in CategoryGridHandler.
Definition at line 957 of file GridHandler.inc.php.
References renderGridBodyPartsInternally().
Referenced by fetchGrid().
GridHandler::fetchCell | ( | & | $args, |
$request | |||
) |
Render a cell and send it to the client
$args | array |
$request | PKPRequest |
Definition at line 765 of file GridHandler.inc.php.
References fatalError(), getColumn(), getRequestedRow(), hasColumn(), and setFirstDataColumn().
GridHandler::fetchGrid | ( | $args, | |
$request | |||
) |
Render the entire grid controller and send it to the client.
$args | array |
$request | PKPRequest |
Definition at line 661 of file GridHandler.inc.php.
References callFeaturesHook(), doSpecificFetchGridActions(), getColumns(), getFeatures(), PKPTemplateManager\getManager(), getRequestArgs(), renderFilter(), setFirstDataColumn(), and setUrls().
Referenced by ReviewFormElementResponseItemListbuilderHandler\fetch(), and ListbuilderHandler\fetch().
GridHandler::fetchRow | ( | $args, | |
$request | |||
) |
Render a row and send it to the client. If the row no longer exists then inform the client.
$args | array |
$request | PKPRequest |
Reimplemented in ArticleGalleyGridHandler.
Definition at line 734 of file GridHandler.inc.php.
References callFeaturesHook(), getRequestedRow(), getRowsSequence(), and renderRow().
GridHandler::fetchRows | ( | $args, | |
$request | |||
) |
Fetch all grid rows from loaded data.
$args | Array |
$request | PKPRequest |
Definition at line 704 of file GridHandler.inc.php.
References callFeaturesHook(), getGridDataElements(), renderRowsInternally(), and setFirstDataColumn().
GridHandler::getActions | ( | $position = GRID_ACTION_POSITION_ABOVE | ) |
Get all actions for a given position within the grid.
$position | string The position of the actions. |
Definition at line 256 of file GridHandler.inc.php.
GridHandler::getColumn | ( | $columnId | ) |
Retrieve a single column by id.
$columnId |
Definition at line 284 of file GridHandler.inc.php.
Referenced by fetchCell().
& GridHandler::getColumns | ( | ) |
Get all columns.
Definition at line 275 of file GridHandler.inc.php.
References $_columns.
Referenced by fetchGrid(), getColumnsByFlag(), getColumnsCount(), renderRowInternally(), CategoryGridHandler\setFirstDataColumn(), and setFirstDataColumn().
& GridHandler::getColumnsByFlag | ( | $flag | ) |
Get columns by flag.
$flag | string |
Definition at line 294 of file GridHandler.inc.php.
References getColumns().
GridHandler::getColumnsCount | ( | $flag = null | ) |
Get columns number. If a flag is passed, the columns using it will not be counted.
$flag | optional string |
Definition at line 311 of file GridHandler.inc.php.
References getColumns().
|
protected |
Create a data element from a request. This is used to format new rows prior to their insertion or existing rows that have been edited but not saved.
$request | PKPRequest |
$elementId | int Reference to be filled with element ID (if one is to be used) |
Definition at line 840 of file GridHandler.inc.php.
References fatalError().
GridHandler::getDataElementSequence | ( | $gridDataElement | ) |
Override to return the data element sequence value.
$gridDataElement | mixed |
Reimplemented in QueriesGridHandler, ArticleGalleyGridHandler, SectionGridHandler, GenreGridHandler, ReviewFormGridHandler, TocGridHandler, IssueGalleyGridHandler, AuthorGridHandler, SubmissionChecklistGridHandler, ReviewFormElementsGridHandler, ContextGridHandler, CategoryCategoryGridHandler, and BackIssueGridHandler.
Definition at line 491 of file GridHandler.inc.php.
GridHandler::getDataProvider | ( | ) |
Get the data provider.
Definition at line 157 of file GridHandler.inc.php.
References $_dataProvider.
Referenced by SubmissionFilesGridHandler\authorize(), SelectableSubmissionFileListCategoryGridHandler\authorize(), authorize(), SelectableSubmissionFileListCategoryGridHandler\getFilesToDownload(), getRequestArgs(), FileListGridHandler\initialize(), SubmissionFilesGridHandler\initialize(), SelectableSubmissionFileListCategoryGridHandler\initialize(), ManageQueryNoteFilesGridHandler\isDataElementInCategorySelected(), SelectableSubmissionFileListCategoryGridHandler\isDataElementInCategorySelected(), CategoryGridHandler\loadCategoryData(), loadData(), and ManageReviewFilesGridHandler\updateReviewFiles().
GridHandler::getEmptyRowText | ( | ) |
Get the no items locale key
Definition at line 223 of file GridHandler.inc.php.
References $_emptyRowText.
GridHandler::getFeatures | ( | ) |
Get all grid attached features.
Definition at line 455 of file GridHandler.inc.php.
References $_features.
Referenced by callFeaturesHook(), and fetchGrid().
|
protected |
Returns a Form object or the path name of a filter template.
Reimplemented in ExportableUsersGridHandler, UserGridHandler, UserGroupGridHandler, PubIdExportRepresentationsListGridHandler, SubscriberSelectGridHandler, SubmissionFilesGridHandler, UserSelectGridHandler, ExportPublishedSubmissionsListGridHandler, PubIdExportIssuesListGridHandler, PluginGalleryGridHandler, SubmissionFileEventLogGridHandler, SubscriptionsGridHandler, SelectableSubmissionFileListCategoryGridHandler, and PluginGridHandler.
Definition at line 887 of file GridHandler.inc.php.
Referenced by initialize(), and renderFilter().
|
protected |
Method that extracts the user's filter selection from the request either by instantiating the filter's Form object or by reading the request directly (if using a simple filter template only).
$request | PKPRequest |
Reimplemented in ExportableUsersGridHandler, UserGroupGridHandler, PubIdExportRepresentationsListGridHandler, UserGridHandler, ExportPublishedSubmissionsListGridHandler, SubmissionFilesGridHandler, PubIdExportIssuesListGridHandler, UserSelectGridHandler, SubscriberSelectGridHandler, PluginGalleryGridHandler, SubmissionFileEventLogGridHandler, SelectableSubmissionFileListCategoryGridHandler, PluginGridHandler, and SubscriptionsGridHandler.
Definition at line 906 of file GridHandler.inc.php.
Referenced by CategoryGridHandler\getGridCategoryDataElements(), getGridDataElements(), and renderFilter().
GridHandler::getFootNote | ( | ) |
Get the grid foot note.
Definition at line 239 of file GridHandler.inc.php.
References $_footNote.
& GridHandler::getGridDataElements | ( | $request | ) |
Get the grid data.
$request | PKPRequest |
Definition at line 345 of file GridHandler.inc.php.
References $_data, callFeaturesHook(), getFilterSelectionData(), loadData(), and setGridDataElements().
Referenced by AdminLanguageGridHandler\_updateLocaleSupportState(), StageParticipantGridHandler\addParticipant(), AdminLanguageGridHandler\disableLocale(), AdminLanguageGridHandler\enableLocale(), ListbuilderHandler\fetch(), fetchRows(), SubmissionFilesGridHandler\getFilesToDownload(), SelectableSubmissionFileListCategoryGridHandler\getFilesToDownload(), CategoryGridHandler\getGridCategoryDataElements(), getRowDataElement(), getRowsSequence(), hasGridDataElements(), ManageLanguageGridHandler\reloadLocale(), renderGridBodyPartsInternally(), LanguageGridHandler\saveLanguageSetting(), StageParticipantGridHandler\saveParticipant(), LanguageGridHandler\setContextPrimaryLocale(), AdminLanguageGridHandler\setPrimaryLocale(), and AdminLanguageGridHandler\uninstallLocale().
GridHandler::getGridRangeInfo | ( | $request, | |
$rangeName, | |||
$contextData = null |
|||
) |
Get grid range info.
$request | PKPRequest |
$rangeName | string The grid id. |
$contextData | mixed |
Definition at line 589 of file GridHandler.inc.php.
References callFeaturesHook().
Referenced by PLNStatusGridHandler\loadData(), PaymentsGridHandler\loadData(), UserSelectGridHandler\loadData(), IndividualSubscriptionsGridHandler\loadData(), InstitutionalSubscriptionsGridHandler\loadData(), SubscriptionTypesGridHandler\loadData(), UserGroupGridHandler\loadData(), UserGridHandler\loadData(), and ExportableUsersGridHandler\loadData().
GridHandler::getIsSubcomponent | ( | ) |
Override this method to return true if you want to use the grid within another component (e.g. to remove the title or change the layout accordingly).
Reimplemented in StageParticipantGridHandler.
Definition at line 447 of file GridHandler.inc.php.
GridHandler::getItemIterator | ( | ) |
Get the item iterator that represents this grid data. Should only be used for retrieving paging data. See #6498.
Definition at line 465 of file GridHandler.inc.php.
References $_itemIterator.
GridHandler::getJSHandler | ( | ) |
Get the js handler for this component.
Reimplemented in StageParticipantGridHandler, CategoryGridHandler, UserGridHandler, BackIssueGridHandler, NotificationsGridHandler, ArticleGalleyGridHandler, FutureIssueGridHandler, and AuthorReviewRevisionsGridHandler.
Definition at line 799 of file GridHandler.inc.php.
GridHandler::getPublishChangeEvents | ( | ) |
Get "publish data changed" event list.
Reimplemented in ContextGridHandler, and NotificationsGridHandler.
Definition at line 473 of file GridHandler.inc.php.
GridHandler::getRequestArg | ( | $key | ) |
Get a single grid request parameter.
$key | string The name of the parameter to retrieve. |
Definition at line 197 of file GridHandler.inc.php.
References getRequestArgs().
Referenced by CategoryGridHandler\renderRowInternally().
GridHandler::getRequestArgs | ( | ) |
Get the grid request parameters. These are the parameters that uniquely identify the data within a grid.
NB: You should make sure to authorize and/or validate parameters before you publish them through this interface. Callers will assume that data accessed through this method will not have to be sanitized.
The default implementation tries to retrieve request parameters from a data provider if there is one.
Reimplemented in UserGridHandler, PKPReviewerGridHandler, QueriesGridHandler, ExportableUsersGridHandler, CategoryGridHandler, AuthorGridHandler, StageParticipantGridHandler, SubscriberSelectGridHandler, ArticleGalleyGridHandler, SubmissionEventLogGridHandler, UserSelectGridHandler, PubIdExportRepresentationsListGridHandler, ReviewFormElementsGridHandler, ExportPublishedSubmissionsListGridHandler, QueryNotesGridHandler, PubIdExportIssuesListGridHandler, TocGridHandler, ManageReviewFilesGridHandler, IssueGalleyGridHandler, SubmissionFileEventLogGridHandler, ManageProofFilesGridHandler, and DependentFilesGridHandler.
Definition at line 178 of file GridHandler.inc.php.
References callFeaturesHook(), and getDataProvider().
Referenced by fetchGrid(), and getRequestArg().
GridHandler::getRequestedRow | ( | $request, | |
$args | |||
) |
Tries to identify the data element in the grids data source that corresponds to the requested row id. Raises a fatal error if such an element cannot be found.
$request | PKPRequest |
$args | array |
Definition at line 539 of file GridHandler.inc.php.
References getRowDataElement().
Referenced by fetchCell(), ArticleGalleyGridHandler\fetchRow(), and fetchRow().
|
protected |
Retrieve a single data element from the grid's data source corresponding to the given row id. If none is found then return null.
$request | PKPRequest |
$rowId | string The row ID; reference permits modification. |
Reimplemented in CategoryGridHandler, and ReviewFormElementResponseItemListbuilderHandler.
Definition at line 852 of file GridHandler.inc.php.
References getGridDataElements().
Referenced by getRequestedRow().
|
protected |
Get a new instance of a grid row. May be overridden by subclasses if they want to provide a custom row definition.
Reimplemented in ListbuilderHandler, PKPReviewerGridHandler, QueriesGridHandler, SelectableSubmissionFileListCategoryGridHandler, AuthorGridHandler, SubmissionFilesGridHandler, StageParticipantGridHandler, UserGroupGridHandler, ArticleGalleyGridHandler, CategoryCategoryGridHandler, IssueGalleyGridHandler, SubmissionEventLogGridHandler, LibraryFileGridHandler, ReviewFormGridHandler, SectionGridHandler, UserGridHandler, NavigationMenusGridHandler, ReviewFormElementsGridHandler, NavigationMenuItemsGridHandler, QueryNotesGridHandler, SubscriptionTypesGridHandler, GenreGridHandler, ContextGridHandler, TocGridHandler, AnnouncementTypeGridHandler, IssueGridHandler, StaticPageGridHandler, CustomBlockGridHandler, SwordDepositPointsGridHandler, SubmissionDocumentsFilesGridHandler, SubscriptionsGridHandler, SubmissionChecklistGridHandler, PLNStatusGridHandler, SettingsPluginGridHandler, ExportableIssuesListGridHandler, LanguageGridHandler, AuthorReviewerGridHandler, and AdminPluginGridHandler.
Definition at line 826 of file GridHandler.inc.php.
|
protected |
Return the sequence map of the current loaded grid items. This is not the sequence value of the data represented by the row, it's just the mapping of the rows sequence, in the order that they are loaded. To handle grid items ordering, see OrderItemsFeature class.
$request | PKPRequest |
Reimplemented in CategoryGridHandler.
Definition at line 815 of file GridHandler.inc.php.
References getGridDataElements().
Referenced by fetchRow().
GridHandler::getSelectName | ( | ) |
Get the select parameter name to store the selected files.
Reimplemented in SelectableSubmissionFileListCategoryGridHandler, PubIdExportRepresentationsListGridHandler, ExportPublishedSubmissionsListGridHandler, PubIdExportIssuesListGridHandler, ExportableUsersGridHandler, NotificationsGridHandler, SelectableFileListGridHandler, EditorSelectableReviewAttachmentsGridHandler, SelectableLibraryFileGridHandler, and ExportableIssuesListGridHandler.
Definition at line 524 of file GridHandler.inc.php.
GridHandler::getTemplate | ( | ) |
Get the grid template.
Reimplemented in ListbuilderHandler.
Definition at line 399 of file GridHandler.inc.php.
References $_template, and setTemplate().
GridHandler::getTitle | ( | ) |
Get the grid title.
Definition at line 207 of file GridHandler.inc.php.
References $_title.
GridHandler::getUrls | ( | ) |
Return all grid urls that will be used in JS handler.
Definition at line 420 of file GridHandler.inc.php.
References $_urls.
GridHandler::hasColumn | ( | $columnId | ) |
Checks whether a column exists.
$columnId |
Definition at line 327 of file GridHandler.inc.php.
Referenced by fetchCell().
GridHandler::hasGridDataElements | ( | $request | ) |
Check whether the grid has rows.
Definition at line 369 of file GridHandler.inc.php.
References getGridDataElements().
|
protected |
Override to init grid features. This method is called by GridHandler::initialize() method that use the returned array with the initialized features to add them to grid.
$request | PKPRequest |
$args | array |
Reimplemented in UserGroupGridHandler, SelectableSubmissionFileListCategoryGridHandler, QueriesGridHandler, AuthorGridHandler, ReviewFormGridHandler, ContextGridHandler, PubIdExportRepresentationsListGridHandler, UserGridHandler, ArticleGalleyGridHandler, ExportableUsersGridHandler, SubscriptionTypesGridHandler, SectionGridHandler, ExportPublishedSubmissionsListGridHandler, PubIdExportIssuesListGridHandler, NotificationsGridHandler, ReviewFormElementsGridHandler, CategoryCategoryGridHandler, GenreGridHandler, UserSelectGridHandler, PaymentsGridHandler, SubscriberSelectGridHandler, TocGridHandler, BackIssueGridHandler, SubscriptionsGridHandler, SubmissionChecklistGridHandler, IssueGalleyGridHandler, PLNStatusGridHandler, ExportableIssuesListGridHandler, SelectableFileListGridHandler, and SelectableLibraryFileGridHandler.
Definition at line 985 of file GridHandler.inc.php.
References HookRegistry\call(), and strtolower_codesafe().
Referenced by initialize().
GridHandler::initialize | ( | $request, | |
$args = null |
|||
) |
$request | PKPRequest |
$args | array optional |
Reimplemented in CategoryGridHandler, PKPReviewerGridHandler, SelectableSubmissionFileListCategoryGridHandler, QueriesGridHandler, SubmissionFilesGridHandler, SubmissionEventLogGridHandler, ArticleGalleyGridHandler, AuthorGridHandler, UserGroupGridHandler, StageParticipantGridHandler, IssueGalleyGridHandler, QueryNotesGridHandler, LibraryFileGridHandler, NavigationMenuItemsGridHandler, NavigationMenusGridHandler, ManageLanguageGridHandler, IssueGridHandler, CategoryCategoryGridHandler, ReviewFormElementsGridHandler, SetupListbuilderHandler, AnnouncementTypeGridHandler, StaticPageGridHandler, AdminLanguageGridHandler, CopyeditFilesGridHandler, SubmissionFileEventLogGridHandler, PubIdExportIssuesListGridHandler, PubIdExportRepresentationsListGridHandler, CustomBlockGridHandler, ExportPublishedSubmissionsListGridHandler, ListbuilderHandler, TocGridHandler, ContextGridHandler, UserGridHandler, UserSelectGridHandler, AuthorReviewerGridHandler, SwordDepositPointsGridHandler, SubscriptionTypesGridHandler, SubscriberSelectGridHandler, PLNStatusGridHandler, SubscriptionsGridHandler, ExportableUsersGridHandler, PaymentsGridHandler, ProductionReadyFilesGridHandler, PluginGalleryGridHandler, ReviewFormGridHandler, LibraryFileAdminGridHandler, ReviewerReviewAttachmentsGridHandler, SubmissionDocumentsFilesGridHandler, PluginGridHandler, FileListGridHandler, GenreGridHandler, LanguageGridHandler, SectionGridHandler, BackIssueGridHandler, SubmissionChecklistGridHandler, NotificationsGridHandler, SetupGridHandler, ReviewFormElementResponseItemListbuilderHandler, FutureIssueGridHandler, IndividualSubscriptionsGridHandler, InstitutionalSubscriptionsGridHandler, and TaskNotificationsGridHandler.
Definition at line 625 of file GridHandler.inc.php.
References addAction(), callFeaturesHook(), getFilterForm(), initFeatures(), isFilterFormCollapsible(), and AppLocale\requireComponents().
GridHandler::isDataElementSelected | ( | $gridDataElement | ) |
Returns the current selection state of the grid data element.
$gridDataElement | mixed |
Reimplemented in PubIdExportRepresentationsListGridHandler, ExportableUsersGridHandler, ExportPublishedSubmissionsListGridHandler, PubIdExportIssuesListGridHandler, NotificationsGridHandler, LimitReviewFilesGridHandler, SelectableFileListGridHandler, SelectableReviewRevisionsGridHandler, SelectableCopyeditFilesGridHandler, SelectableFinalDraftFilesGridHandler, EditorSelectableReviewAttachmentsGridHandler, and ExportableIssuesListGridHandler.
Definition at line 515 of file GridHandler.inc.php.
|
protected |
Determine whether a filter form should be collapsible.
Reimplemented in SubscriberSelectGridHandler, UserSelectGridHandler, and SelectableSubmissionFileListCategoryGridHandler.
Definition at line 895 of file GridHandler.inc.php.
Referenced by initialize().
|
protected |
Implement this method to load data into the grid.
$request | PKPRequest |
$filter | array An associative array with filter data as returned by getFilterSelectionData(). If no filter has been selected by the user then the array will be empty. |
Reimplemented in QueriesGridHandler, AuthorGridHandler, ArticleGalleyGridHandler, SubmissionEventLogGridHandler, ReviewFormGridHandler, QueryNotesGridHandler, ReviewFormElementsGridHandler, ContextGridHandler, SubmissionFileEventLogGridHandler, ReviewFormElementResponseItemListbuilderHandler, PKPReviewerGridHandler, IssueGalleyGridHandler, PubIdExportRepresentationsListGridHandler, StageParticipantGridHandler, ExportPublishedSubmissionsListGridHandler, PluginGridHandler, PubIdExportIssuesListGridHandler, ExportableUsersGridHandler, UserGridHandler, UserGroupGridHandler, SubscriptionTypesGridHandler, TocGridHandler, AuthorReviewerGridHandler, LibraryFileGridHandler, IndividualSubscriptionsGridHandler, InstitutionalSubscriptionsGridHandler, NavigationMenusGridHandler, AdminLanguageGridHandler, UserSelectGridHandler, PluginGalleryGridHandler, NavigationMenuItemsGridHandler, PaymentsGridHandler, SubscriberSelectGridHandler, AnnouncementTypeGridHandler, CategoryCategoryGridHandler, GenreGridHandler, PLNStatusGridHandler, SelectableSubmissionFileListCategoryGridHandler, SubmissionChecklistGridHandler, BackIssueGridHandler, FutureIssueGridHandler, ManageLanguageGridHandler, ExportableIssuesListGridHandler, TaskNotificationsGridHandler, and PubIdExportSubmissionsListGridHandler.
Definition at line 869 of file GridHandler.inc.php.
References callFeaturesHook(), and getDataProvider().
Referenced by getGridDataElements().
|
protected |
Returns a common 'no matches' result when subclasses find no results for AJAX autocomplete requests.
Definition at line 942 of file GridHandler.inc.php.
Referenced by PKPReviewerGridHandler\getUsersNotAssignedAsReviewers().
|
protected |
Render the filter (a template).
$request | PKPRequest |
$filterData | Array Data to be used by the filter template. |
Reimplemented in UserGroupGridHandler, PubIdExportRepresentationsListGridHandler, ExportableUsersGridHandler, UserGridHandler, SubmissionFilesGridHandler, ExportPublishedSubmissionsListGridHandler, PubIdExportIssuesListGridHandler, PluginGalleryGridHandler, UserSelectGridHandler, SubscriberSelectGridHandler, PluginGridHandler, and IndividualSubscriptionsGridHandler.
Definition at line 916 of file GridHandler.inc.php.
References getFilterForm(), getFilterSelectionData(), and PKPTemplateManager\getManager().
Referenced by fetchGrid().
|
protected |
Method that renders tbodys to go in the grid main body.
$request | PKPRequest |
Definition at line 1066 of file GridHandler.inc.php.
References getGridDataElements(), PKPTemplateManager\getManager(), and renderRowsInternally().
Referenced by doSpecificFetchGridActions().
GridHandler::renderRow | ( | $request, | |
$row | |||
) |
Render the passed row and return its markup.
$request | PKPRequest |
$row | GridRow |
Definition at line 577 of file GridHandler.inc.php.
References renderRowInternally(), and setFirstDataColumn().
Referenced by fetchRow().
|
protected |
Method that renders a single row.
NB: You must have initialized the row before you call this method.
$request | PKPRequest |
$row | GridRow |
Reimplemented in CategoryGridHandler.
Definition at line 1040 of file GridHandler.inc.php.
References getColumns(), and PKPTemplateManager\getManager().
Referenced by renderRow(), and renderRowsInternally().
|
protected |
Cycle through the data and get generate the row HTML.
$request | PKPRequest |
$elements | array The grid data elements to be rendered. |
Definition at line 1015 of file GridHandler.inc.php.
References renderRowInternally().
Referenced by fetchRows(), and renderGridBodyPartsInternally().
GridHandler::saveSequence | ( | $args, | |
$request | |||
) |
Hook opportunity for grid features to request a save items sequence operation. If no grid feature that implements the saveSequence hook is attached to this grid, this operation will only return the data changed event json message.
$args | array |
$request | PKPRequest |
Definition at line 789 of file GridHandler.inc.php.
References callFeaturesHook(), and DAO\getDataChangedEvent().
GridHandler::setDataElementSequence | ( | $request, | |
$rowId, | |||
$gridDataElement, | |||
$newSequence | |||
) |
Override to set the data element new sequence.
$request | PKPRequest |
$rowId | int |
$gridDataElement | mixed |
$newSequence | int |
Reimplemented in TocGridHandler, QueriesGridHandler, AuthorGridHandler, SubmissionChecklistGridHandler, ReviewFormGridHandler, ArticleGalleyGridHandler, ReviewFormElementsGridHandler, SectionGridHandler, ContextGridHandler, GenreGridHandler, IssueGalleyGridHandler, BackIssueGridHandler, and CategoryCategoryGridHandler.
Definition at line 502 of file GridHandler.inc.php.
GridHandler::setEmptyRowText | ( | $emptyRowText | ) |
Set the no items locale key
$emptyRowText | string locale key |
Definition at line 231 of file GridHandler.inc.php.
Referenced by NotificationsGridHandler\initialize(), PluginGridHandler\initialize(), PLNStatusGridHandler\initialize(), SwordDepositPointsGridHandler\initialize(), CustomBlockGridHandler\initialize(), StaticPageGridHandler\initialize(), AnnouncementTypeGridHandler\initialize(), NavigationMenusGridHandler\initialize(), NavigationMenuItemsGridHandler\initialize(), SubmissionFilesGridHandler\initialize(), and SelectableSubmissionFileListCategoryGridHandler\initialize().
|
protected |
Define the first column that will contain grid data.
Override this method to define a different column than the first one.
Reimplemented in CategoryGridHandler.
Definition at line 970 of file GridHandler.inc.php.
References getColumns().
Referenced by fetchCell(), fetchGrid(), fetchRows(), and renderRow().
GridHandler::setFootNote | ( | $footNote | ) |
Set the grid foot note.
$footNote | string locale key |
Definition at line 247 of file GridHandler.inc.php.
Referenced by AdminLanguageGridHandler\initialize().
GridHandler::setGridDataElements | ( | $data | ) |
Set the grid data.
$data | mixed an array or ItemIterator with element data |
Definition at line 379 of file GridHandler.inc.php.
References callFeaturesHook().
Referenced by getGridDataElements(), SectionGridHandler\initialize(), SwordDepositPointsGridHandler\initialize(), CustomBlockGridHandler\initialize(), and StaticPageGridHandler\initialize().
GridHandler::setTemplate | ( | $template | ) |
Set the grid template.
$template | string |
Definition at line 411 of file GridHandler.inc.php.
Referenced by ListbuilderHandler\getTemplate(), and getTemplate().
GridHandler::setTitle | ( | $title | ) |
Set the grid title.
$title | string locale key |
Definition at line 215 of file GridHandler.inc.php.
Referenced by EditorSelectableReviewAttachmentsGridHandler\__construct(), ReviewerReviewAttachmentsGridHandler\__construct(), WorkflowReviewRevisionsGridHandler\__construct(), ReviewerReviewFilesGridHandler\__construct(), AuthorReviewRevisionsGridHandler\__construct(), ManageCopyeditFilesGridHandler\__construct(), SelectableCopyeditFilesGridHandler\__construct(), SelectableFinalDraftFilesGridHandler\__construct(), ManageFinalDraftFilesGridHandler\__construct(), SelectableSubmissionDetailsFilesGridHandler\__construct(), EditorSubmissionDetailsFilesGridHandler\__construct(), ManageProofFilesGridHandler\__construct(), ManageQueryNoteFilesGridHandler\__construct(), FinalDraftFilesGridHandler\__construct(), CopyeditFilesGridHandler\__construct(), QueryNoteFilesGridHandler\__construct(), AuthorReviewAttachmentsGridHandler\__construct(), LimitReviewFilesGridHandler\__construct(), SelectableReviewRevisionsGridHandler\__construct(), EditorReviewFilesGridHandler\__construct(), SubmissionWizardFilesGridHandler\__construct(), AuthorSubmissionDetailsFilesGridHandler\__construct(), DependentFilesGridHandler\__construct(), StageParticipantGridHandler\__construct(), ManageReviewFilesGridHandler\__construct(), IndividualSubscriptionsGridHandler\initialize(), InstitutionalSubscriptionsGridHandler\initialize(), TaskNotificationsGridHandler\initialize(), FutureIssueGridHandler\initialize(), ReviewFormElementResponseItemListbuilderHandler\initialize(), SubmissionChecklistGridHandler\initialize(), BackIssueGridHandler\initialize(), SectionGridHandler\initialize(), LanguageGridHandler\initialize(), GenreGridHandler\initialize(), PluginGridHandler\initialize(), SubmissionDocumentsFilesGridHandler\initialize(), PluginGalleryGridHandler\initialize(), ReviewFormGridHandler\initialize(), ProductionReadyFilesGridHandler\initialize(), ExportableUsersGridHandler\initialize(), PLNStatusGridHandler\initialize(), SubscriberSelectGridHandler\initialize(), SubscriptionTypesGridHandler\initialize(), SwordDepositPointsGridHandler\initialize(), UserSelectGridHandler\initialize(), ContextGridHandler\initialize(), UserGridHandler\initialize(), ExportPublishedSubmissionsListGridHandler\initialize(), PubIdExportRepresentationsListGridHandler\initialize(), PubIdExportIssuesListGridHandler\initialize(), CustomBlockGridHandler\initialize(), AnnouncementTypeGridHandler\initialize(), StaticPageGridHandler\initialize(), ReviewFormElementsGridHandler\initialize(), CategoryCategoryGridHandler\initialize(), NavigationMenusGridHandler\initialize(), NavigationMenuItemsGridHandler\initialize(), LibraryFileGridHandler\initialize(), QueryNotesGridHandler\initialize(), UserGroupGridHandler\initialize(), AuthorGridHandler\initialize(), ArticleGalleyGridHandler\initialize(), QueriesGridHandler\initialize(), and PKPReviewerGridHandler\initialize().
GridHandler::setUrls | ( | $request, | |
$extraUrls = array() |
|||
) |
Define the urls that will be used in JS handler.
$request | PKPRequest |
$extraUrls | array Optional extra urls. |
Reimplemented in CategoryGridHandler, and NotificationsGridHandler.
Definition at line 430 of file GridHandler.inc.php.
Referenced by fetchGrid().
array GridHandler::$_actions = array(GRID_ACTION_POSITION_DEFAULT => array()) |
Grid actions. The first key represents the position of the action in the grid, the second key represents the action id.
Definition at line 92 of file GridHandler.inc.php.
array GridHandler::$_columns = array() |
The GridColumns of this grid.
Definition at line 98 of file GridHandler.inc.php.
Referenced by getColumns().
array GridHandler::$_constants = [] |
Constants that should be passed to the template
Definition at line 134 of file GridHandler.inc.php.
Array GridHandler::$_data |
The grid's data source.
Definition at line 104 of file GridHandler.inc.php.
Referenced by getGridDataElements().
GridDataProvider GridHandler::$_dataProvider |
Definition at line 82 of file GridHandler.inc.php.
Referenced by getDataProvider().
string GridHandler::$_emptyRowText = 'grid.noItems' |
empty row locale key
Definition at line 70 of file GridHandler.inc.php.
Referenced by getEmptyRowText().
array GridHandler::$_features |
string GridHandler::$_footNote = '' |
Grid foot note locale key
Definition at line 76 of file GridHandler.inc.php.
Referenced by getFootNote().
ItemIterator GridHandler::$_itemIterator |
The item iterator to be used for paging.
Definition at line 110 of file GridHandler.inc.php.
Referenced by getItemIterator().
string GridHandler::$_template |
The grid template.
Definition at line 116 of file GridHandler.inc.php.
Referenced by ListbuilderHandler\getTemplate(), and getTemplate().
string GridHandler::$_title = '' |
array GridHandler::$_urls |
The urls that will be used in JS handler.
Definition at line 122 of file GridHandler.inc.php.
Referenced by getUrls().