Public Member Functions

SubmissionFilesGridHandlerImplementation Class Reference

This class implements some of the common behaviours and data that a grid handler can use to handle with submission files. More...

Inheritance diagram for SubmissionFilesGridHandlerImplementation:
FileListGridHandlerImplementation SelectableFileListGridHandlerImplementation

List of all members.

Public Member Functions

 authorize (&$request, &$args, $roleAssignments)
 canAdd ()
 canDelete ()
 canDownloadAll ()
 canViewNotes ()
getGridHandler ()
getMonograph ()
getRowInstance ()
 getStageId ()
 initialize (&$request)
 setCanAdd ($canAdd)
 setCanDelete ($canDelete)
 SubmissionFilesGridHandlerImplementation (&$gridHandler, $stageId, $capabilities)

Detailed Description

This class implements some of the common behaviours and data that a grid handler can use to handle with submission files.

Definition at line 29 of file SubmissionFilesGridHandlerImplementation.inc.php.


Member Function Documentation

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

Implementation of the GridHandler.authorize() method.

Reimplemented in SelectableFileListGridHandlerImplementation.

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

References getGridHandler(), and getStageId().

SubmissionFilesGridHandlerImplementation.canAdd (  ) 

Does this grid allow the addition of files or revisions?

Returns:
boolean

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

Referenced by initialize().

SubmissionFilesGridHandlerImplementation.canDelete (  ) 

Can the user delete files from this grid?

Returns:
boolean

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

Referenced by getRowInstance().

SubmissionFilesGridHandlerImplementation.canDownloadAll (  ) 

Can the user download all files as an archive?

Returns:
boolean

Definition at line 131 of file SubmissionFilesGridHandlerImplementation.inc.php.

Referenced by initialize().

SubmissionFilesGridHandlerImplementation.canViewNotes (  ) 

Does this grid allow viewing of notes?

Returns:
boolean

Definition at line 123 of file SubmissionFilesGridHandlerImplementation.inc.php.

Referenced by getRowInstance(), and initialize().

& SubmissionFilesGridHandlerImplementation.getMonograph (  ) 

Get the authorized monograph.

Returns:
Monograph

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

References getGridHandler().

Referenced by initialize().

& SubmissionFilesGridHandlerImplementation.getRowInstance (  ) 

Implementation of the GridHandler.getRowInstance() method.

Definition at line 218 of file SubmissionFilesGridHandlerImplementation.inc.php.

References canDelete(), canViewNotes(), and getStageId().

SubmissionFilesGridHandlerImplementation.getStageId (  ) 

Get the workflow stage id.

Returns:
integer

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

Referenced by authorize(), getRowInstance(), and initialize().

SubmissionFilesGridHandlerImplementation.initialize ( &$  request  ) 

Implementation of the GridHandler.initialize() method.

Reimplemented in FileListGridHandlerImplementation, and SelectableFileListGridHandlerImplementation.

Definition at line 174 of file SubmissionFilesGridHandlerImplementation.inc.php.

References canAdd(), canDownloadAll(), canViewNotes(), getGridHandler(), getMonograph(), and getStageId().

SubmissionFilesGridHandlerImplementation.setCanAdd ( canAdd  ) 

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

Parameters:
$canAdd boolean

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

Referenced by SubmissionFilesGridHandlerImplementation().

SubmissionFilesGridHandlerImplementation.setCanDelete ( canDelete  ) 

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

Parameters:
$canDelete boolean

Definition at line 147 of file SubmissionFilesGridHandlerImplementation.inc.php.

Referenced by SubmissionFilesGridHandlerImplementation().

SubmissionFilesGridHandlerImplementation.SubmissionFilesGridHandlerImplementation ( &$  gridHandler,
stageId,
capabilities 
)

Constructor

Parameters:
$gridHandler Handler The grid handler that will delegate some of its operations to this class.
$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 58 of file SubmissionFilesGridHandlerImplementation.inc.php.

References setCanAdd(), and setCanDelete().

Referenced by FileListGridHandlerImplementation.FileListGridHandlerImplementation().


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