Inheritance diagram for SubmissionFilesGridDataProvider:

Public Member Functions
	__construct ($fileStage, $viewableOnly=false)

	getAddFileAction ($request)

	getAuthorizationPolicy ($request, $args, $roleAssignments)

	getFileStage ()

	getRequestArgs ()

	getStageId ()

	loadData ($filter=array())

	prepareSubmissionFileData ($revisions, $viewableOnly=false, $filter=array())

	setStageId ($stageId)

Public Member Functions inherited from FilesGridDataProvider
	getSelectAction ($request)

	getUploaderRoles ()

	setUploaderRoles ($roleAssignments)

	setViewableOnly ($viewableOnly)

Public Member Functions inherited from GridDataProvider
	__construct ()

&	getAuthorizedContextObject ($assocType)

	hasAuthorizedContextObject ($assocType)

	setAuthorizedContext (&$authorizedContext)

Data Fields
	$_fileStage

	$_stageId

Data Fields inherited from FilesGridDataProvider
	$_uploaderRoles

	$_viewableOnly = false

Data Fields inherited from GridDataProvider
	$_authorizedContext

Protected Member Functions
	applyFilter ($revisions, $filter)

Protected Member Functions inherited from FilesGridDataProvider
	getSubmission ()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

SubmissionFilesGridDataProvider::__construct	(	$fileStage,
		$viewableOnly = `false`
	)

Constructor

Parameters

$fileStage	integer One of the SUBMISSION_FILE_* constants.
$viewableOnly	boolean True iff only viewable files should be included.

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

References FilesGridDataProvider\setViewableOnly().

Member Function Documentation

◆ applyFilter()

SubmissionFilesGridDataProvider::applyFilter	(	$revisions,
		$filter
	)

protected

Apply the filter to the list of revisions, returning only matching elements.

Parameters

$revisions	array List of potential submission files to include.
$filter	array Associative array of filter data

Returns: array

Definition at line 139 of file SubmissionFilesGridDataProvider.inc.php.

References AppLocale\getLocale().

Referenced by prepareSubmissionFileData().

◆ getAddFileAction()

SubmissionFilesGridDataProvider::getAddFileAction ( $request )

Configures and returns the action to add a file.

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

Parameters

$request Request

Returns: AddFileLinkAction

Reimplemented from FilesGridDataProvider.

Reimplemented in QueryNoteFilesGridDataProvider, ReviewerReviewAttachmentGridDataProvider, ReviewGridDataProvider, DependentFilesGridDataProvider, and ReviewRevisionsGridDataProvider.

Definition at line 120 of file SubmissionFilesGridDataProvider.inc.php.

References FilesGridDataProvider\getSubmission().

◆ getAuthorizationPolicy()

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

Get the authorization policy.

Parameters

$request	PKPRequest
$args	array
$roleAssignments	array

Returns: PolicySet

Reimplemented from GridDataProvider.

Reimplemented in QueryNoteFilesGridDataProvider, ReviewGridDataProvider, ReviewerReviewAttachmentGridDataProvider, and ReviewerReviewFilesGridDataProvider.

Definition at line 107 of file SubmissionFilesGridDataProvider.inc.php.

References getStageId(), and FilesGridDataProvider\setUploaderRoles().

◆ getFileStage()

SubmissionFilesGridDataProvider::getFileStage ( )

Get the file stage.

Returns: integer SUBMISSION_FILE_...

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

References $_fileStage.

Referenced by ReviewRevisionsGridDataProvider\loadData(), ReviewGridDataProvider\loadData(), and ReviewerReviewAttachmentGridDataProvider\loadData().

◆ getRequestArgs()

SubmissionFilesGridDataProvider::getRequestArgs ( )

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

Returns: array

Reimplemented from GridDataProvider.

Reimplemented in QueryNoteFilesGridDataProvider, ReviewerReviewFilesGridDataProvider, ReviewerReviewAttachmentGridDataProvider, and ReviewGridDataProvider.

Definition at line 73 of file SubmissionFilesGridDataProvider.inc.php.

References FilesGridDataProvider\getSubmission().

◆ getStageId()

SubmissionFilesGridDataProvider::getStageId ( )

Get the workflow stage.

Returns: integer WORKFLOW_STAGE_ID_...

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

References $_stageId.

Referenced by QueryNoteFilesGridDataProvider\getAuthorizationPolicy(), getAuthorizationPolicy(), CopyeditFilesGridDataProvider\getSelectAction(), and FinalDraftFilesGridDataProvider\getSelectAction().

◆ loadData()

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

Returns: array

Reimplemented from GridDataProvider.

Reimplemented in ReviewerReviewAttachmentGridDataProvider, ReviewGridDataProvider, QueryNoteFilesGridDataProvider, ReviewerReviewFilesGridDataProvider, DependentFilesGridDataProvider, and ReviewRevisionsGridDataProvider.

Definition at line 93 of file SubmissionFilesGridDataProvider.inc.php.

References DAORegistry\getDAO(), FilesGridDataProvider\getSubmission(), and prepareSubmissionFileData().

◆ prepareSubmissionFileData()

SubmissionFilesGridDataProvider::prepareSubmissionFileData	(	$revisions,
		$viewableOnly = `false`,
		$filter = `array()`
	)

Rearrange file revisions by file id and return the file data wrapped into an array so that grid implementations can add further data.

Parameters

$revisions	array List of SubmissionFiles
$viewableOnly	boolean optional True iff only viewable files should be listed
$filter	array optional Associative array of filter conditions