Open Journal Systems  3.3.0
PubIdExportIssuesListGridHandler Class Reference
Inheritance diagram for PubIdExportIssuesListGridHandler:
GridHandler PKPHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 getFilterSelectionData ($request)
 
 getRequestArgs ()
 
 getSelectName ()
 
 initFeatures ($request, $args)
 
 initialize ($request, $args=null)
 
 isDataElementSelected ($gridDataElement)
 
 renderFilter ($request, $filterData=array())
 
- Public Member Functions inherited from GridHandler
 __construct ($dataProvider=null)
 
 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 ()
 
 getJSHandler ()
 
 getPublishChangeEvents ()
 
 getRequestArg ($key)
 
 getRequestedRow ($request, $args)
 
 getTemplate ()
 
 getTitle ()
 
 getUrls ()
 
 hasColumn ($columnId)
 
 hasGridDataElements ($request)
 
 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
 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

 $_plugin
 
- 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

 getFilterForm ()
 
 getFilterValues ($filter)
 
 loadData ($request, $filter)
 
- Protected Member Functions inherited from GridHandler
 callFeaturesHook ($hookName, $args)
 
 doSpecificFetchGridActions ($args, $request, $templateMgr)
 
getDataElementFromRequest ($request, &$elementId)
 
 getRowDataElement ($request, &$rowId)
 
 getRowInstance ()
 
 getRowsSequence ($request)
 
 isFilterFormCollapsible ()
 
 noAutocompleteResults ()
 
 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
 

Detailed Description

Handle exportable issues with pub ids list grid requests.

Definition at line 19 of file PubIdExportIssuesListGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PubIdExportIssuesListGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 29 of file PubIdExportIssuesListGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

PubIdExportIssuesListGridHandler::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 43 of file PubIdExportIssuesListGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ getFilterForm()

PubIdExportIssuesListGridHandler::getFilterForm ( )
protected

Returns a Form object or the path name of a filter template.

Returns
Form|string

Reimplemented from GridHandler.

Definition at line 164 of file PubIdExportIssuesListGridHandler.inc.php.

◆ getFilterSelectionData()

PubIdExportIssuesListGridHandler::getFilterSelectionData (   $request)

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).

Parameters
$requestPKPRequest
Returns
array

Reimplemented from GridHandler.

Definition at line 185 of file PubIdExportIssuesListGridHandler.inc.php.

◆ getFilterValues()

PubIdExportIssuesListGridHandler::getFilterValues (   $filter)
protected

Process filter values, assigning default ones if none was set.

Returns
array

Definition at line 217 of file PubIdExportIssuesListGridHandler.inc.php.

Referenced by loadData().

◆ getRequestArgs()

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

Returns
array

Reimplemented from GridHandler.

Definition at line 143 of file PubIdExportIssuesListGridHandler.inc.php.

◆ getSelectName()

PubIdExportIssuesListGridHandler::getSelectName ( )

Get the select parameter name to store the selected files.

Returns
string

Reimplemented from GridHandler.

Definition at line 157 of file PubIdExportIssuesListGridHandler.inc.php.

◆ initFeatures()

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

Parameters
$requestPKPRequest
$argsarray
Returns
array Array with initialized grid features objects.

Reimplemented from GridHandler.

Definition at line 134 of file PubIdExportIssuesListGridHandler.inc.php.

◆ initialize()

PubIdExportIssuesListGridHandler::initialize (   $request,
  $args = null 
)

◆ isDataElementSelected()

PubIdExportIssuesListGridHandler::isDataElementSelected (   $gridDataElement)

Returns the current selection state of the grid data element.

Parameters
$gridDataElementmixed
Returns
boolean

Reimplemented from GridHandler.

Definition at line 150 of file PubIdExportIssuesListGridHandler.inc.php.

◆ loadData()

PubIdExportIssuesListGridHandler::loadData (   $request,
  $filter 
)
protected

Implement this method to load data into the grid.

Parameters
$requestPKPRequest
$filterarray 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.
Returns
grid data

Reimplemented from GridHandler.

Definition at line 195 of file PubIdExportIssuesListGridHandler.inc.php.

References DAORegistry\getDAO(), and getFilterValues().

◆ renderFilter()

PubIdExportIssuesListGridHandler::renderFilter (   $request,
  $filterData = array() 
)

Render the filter (a template).

Parameters
$requestPKPRequest
$filterDataArray Data to be used by the filter template.
Returns
string

Reimplemented from GridHandler.

Definition at line 171 of file PubIdExportIssuesListGridHandler.inc.php.

References PKPHandler\getId().

Field Documentation

◆ $_plugin

ImportExportPlugin PubIdExportIssuesListGridHandler::$_plugin

Definition at line 24 of file PubIdExportIssuesListGridHandler.inc.php.


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