Handle selectable submission file list category grid requests. This handler delegate some of its methods to another object, that contains the implementation required to handle with selectable file lists. More...

Inheritance diagram for SelectableSubmissionFileListCategoryGridHandler:

Public Member Functions
	authorize (&$request, &$args, $roleAssignments)
	canAdd ()
	canDelete ()
	canDownloadAll ()
	canManage ()
	canViewNotes ()
&	getCategoryData (&$categoryDataElement)
&	getCategoryRowInstance ()
	getFilesToDownload (&$request)
	getFilterForm ()
	getFilterSelectionData (&$request)
&	getHandlerImplementation ()
&	getMonograph ()
	getRequestArgs ()
&	getRowInstance ()
	getSelectedFileIds ($submissionFiles)
	getSelectionArgs ()
	getSelectionPolicy (&$request, $args, $roleAssignments)
	getSelectName ()
	getStageId ()
	initialize (&$request)
	loadData ($request, $filter)
	SelectableSubmissionFileListCategoryGridHandler (&$dataProvider, $stageId, $capabilities)
	setCanAdd ($canAdd)
	setCanDelete ($canDelete)

Detailed Description

Handle selectable submission file list category grid requests. This handler delegate some of its methods to another object, that contains the implementation required to handle with selectable file lists.

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

Member Function Documentation

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

See also:: PKPHandler.authorize()

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

SelectableSubmissionFileListCategoryGridHandler.canAdd ( )

Does this grid allow the addition of files or revisions?

Returns:: boolean

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

SelectableSubmissionFileListCategoryGridHandler.canDelete ( )

Can the user delete files from this grid?

Returns:: boolean

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

SelectableSubmissionFileListCategoryGridHandler.canDownloadAll ( )

Can the user download all files as an archive?

Returns:: boolean

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

SelectableSubmissionFileListCategoryGridHandler.canManage ( )

Whether the grid allows file management (select existing files to add to grid)

Returns:: boolean

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

References getHandlerImplementation().

SelectableSubmissionFileListCategoryGridHandler.canViewNotes ( )

Does this grid allow viewing of notes?

Returns:: boolean

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

& SelectableSubmissionFileListCategoryGridHandler.getCategoryData ( &$ categoryDataElement )

See also:: CategoryGridHandler.getCategoryData()

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

References getHandlerImplementation(), and getSelectedFileIds().

& SelectableSubmissionFileListCategoryGridHandler.getCategoryRowInstance ( )

See also:: CategoryGridHandler.getCategoryRowInstance()

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

SelectableSubmissionFileListCategoryGridHandler.getFilesToDownload ( &$ request )

Get all files of this grid to download.

Parameters:

$request

Request

Returns:: array

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

SelectableSubmissionFileListCategoryGridHandler.getFilterForm ( )

See also:: GridHandler.getFilterForm()

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

SelectableSubmissionFileListCategoryGridHandler.getFilterSelectionData ( &$ request )

See also:: GridHandler.getFilterSelectionData()

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

& SelectableSubmissionFileListCategoryGridHandler.getHandlerImplementation ( )

Get handler implementation.

Returns:: SubmissionFilesGridHandlerImplementation

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

Referenced by canManage(), getCategoryData(), and getRequestArgs().

& SelectableSubmissionFileListCategoryGridHandler.getMonograph ( )

Get the authorized monograph.

Returns:: Monograph

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

Referenced by ManageFinalDraftFilesGridHandler.updateFinalDraftFiles(), and ManageReviewFilesGridHandler.updateReviewFiles().

SelectableSubmissionFileListCategoryGridHandler.getRequestArgs ( )

See also:: GridHandler.getRequestArgs()

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

References getHandlerImplementation().

& SelectableSubmissionFileListCategoryGridHandler.getRowInstance ( )

See also:: GridHandler.getRowInstance()

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

SelectableSubmissionFileListCategoryGridHandler.getSelectedFileIds ( $ submissionFiles )

Return the selected file ids.

Parameters:

$submissionFiles

array

Returns:: array

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

Referenced by getCategoryData().

SelectableSubmissionFileListCategoryGridHandler.getSelectionArgs ( )

Request parameters that describe the selected files.

Parameters:

$request

Request

Returns:: array

Reimplemented in ManageReviewFilesGridHandler.

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

SelectableSubmissionFileListCategoryGridHandler.getSelectionPolicy	(	&$	request,
		$	args,
		$	roleAssignments
	)

Return an (optional) additional authorization policy to authorize the file selection.

Parameters:

	$request	Request
	$args	array
	$roleAssignments	array

Returns:: PolicySet

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

SelectableSubmissionFileListCategoryGridHandler.getSelectName ( )

Get the selection name.

Returns:: string

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

SelectableSubmissionFileListCategoryGridHandler.getStageId ( )

Get the workflow stage id.

Returns:: integer

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

Referenced by loadData().

SelectableSubmissionFileListCategoryGridHandler.initialize ( &$ request )

See also:: PKPHandler.initialize()

Reimplemented in ManageReviewFilesGridHandler.

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

SelectableSubmissionFileListCategoryGridHandler.loadData	(	$	request,
		$	filter
	)

See also:: GridHandler.loadData()

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

References getStageId().

SelectableSubmissionFileListCategoryGridHandler.SelectableSubmissionFileListCategoryGridHandler	(	&$	dataProvider,
		$	stageId,
		$	capabilities
	)

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

Referenced by ManageFinalDraftFilesGridHandler.ManageFinalDraftFilesGridHandler(), and ManageReviewFilesGridHandler.ManageReviewFilesGridHandler().

SelectableSubmissionFileListCategoryGridHandler.setCanAdd ( $ canAdd )

Set whether or not the grid allows the addition of files or revisions.

Parameters:

$canAdd

boolean

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

SelectableSubmissionFileListCategoryGridHandler.setCanDelete ( $ canDelete )

Set whether or not the user can delete files from this grid.

Parameters:

$canDelete