Inheritance diagram for ExportPublishedSubmissionsListGridHandler:

Public Member Functions
	__construct ()

	authorize ($request, &$args, $roleAssignments)

	getFilterSelectionData ($request)

	getGridCellProvider ()

	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
	getFilterColumns ()

	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 published submissions list grid requests.

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

Constructor & Destructor Documentation

◆ __construct()

ExportPublishedSubmissionsListGridHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 28 of file ExportPublishedSubmissionsListGridHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

ExportPublishedSubmissionsListGridHandler::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

$request	Request
$args	array request arguments
$roleAssignments	array the operation role assignment, see getRoleAssignment() for more details.

Returns: boolean

Reimplemented from GridHandler.

Definition at line 42 of file ExportPublishedSubmissionsListGridHandler.inc.php.

References PKPHandler\addPolicy().

◆ getFilterColumns()

ExportPublishedSubmissionsListGridHandler::getFilterColumns ( )

protected

Get which columns can be used by users to filter data.

Returns: array

Definition at line 248 of file ExportPublishedSubmissionsListGridHandler.inc.php.

Referenced by renderFilter().

◆ getFilterForm()

ExportPublishedSubmissionsListGridHandler::getFilterForm ( )

protected

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

Returns: Form|string

Reimplemented from GridHandler.

Definition at line 165 of file ExportPublishedSubmissionsListGridHandler.inc.php.

◆ getFilterSelectionData()

ExportPublishedSubmissionsListGridHandler::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

$request PKPRequest

Returns: array

Reimplemented from GridHandler.

Definition at line 198 of file ExportPublishedSubmissionsListGridHandler.inc.php.

◆ getFilterValues()

ExportPublishedSubmissionsListGridHandler::getFilterValues ( $filter )

protected

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

Returns: array

Definition at line 260 of file ExportPublishedSubmissionsListGridHandler.inc.php.

Referenced by PubIdExportSubmissionsListGridHandler\loadData(), and loadData().

◆ getGridCellProvider()

ExportPublishedSubmissionsListGridHandler::getGridCellProvider ( )

Get the grid cell provider instance

Returns: DataObjectGridCellProvider

Reimplemented in PubIdExportSubmissionsListGridHandler.

Definition at line 288 of file ExportPublishedSubmissionsListGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by initialize().

◆ getRequestArgs()

ExportPublishedSubmissionsListGridHandler::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 144 of file ExportPublishedSubmissionsListGridHandler.inc.php.

◆ getSelectName()

ExportPublishedSubmissionsListGridHandler::getSelectName ( )

Get the select parameter name to store the selected files.

Returns: string

Reimplemented from GridHandler.

Definition at line 158 of file ExportPublishedSubmissionsListGridHandler.inc.php.

◆ initFeatures()

ExportPublishedSubmissionsListGridHandler::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

$request	PKPRequest
$args	array

Returns: array Array with initialized grid features objects.

Reimplemented from GridHandler.

Definition at line 135 of file ExportPublishedSubmissionsListGridHandler.inc.php.

◆ initialize()

ExportPublishedSubmissionsListGridHandler::initialize	(	$request,
		$args = `null`
	)

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from GridHandler.

Definition at line 58 of file ExportPublishedSubmissionsListGridHandler.inc.php.

References GridHandler\addColumn(), getGridCellProvider(), PluginRegistry\loadPlugin(), AppLocale\requireComponents(), and GridHandler\setTitle().

◆ isDataElementSelected()

ExportPublishedSubmissionsListGridHandler::isDataElementSelected ( $gridDataElement )

Returns the current selection state of the grid data element.

Parameters

$gridDataElement mixed

Returns: boolean

Reimplemented from GridHandler.

Definition at line 151 of file ExportPublishedSubmissionsListGridHandler.inc.php.

◆ loadData()

ExportPublishedSubmissionsListGridHandler::loadData	(	$request,
		$filter
	)

protected

Implement this method to load data into the grid.

Parameters

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