Inheritance diagram for SubmissionFilesCategoryGridDataProvider:

Public Member Functions
	__construct ($fileStage, $dataProviderInitParams=null)

	_getFileStageByStageId ($stageId)

	getAddFileAction ($request)

	getAuthorizationPolicy ($request, $args, $roleAssignments)

	getFileStage ()

	getRequestArgs ()

	initGridDataProvider ($fileStage, $initParams=null)

	loadCategoryData ($request, $categoryDataElement, $filter=null, $reviewRound=null)

	loadData ($filter=array())

	setDataProvider ($gridDataProvider)

	setStageId ($stageId)

Public Member Functions inherited from CategoryGridDataProvider
	getDataProvider ()

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

	setAuthorizedContext (&$authorizedContext)

Public Member Functions inherited from GridDataProvider
	__construct ()

&	getAuthorizedContextObject ($assocType)

	hasAuthorizedContextObject ($assocType)

Data Fields
	$_submissionFiles

Data Fields inherited from CategoryGridDataProvider
	$_dataProvider

Data Fields inherited from GridDataProvider
	$_authorizedContext

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

SubmissionFilesCategoryGridDataProvider::__construct	(	$fileStage,
		$dataProviderInitParams = `null`
	)

Constructor

Parameters

$fileStage	int The current file stage that the grid is handling (others file stages could be shown activating the grid filter, but this is the file stage that will be used to bring files from other stages, upload new file, etc).
$dataProviderInitParams	array Other parameters to initiate the grid data provider that this category grid data provider will use to implement common behaviours and data.

Reimplemented in ReviewCategoryGridDataProvider.

Definition at line 38 of file SubmissionFilesCategoryGridDataProvider.inc.php.

References initGridDataProvider(), and setDataProvider().

Member Function Documentation

◆ _getFileStageByStageId()

SubmissionFilesCategoryGridDataProvider::_getFileStageByStageId ( $stageId )

Get the file stage using the passed stage id. This will define which file stage will be present on each workflow stage category of the grid.

Parameters

$stageId int

Returns: int|array

Definition at line 188 of file SubmissionFilesCategoryGridDataProvider.inc.php.

Referenced by loadCategoryData().

◆ getAddFileAction()

SubmissionFilesCategoryGridDataProvider::getAddFileAction ( $request )

Configures and returns the action to add a file.

NB: Must be overridden by subclasses (if implemented).

Parameters

$request Request

Returns: AddFileLinkAction

Definition at line 138 of file SubmissionFilesCategoryGridDataProvider.inc.php.

References CategoryGridDataProvider\getDataProvider().

◆ getAuthorizationPolicy()

SubmissionFilesCategoryGridDataProvider::getAuthorizationPolicy	(	$request,
		$args,
		$roleAssignments
	)

Get the authorization policy.

Parameters

$request	PKPRequest
$args	array
$roleAssignments	array

Returns: PolicySet

Reimplemented from GridDataProvider.

Definition at line 62 of file SubmissionFilesCategoryGridDataProvider.inc.php.

References CategoryGridDataProvider\getDataProvider().

◆ getFileStage()

SubmissionFilesCategoryGridDataProvider::getFileStage ( )

Get the file stage.

Returns: integer SUBMISSION_FILE_...

Definition at line 154 of file SubmissionFilesCategoryGridDataProvider.inc.php.

References CategoryGridDataProvider\getDataProvider().

◆ getRequestArgs()

SubmissionFilesCategoryGridDataProvider::getRequestArgs ( )

Get an array with all request parameters necessary to uniquely identify the data selection of this data provider.

Returns: array

Reimplemented from GridDataProvider.

Definition at line 71 of file SubmissionFilesCategoryGridDataProvider.inc.php.

References CategoryGridDataProvider\getDataProvider().

◆ initGridDataProvider()

SubmissionFilesCategoryGridDataProvider::initGridDataProvider	(	$fileStage,
		$initParams = `null`
	)

Init the grid data provider that this category grid data provider will use and return it. Override this to initiate another grid data provider.

Parameters

$fileStage	int
$initParams	array (optional) The parameters to initiate the grid data provider.

Returns: SubmissionFilesGridDataProvider

Reimplemented in ReviewCategoryGridDataProvider, and QueryNoteFilesCategoryGridDataProvider.

Definition at line 170 of file SubmissionFilesCategoryGridDataProvider.inc.php.

Referenced by __construct().

◆ loadCategoryData()

SubmissionFilesCategoryGridDataProvider::loadCategoryData	(	$request,
		$categoryDataElement,
		$filter = `null`,
		$reviewRound = `null`
	)

Retrieve the category data to load into the grid.

Parameters

$request	PKPRequest
$categoryDataElement	mixed
$filter	mixed array or null

Returns: array

Reimplemented in ReviewCategoryGridDataProvider.

Definition at line 91 of file SubmissionFilesCategoryGridDataProvider.inc.php.

References $_submissionFiles, _getFileStageByStageId(), GridDataProvider\getAuthorizedContextObject(), DAORegistry\getDAO(), and CategoryGridDataProvider\getDataProvider().

◆ loadData()

SubmissionFilesCategoryGridDataProvider::loadData ( $filter = array() )

Retrieve the data to load into the grid.

Parameters

$filter array An optional associative array with filter data as returned by GridHandler::getFilterSelectionData(). If no filter has been selected by the user then the array will be empty.