Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct () | |
authorize ($request, &$args, $roleAssignments) | |
getCategoryRowIdParameterName () | |
getDataElementInCategorySequence ($categoryId, &$submission) | |
getDataElementSequence ($object) | |
getRequestArgs () | |
initFeatures ($request, $args) | |
initialize ($request, $args=null) | |
loadCategoryData ($request, &$section, $filter=null) | |
removeArticle ($args, $request) | |
setAccessStatus ($args, $request) | |
setDataElementInCategorySequence ($sectionId, &$submission, $newSequence) | |
setDataElementSequence ($request, $sectionId, $gridDataElement, $newSequence) | |
Public Member Functions inherited from CategoryGridHandler | |
__construct ($dataProvider=null) | |
fetchCategory ($args, $request) | |
getCategoryItemsCount ($categoryElement, $request) | |
getCurrentCategoryId () | |
getEmptyCategoryRowText () | |
& | getGridCategoryDataElements ($request, $categoryElement) |
getJSHandler () | |
hasGridDataElementsInCategory ($categoryElement, $request) | |
isDataElementInCategorySelected ($categoryId, &$gridDataElement) | |
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) | |
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) | |
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) | |
setEmptyRowText ($emptyRowText) | |
setFootNote ($footNote) | |
setGridDataElements ($data) | |
setTemplate ($template) | |
setTitle ($title) | |
Public Member Functions inherited from PKPHandler | |
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 | |
$submissionsBySectionId = [] | |
Data Fields inherited from CategoryGridHandler | |
$_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 | |
getCategoryRowInstance () | |
getRowInstance () | |
loadData ($request, $filter) | |
Protected Member Functions inherited from CategoryGridHandler | |
doSpecificFetchGridActions ($args, $request, $templateMgr) | |
getRequestedCategoryRow ($request, $args) | |
getRowDataElement ($request, &$rowId) | |
getRowsSequence ($request) | |
renderRowInternally ($request, $row) | |
setFirstDataColumn () | |
Protected Member Functions inherited from GridHandler | |
callFeaturesHook ($hookName, $args) | |
& | getDataElementFromRequest ($request, &$elementId) |
getFilterForm () | |
getFilterSelectionData ($request) | |
isFilterFormCollapsible () | |
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 | |
Handle TOC (table of contents) grid requests.
Definition at line 20 of file TocGridHandler.inc.php.
TocGridHandler::__construct | ( | ) |
Constructor
Reimplemented from PKPHandler.
Definition at line 26 of file TocGridHandler.inc.php.
References PKPHandler\addRoleAssignment().
TocGridHandler::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 GridHandler.
Definition at line 42 of file TocGridHandler.inc.php.
References PKPHandler\addPolicy().
TocGridHandler::getCategoryRowIdParameterName | ( | ) |
Get the category row id parameter name.
Reimplemented from CategoryGridHandler.
Definition at line 103 of file TocGridHandler.inc.php.
|
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 from CategoryGridHandler.
Definition at line 130 of file TocGridHandler.inc.php.
TocGridHandler::getDataElementInCategorySequence | ( | $categoryId, | |
& | $submission | ||
) |
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 from CategoryGridHandler.
Definition at line 196 of file TocGridHandler.inc.php.
TocGridHandler::getDataElementSequence | ( | $object | ) |
Override to return the data element sequence value.
$gridDataElement | mixed |
Section | Submission | $object |
Reimplemented from GridHandler.
Definition at line 166 of file TocGridHandler.inc.php.
References PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().
TocGridHandler::getRequestArgs | ( | ) |
Get an array with all request parameters necessary to uniquely identify the data selection of this data provider.
Reimplemented from CategoryGridHandler.
Definition at line 110 of file TocGridHandler.inc.php.
References PKPHandler\getAuthorizedContextObject().
|
protected |
Get the row handler - override the default row handler
Reimplemented from GridHandler.
Definition at line 122 of file TocGridHandler.inc.php.
References PKPHandler\getAuthorizedContextObject().
TocGridHandler::initFeatures | ( | $request, | |
$args | |||
) |
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 from GridHandler.
Definition at line 96 of file TocGridHandler.inc.php.
TocGridHandler::initialize | ( | $request, | |
$args = null |
|||
) |
$request | PKPRequest |
$args | array optional |
Reimplemented from CategoryGridHandler.
Definition at line 55 of file TocGridHandler.inc.php.
References GridHandler\addColumn(), PKPHandler\getAuthorizedContextObject(), and AppLocale\requireComponents().
TocGridHandler::loadCategoryData | ( | $request, | |
& | $section, | ||
$filter = null |
|||
) |
Implement this method to load category data into the grid.
$request | PKPRequest |
$categoryDataElement | mixed |
$filter | mixed |
Reimplemented from CategoryGridHandler.
Definition at line 137 of file TocGridHandler.inc.php.
|
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 from GridHandler.
Definition at line 144 of file TocGridHandler.inc.php.
References PKPServices\get(), PKPApplication\get(), and PKPHandler\getAuthorizedContextObject().
TocGridHandler::removeArticle | ( | $args, | |
$request | |||
) |
Remove an article from the issue.
$args | array |
$request | PKPRequest |
Definition at line 221 of file TocGridHandler.inc.php.
References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), and DAO\getDataChangedEvent().
TocGridHandler::setAccessStatus | ( | $args, | |
$request | |||
) |
Set access status on an article.
$args | array |
$request | PKPRequest |
Definition at line 262 of file TocGridHandler.inc.php.
References PKPServices\get(), PKPHandler\getAuthorizedContextObject(), and DAO\getDataChangedEvent().
TocGridHandler::setDataElementInCategorySequence | ( | $sectionId, | |
& | $submission, | ||
$newSequence | |||
) |
Override to set the data element new sequence.
$request | PKPRequest |
$rowId | int |
$gridDataElement | mixed |
$newSequence | int |
Reimplemented from CategoryGridHandler.
Definition at line 203 of file TocGridHandler.inc.php.
References PKPServices\get(), and PKPApplication\get().
TocGridHandler::setDataElementSequence | ( | $request, | |
$sectionId, | |||
$gridDataElement, | |||
$newSequence | |||
) |
Override to set the data element new sequence.
$request | PKPRequest |
$rowId | int |
$gridDataElement | mixed |
$newSequence | int |
Reimplemented from GridHandler.
Definition at line 184 of file TocGridHandler.inc.php.
References PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().
TocGridHandler::$submissionsBySectionId = [] |
Definition at line 21 of file TocGridHandler.inc.php.