Public Member Functions

FilesGridDataProvider Class Reference

Basic files grid data provider. More...

Inheritance diagram for FilesGridDataProvider:
SubmissionFilesGridDataProvider AuthorSignoffFilesGridDataProvider FinalDraftFilesGridDataProvider ProofFilesGridDataProvider ReviewerReviewAttachmentGridDataProvider ReviewGridDataProvider ReviewerReviewFilesGridDataProvider ReviewRevisionsGridDataProvider

List of all members.

Public Member Functions

 FilesGridDataProvider ()
& getAddFileAction ($request)
& getMonograph ()
& getSelectAction ($request)
 getUploaderRoles ()
& prepareSubmissionFileData (&$revisions, $viewableOnly=false)
 setUploaderRoles ($roleAssignments)
 setViewableOnly ($viewableOnly)

Detailed Description

Basic files grid data provider.

The data provider for the admin library files grid.

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

Member Function Documentation

FilesGridDataProvider.FilesGridDataProvider (  ) 

Constructor

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

Referenced by SubmissionFilesGridDataProvider.SubmissionFilesGridDataProvider().

& FilesGridDataProvider.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 in ReviewerReviewAttachmentGridDataProvider, ReviewGridDataProvider, ReviewRevisionsGridDataProvider, and SubmissionFilesGridDataProvider.

Definition at line 77 of file FilesGridDataProvider.inc.php.

& FilesGridDataProvider.getMonograph (  ) 

Get the authorized monograph.

Returns:
Monograph

Definition at line 102 of file FilesGridDataProvider.inc.php.

Referenced by SubmissionFilesGridDataProvider.getAddFileAction(), ReviewGridDataProvider.getAddFileAction(), ReviewerReviewAttachmentGridDataProvider.getAddFileAction(), SubmissionFilesGridDataProvider.getRequestArgs(), ReviewGridDataProvider.getSelectAction(), FinalDraftFilesGridDataProvider.getSelectAction(), SubmissionFilesGridDataProvider.loadData(), and ProofFilesGridDataProvider.loadData().

& FilesGridDataProvider.getSelectAction ( $  request  ) 

Configures and returns the select files action.

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

Parameters:
$request Request
Returns:
SelectFilesLinkAction

Reimplemented in FinalDraftFilesGridDataProvider, and ReviewGridDataProvider.

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

FilesGridDataProvider.getUploaderRoles (  ) 

Get the uploader roles.

Returns:
array

Definition at line 51 of file FilesGridDataProvider.inc.php.

Referenced by SubmissionFilesGridDataProvider.getAddFileAction(), ReviewRevisionsGridDataProvider.getAddFileAction(), ReviewGridDataProvider.getAddFileAction(), and ReviewerReviewAttachmentGridDataProvider.getAddFileAction().

& FilesGridDataProvider.prepareSubmissionFileData ( &$  revisions,
$  viewableOnly = false 
)

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
$viewableOnly boolean optional
Returns:
array

Definition at line 114 of file FilesGridDataProvider.inc.php.

Referenced by SubmissionFilesGridDataProvider.loadData(), ReviewRevisionsGridDataProvider.loadData(), ReviewGridDataProvider.loadData(), ProofFilesGridDataProvider.loadData(), and ReviewerReviewAttachmentGridDataProvider.loadData().

FilesGridDataProvider.setUploaderRoles ( $  roleAssignments  ) 

Set the uploder roles.

Parameters:
$roleAssignments array The grid's role assignment from which the uploader roles will be extracted.

Definition at line 43 of file FilesGridDataProvider.inc.php.

Referenced by SubmissionFilesGridDataProvider.getAuthorizationPolicy(), and ReviewerReviewAttachmentGridDataProvider.getAuthorizationPolicy().

FilesGridDataProvider.setViewableOnly ( $  viewableOnly  ) 

Load only viewable files flag.

Parameters:
$viewableOnly boolean

Definition at line 60 of file FilesGridDataProvider.inc.php.

Referenced by FinalDraftFilesGridDataProvider.FinalDraftFilesGridDataProvider(), and SubmissionFilesGridDataProvider.SubmissionFilesGridDataProvider().

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