Open Journal Systems  3.3.0
SettingsPluginGridHandler Class Reference
Inheritance diagram for SettingsPluginGridHandler:
PluginGridHandler CategoryGridHandler GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 loadCategoryData ($request, &$categoryDataElement, $filter=null)
 
- Public Member Functions inherited from PluginGridHandler
 __construct ($roles)
 
 _showUploadPluginForm ($function, $request)
 
 deletePlugin ($args, $request)
 
 disable ($args, $request)
 
 enable ($args, $request)
 
 getCategoryRowIdParameterName ()
 
 getFilterSelectionData ($request)
 
 initialize ($request, $args=null)
 
 manage ($args, $request)
 
 renderFilter ($request, $filterData=array())
 
 saveUploadPlugin ($args, $request)
 
 upgradePlugin ($args, $request)
 
 uploadPlugin ($args, $request)
 
 uploadPluginFile ($args, $request)
 
- Public Member Functions inherited from CategoryGridHandler
 fetchCategory ($args, $request)
 
 getCategoryItemsCount ($categoryElement, $request)
 
 getCurrentCategoryId ()
 
 getDataElementInCategorySequence ($categoryId, &$gridDataElement)
 
 getEmptyCategoryRowText ()
 
getGridCategoryDataElements ($request, $categoryElement)
 
 getJSHandler ()
 
 getRequestArgs ()
 
 hasGridDataElementsInCategory ($categoryElement, $request)
 
 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)
 
 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
 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)
 

Protected Member Functions

 getRowInstance ()
 
- Protected Member Functions inherited from PluginGridHandler
 getCategoryRowInstance ()
 
 getFilterForm ()
 
 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)
 
 initFeatures ($request, $args)
 
 isFilterFormCollapsible ()
 
 noAutocompleteResults ()
 
 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())
 
- 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 Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle plugin grid requests.

Definition at line 18 of file SettingsPluginGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SettingsPluginGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 22 of file SettingsPluginGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

SettingsPluginGridHandler::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.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented from GridHandler.

Definition at line 72 of file SettingsPluginGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ getRowInstance()

SettingsPluginGridHandler::getRowInstance ( )
protected

Get a new instance of a category grid row. May be overridden by subclasses if they want to provide a custom row definition.

Returns
CategoryGridRow

Reimplemented from GridHandler.

Definition at line 64 of file SettingsPluginGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ loadCategoryData()

SettingsPluginGridHandler::loadCategoryData (   $request,
$categoryDataElement,
  $filter = null 
)

Implement this method to load category data into the grid.

Parameters
$requestPKPRequest
$categoryDataElementmixed
$filtermixed
Returns
array

Reimplemented from PluginGridHandler.

Definition at line 35 of file SettingsPluginGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().


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