Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($dataProvider=null) | |
fetchCategory ($args, $request) | |
getCategoryItemsCount ($categoryElement, $request) | |
getCurrentCategoryId () | |
getDataElementInCategorySequence ($categoryId, &$gridDataElement) | |
getEmptyCategoryRowText () | |
& | getGridCategoryDataElements ($request, $categoryElement) |
getJSHandler () | |
getRequestArgs () | |
hasGridDataElementsInCategory ($categoryElement, $request) | |
initialize ($request, $args=null) | |
isDataElementInCategorySelected ($categoryId, &$gridDataElement) | |
setDataElementInCategorySequence ($categoryId, &$gridDataElement, $newSequence) | |
setEmptyCategoryRowText ($translationKey) | |
setGridCategoryDataElements ($request, $categoryElementId, $data) | |
setUrls ($request, $extraUrls=array()) | |
Public Member Functions inherited from GridHandler | |
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 () | |
getPublishChangeEvents () | |
getRequestArg ($key) | |
getRequestedRow ($request, $args) | |
getSelectName () | |
getTemplate () | |
getTitle () | |
getUrls () | |
hasColumn ($columnId) | |
hasGridDataElements ($request) | |
isDataElementSelected ($gridDataElement) | |
renderRow ($request, $row) | |
saveSequence ($args, $request) | |
setDataElementSequence ($request, $rowId, $gridDataElement, $newSequence) | |
setEmptyRowText ($emptyRowText) | |
setFootNote ($footNote) | |
setGridDataElements ($data) | |
setTemplate ($template) | |
setTitle ($title) | |
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 | |
$_categoryData | |
$_currentCategoryId = null | |
$_emptyCategoryRowText = 'grid.noItems' | |
Data Fields inherited from GridHandler | |
$_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 | |
doSpecificFetchGridActions ($args, $request, $templateMgr) | |
getCategoryRowIdParameterName () | |
getCategoryRowInstance () | |
getRequestedCategoryRow ($request, $args) | |
getRowDataElement ($request, &$rowId) | |
getRowsSequence ($request) | |
loadCategoryData ($request, &$categoryDataElement, $filter=null) | |
renderRowInternally ($request, $row) | |
setFirstDataColumn () | |
Protected Member Functions inherited from GridHandler | |
callFeaturesHook ($hookName, $args) | |
& | getDataElementFromRequest ($request, &$elementId) |
getFilterForm () | |
getFilterSelectionData ($request) | |
getRowInstance () | |
initFeatures ($request, $args) | |
isFilterFormCollapsible () | |
loadData ($request, $filter) | |
noAutocompleteResults () | |
renderFilter ($request, $filterData=array()) | |
renderGridBodyPartsInternally ($request) | |
renderRowsInternally ($request, &$elements) | |
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 | |
Class defining basic operations for handling HTML grids with categories.
Definition at line 23 of file CategoryGridHandler.inc.php.
CategoryGridHandler::__construct | ( | $dataProvider = null | ) |
Constructor.
Reimplemented from GridHandler.
Reimplemented in PluginGridHandler, and LibraryFileGridHandler.
Definition at line 47 of file CategoryGridHandler.inc.php.
References GridHandler\addColumn().
|
protected |
Reimplemented from GridHandler.
Definition at line 283 of file CategoryGridHandler.inc.php.
CategoryGridHandler::fetchCategory | ( | $args, | |
$request | |||
) |
Render a category with all the rows inside of it.
$args | array |
$request | Request |
Definition at line 206 of file CategoryGridHandler.inc.php.
References getRequestedCategoryRow(), and setFirstDataColumn().
CategoryGridHandler::getCategoryItemsCount | ( | $categoryElement, | |
$request | |||
) |
Get the number of elements inside the passed category element.
$categoryElement | mixed |
$request | PKPRequest |
Definition at line 165 of file CategoryGridHandler.inc.php.
References getGridCategoryDataElements().
|
protected |
Get the category row id parameter name.
Reimplemented in StageParticipantGridHandler, PluginGridHandler, CategoryCategoryGridHandler, and TocGridHandler.
Definition at line 393 of file CategoryGridHandler.inc.php.
Referenced by getRequestArgs(), and renderRowInternally().
|
protected |
Get a new instance of a category grid row. May be overridden by subclasses if they want to provide a custom row definition.
Reimplemented in StageParticipantGridHandler, CategoryCategoryGridHandler, PluginGridHandler, SelectableSubmissionFileListCategoryGridHandler, TocGridHandler, and LibraryFileGridHandler.
Definition at line 384 of file CategoryGridHandler.inc.php.
CategoryGridHandler::getCurrentCategoryId | ( | ) |
Get the category id that this grid is currently rendering.
int |
Definition at line 79 of file CategoryGridHandler.inc.php.
References $_currentCategoryId.
Referenced by getRowsSequence().
CategoryGridHandler::getDataElementInCategorySequence | ( | $categoryId, | |
& | $gridDataElement | ||
) |
Override to return the data element sequence value inside the passed category, if needed.
$categoryId | int The data element category id. |
$gridDataElement | mixed The element to return the sequence. |
Reimplemented in TocGridHandler, and CategoryCategoryGridHandler.
Definition at line 91 of file CategoryGridHandler.inc.php.
CategoryGridHandler::getEmptyCategoryRowText | ( | ) |
Get the empty rows text for a category.
Definition at line 63 of file CategoryGridHandler.inc.php.
References $_emptyCategoryRowText.
& CategoryGridHandler::getGridCategoryDataElements | ( | $request, | |
$categoryElement | |||
) |
Get the grid category data.
$request | PKPRequest |
$categoryElement | mixed The category element. |
Definition at line 123 of file CategoryGridHandler.inc.php.
References GridHandler\getFilterSelectionData(), GridHandler\getGridDataElements(), loadCategoryData(), and setGridCategoryDataElements().
Referenced by getCategoryItemsCount(), SelectableSubmissionFileListCategoryGridHandler\getFilesToDownload(), getRowDataElement(), getRowsSequence(), hasGridDataElementsInCategory(), ManageCopyeditFilesGridHandler\updateCopyeditFiles(), ManageFinalDraftFilesGridHandler\updateFinalDraftFiles(), ManageProofFilesGridHandler\updateProofFiles(), ManageQueryNoteFilesGridHandler\updateQueryNoteFiles(), and ManageReviewFilesGridHandler\updateReviewFiles().
CategoryGridHandler::getJSHandler | ( | ) |
Get the js handler for this component.
Reimplemented from GridHandler.
Reimplemented in StageParticipantGridHandler.
Definition at line 260 of file CategoryGridHandler.inc.php.
CategoryGridHandler::getRequestArgs | ( | ) |
Reimplemented from GridHandler.
Reimplemented in StageParticipantGridHandler, TocGridHandler, ManageReviewFilesGridHandler, and ManageProofFilesGridHandler.
Definition at line 241 of file CategoryGridHandler.inc.php.
References $_currentCategoryId, and getCategoryRowIdParameterName().
Referenced by setUrls().
|
protected |
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 352 of file CategoryGridHandler.inc.php.
References getRowDataElement().
Referenced by fetchCategory().
|
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 from GridHandler.
Definition at line 292 of file CategoryGridHandler.inc.php.
References getGridCategoryDataElements().
Referenced by getRequestedCategoryRow().
|
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 from GridHandler.
Definition at line 276 of file CategoryGridHandler.inc.php.
References getCurrentCategoryId(), and getGridCategoryDataElements().
CategoryGridHandler::hasGridDataElementsInCategory | ( | $categoryElement, | |
$request | |||
) |
Check whether the passed category has grid rows.
$categoryElement | mixed The category data element that will be checked. |
$request | PKPRequest |
Definition at line 153 of file CategoryGridHandler.inc.php.
References getGridCategoryDataElements().
CategoryGridHandler::initialize | ( | $request, | |
$args = null |
|||
) |
$request | PKPRequest |
$args | array optional |
Reimplemented from GridHandler.
Reimplemented in SelectableSubmissionFileListCategoryGridHandler, StageParticipantGridHandler, LibraryFileGridHandler, CategoryCategoryGridHandler, TocGridHandler, LibraryFileAdminGridHandler, SubmissionDocumentsFilesGridHandler, and PluginGridHandler.
Definition at line 230 of file CategoryGridHandler.inc.php.
CategoryGridHandler::isDataElementInCategorySelected | ( | $categoryId, | |
& | $gridDataElement | ||
) |
Override to define whether the data element inside the passed category is selected or not.
$categoryId | int |
$gridDataElement | mixed |
Reimplemented in SelectableSubmissionFileListCategoryGridHandler, ManageQueryNoteFilesGridHandler, and SelectableLibraryFileGridHandler.
Definition at line 113 of file CategoryGridHandler.inc.php.
|
protected |
Implement this method to load category data into the grid.
$request | PKPRequest |
$categoryDataElement | mixed |
$filter | mixed |
Reimplemented in StageParticipantGridHandler, TocGridHandler, PluginGridHandler, SettingsPluginGridHandler, and CategoryCategoryGridHandler.
Definition at line 405 of file CategoryGridHandler.inc.php.
References GridHandler\getDataProvider().
Referenced by getGridCategoryDataElements().
|
protected |
Reimplemented from GridHandler.
Definition at line 331 of file CategoryGridHandler.inc.php.
References getCategoryRowIdParameterName(), PKPTemplateManager\getManager(), and GridHandler\getRequestArg().
CategoryGridHandler::setDataElementInCategorySequence | ( | $categoryId, | |
& | $gridDataElement, | ||
$newSequence | |||
) |
Override to set the data element new sequence inside the passed category, if needed.
$categoryId | int The data element category id. |
$gridDataElement | mixed The element to set the new sequence. |
$newSequence | int The new sequence value. |
Reimplemented in TocGridHandler, and CategoryCategoryGridHandler.
Definition at line 103 of file CategoryGridHandler.inc.php.
CategoryGridHandler::setEmptyCategoryRowText | ( | $translationKey | ) |
Set the empty rows text for a category.
string | $translationKey |
Definition at line 71 of file CategoryGridHandler.inc.php.
Referenced by StageParticipantGridHandler\initialize().
|
protected |
Reimplemented from GridHandler.
Definition at line 319 of file CategoryGridHandler.inc.php.
References GridHandler\getColumns().
Referenced by fetchCategory().
CategoryGridHandler::setGridCategoryDataElements | ( | $request, | |
$categoryElementId, | |||
$data | |||
) |
Set the grid category data.
$categoryElementId | string The category element id. |
$data | mixed an array or ItemIterator with category elements data. |
Definition at line 176 of file CategoryGridHandler.inc.php.
Referenced by getGridCategoryDataElements().
CategoryGridHandler::setUrls | ( | $request, | |
$extraUrls = array() |
|||
) |
Define the urls that will be used in JS handler.
$request | PKPRequest |
$extraUrls | array Optional extra urls. |
Reimplemented from GridHandler.
Definition at line 267 of file CategoryGridHandler.inc.php.
References getRequestArgs().
array CategoryGridHandler::$_categoryData |
The category grid's data source.
Definition at line 35 of file CategoryGridHandler.inc.php.
string CategoryGridHandler::$_currentCategoryId = null |
The category id that this grid is currently rendering.
Definition at line 41 of file CategoryGridHandler.inc.php.
Referenced by getCurrentCategoryId(), and getRequestArgs().
string CategoryGridHandler::$_emptyCategoryRowText = 'grid.noItems' |
empty category row locale key
Definition at line 29 of file CategoryGridHandler.inc.php.
Referenced by getEmptyCategoryRowText().