Public Member Functions

SelectableFileListGridHandler Class Reference
[Controllers_grid_files_fileList]

Base grid for selectable file lists. The grid shows a check box for each row so that the user can make a selection among grid entries. More...

Inheritance diagram for SelectableFileListGridHandler:
FileListGridHandler SubmissionFilesGridHandler EditorSelectableReviewAttachmentsGridHandler SelectableCopyeditingFilesGridHandler SelectableFairCopyFilesGridHandler SelectableProofFilesGridHandler SelectableReviewRevisionsGridHandler SelectableSubmissionDetailsFilesGridHandler

List of all members.

Public Member Functions

 getRequestArgs ()
 getSelectedFileIds ($submissionFiles)
 getSelectionArgs ()
 getSelectionPolicy (&$request, $args, $roleAssignments)
 getSelectName ()
& loadData ($request, $filter)
 SelectableFileListGridHandler ($dataProvider, $stageId, $capabilities=0)

Detailed Description

Base grid for selectable file lists. The grid shows a check box for each row so that the user can make a selection among grid entries.

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

Member Function Documentation

SelectableFileListGridHandler.getRequestArgs (  ) 
See also:
GridHandler.getRequestArgs()

Definition at line 39 of file SelectableFileListGridHandler.inc.php.

References SubmissionFilesGridHandler.getHandlerImplementation().

SelectableFileListGridHandler.getSelectedFileIds ( $  submissionFiles  ) 

Get the selected file IDs.

Parameters:
$submissionFiles array Set of submission files to filter
Returns:
array

Reimplemented in EditorSelectableReviewAttachmentsGridHandler, and SelectableProofFilesGridHandler.

Definition at line 90 of file SelectableFileListGridHandler.inc.php.

SelectableFileListGridHandler.getSelectionArgs (  ) 

Request parameters that describe the selected files.

Parameters:
$request Request
Returns:
array

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

SelectableFileListGridHandler.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 68 of file SelectableFileListGridHandler.inc.php.

SelectableFileListGridHandler.getSelectName (  ) 

Get the selection name.

Returns:
string

Reimplemented in EditorSelectableReviewAttachmentsGridHandler.

Definition at line 99 of file SelectableFileListGridHandler.inc.php.

& SelectableFileListGridHandler.loadData ( $  request,
$  filter 
)
See also:
GridHandler.loadData()

Definition at line 49 of file SelectableFileListGridHandler.inc.php.

References SubmissionFilesGridHandler.getHandlerImplementation().

SelectableFileListGridHandler.SelectableFileListGridHandler ( $  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 28 of file SelectableFileListGridHandler.inc.php.

References FileListGridHandler.FileListGridHandler().

Referenced by EditorSelectableReviewAttachmentsGridHandler.EditorSelectableReviewAttachmentsGridHandler(), SelectableCopyeditingFilesGridHandler.SelectableCopyeditingFilesGridHandler(), SelectableFairCopyFilesGridHandler.SelectableFairCopyFilesGridHandler(), SelectableProofFilesGridHandler.SelectableProofFilesGridHandler(), SelectableReviewRevisionsGridHandler.SelectableReviewRevisionsGridHandler(), and SelectableSubmissionDetailsFilesGridHandler.SelectableSubmissionDetailsFilesGridHandler().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:59 for Open Monograph Press by  doxygen 1.7.1