Inheritance diagram for SelectableSubmissionFileListCategoryGridHandler:

Public Member Functions
	__construct ($dataProvider, $stageId, $capabilities=0)

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

	getCapabilities ()

	getFilesToDownload ($request)

	getFilterSelectionData ($request)

	getSelectName ()

	getStageId ()

	getSubmission ()

	initFeatures ($request, $args)

	initialize ($request, $args=null)

	isDataElementInCategorySelected ($categoryDataId, &$gridDataElement)

Public Member Functions inherited from CategoryGridHandler
	__construct ($dataProvider=null)

	fetchCategory ($args, $request)

	getCategoryItemsCount ($categoryElement, $request)

	getCurrentCategoryId ()

	getDataElementInCategorySequence ($categoryId, &$gridDataElement)

	getEmptyCategoryRowText ()

&	getGridCategoryDataElements ($request, $categoryElement)

	getJSHandler ()

	getRequestArgs ()

	hasGridDataElementsInCategory ($categoryElement, $request)

	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)

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

	$_stageId

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

	getFilterForm ()

	getRowInstance ()

	isFilterFormCollapsible ()

	loadData ($request, $filter)

Protected Member Functions inherited from CategoryGridHandler
	doSpecificFetchGridActions ($args, $request, $templateMgr)

	getCategoryRowIdParameterName ()

	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)

	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

Detailed Description

Handle selectable submission file list category grid requests.

Definition at line 30 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SelectableSubmissionFileListCategoryGridHandler::__construct	(	$dataProvider,
		$stageId,
		$capabilities = `0`
	)

Constructor

Parameters

$dataProvider	GridDataProvider
$stageId	integer One of the WORKFLOW_STAGE_ID_* constants.
$capabilities	integer A bit map with zero or more FILE_GRID_* capabilities set.

Definition at line 51 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

Member Function Documentation

◆ authorize()

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

Reimplemented in ManageProofFilesGridHandler.

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

References GridHandler\getDataProvider(), and getStageId().

◆ getCapabilities()

SelectableSubmissionFileListCategoryGridHandler::getCapabilities ( )

Get grid capabilities object.

Returns: FilesGridCapabilities

Definition at line 70 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References $_capabilities.

Referenced by getRowInstance(), and initialize().

◆ getCategoryRowInstance()

SelectableSubmissionFileListCategoryGridHandler::getCategoryRowInstance ( )

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

Definition at line 140 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

◆ getFilesToDownload()

SelectableSubmissionFileListCategoryGridHandler::getFilesToDownload ( $request )

Get all files of this grid to download.

Parameters

$request Request

Returns: array

Definition at line 244 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References GridHandler\getDataProvider(), CategoryGridHandler\getGridCategoryDataElements(), and GridHandler\getGridDataElements().

Referenced by initialize().

◆ getFilterForm()

SelectableSubmissionFileListCategoryGridHandler::getFilterForm ( )

protected

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

Returns: Form|string

Reimplemented from GridHandler.

Definition at line 115 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

◆ getFilterSelectionData()

SelectableSubmissionFileListCategoryGridHandler::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 129 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

◆ getRowInstance()

SelectableSubmissionFileListCategoryGridHandler::getRowInstance ( )

protected

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

Returns: GridRow

Reimplemented from GridHandler.

Definition at line 231 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References getCapabilities(), and getStageId().

◆ getSelectName()

SelectableSubmissionFileListCategoryGridHandler::getSelectName ( )

Get the selection name.

Returns: string

Reimplemented from GridHandler.

Definition at line 284 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

◆ getStageId()

SelectableSubmissionFileListCategoryGridHandler::getStageId ( )

Get the workflow stage id.

Returns: integer

Definition at line 78 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References $_stageId.

Referenced by authorize(), getRowInstance(), initialize(), loadData(), ManageCopyeditFilesGridHandler\updateCopyeditFiles(), ManageFinalDraftFilesGridHandler\updateFinalDraftFiles(), ManageProofFilesGridHandler\updateProofFiles(), ManageQueryNoteFilesGridHandler\updateQueryNoteFiles(), and ManageReviewFilesGridHandler\updateReviewFiles().

◆ getSubmission()

SelectableSubmissionFileListCategoryGridHandler::getSubmission ( )

Get the authorized submission.

Returns: Submission

Definition at line 86 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by initialize(), ManageCopyeditFilesGridHandler\updateCopyeditFiles(), ManageFinalDraftFilesGridHandler\updateFinalDraftFiles(), ManageProofFilesGridHandler\updateProofFiles(), ManageQueryNoteFilesGridHandler\updateQueryNoteFiles(), and ManageReviewFilesGridHandler\updateReviewFiles().

◆ initFeatures()

SelectableSubmissionFileListCategoryGridHandler::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 219 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

◆ initialize()

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

See also: PKPHandler::initialize()

Parameters

$request	PKPRequest
$args	array optional

Reimplemented from CategoryGridHandler.

Definition at line 169 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References GridHandler\addAction(), GridHandler\addColumn(), getCapabilities(), GridHandler\getDataProvider(), getFilesToDownload(), getStageId(), getSubmission(), AppLocale\requireComponents(), and GridHandler\setEmptyRowText().

◆ isDataElementInCategorySelected()

SelectableSubmissionFileListCategoryGridHandler::isDataElementInCategorySelected	(		$categoryDataId,
		&	$gridDataElement
	)

Reimplemented from CategoryGridHandler.

Reimplemented in ManageQueryNoteFilesGridHandler.

Definition at line 262 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), and GridHandler\getDataProvider().

◆ isFilterFormCollapsible()

SelectableSubmissionFileListCategoryGridHandler::isFilterFormCollapsible ( )

protected

Determine whether a filter form should be collapsible.

Returns: boolean

Reimplemented from GridHandler.

Definition at line 122 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

◆ loadData()

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

Returns: grid data

Reimplemented from GridHandler.

Definition at line 100 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

References getStageId().

Field Documentation

◆ $_capabilities

FilesGridCapabilities SelectableSubmissionFileListCategoryGridHandler::$_capabilities

Definition at line 36 of file SelectableSubmissionFileListCategoryGridHandler.inc.php.

Referenced by getCapabilities().

◆ $_stageId

integer SelectableSubmissionFileListCategoryGridHandler::$_stageId

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

Referenced by getStageId().

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

SelectableSubmissionFileListCategoryGridHandler.inc.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ authorize()

◆ getCapabilities()

◆ getCategoryRowInstance()

◆ getFilesToDownload()

◆ getFilterForm()

◆ getFilterSelectionData()

◆ getRowInstance()

◆ getSelectName()

◆ getStageId()

◆ getSubmission()

◆ initFeatures()

◆ initialize()

◆ isDataElementInCategorySelected()

◆ isFilterFormCollapsible()

◆ loadData()

Field Documentation

◆ $_capabilities

◆ $_stageId