Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
FilesGridDataProvider Class Reference
Inheritance diagram for FilesGridDataProvider:
GridDataProvider

Public Member Functions

 FilesGridDataProvider ()
 
 getAddFileAction ($request)
 
 getSelectAction ($request)
 
getSubmission ()
 
 getUploaderGroupIds ()
 
 getUploaderRoles ()
 
prepareSubmissionFileData (&$revisions, $viewableOnly=false)
 
 setUploaderGroupIds ($uploaderGroupIds)
 
 setUploaderRoles ($roleAssignments)
 
 setViewableOnly ($viewableOnly)
 
- Public Member Functions inherited from GridDataProvider
 getAuthorizationPolicy ($request, $args, $roleAssignments)
 
getAuthorizedContextObject ($assocType)
 
 getRequestArgs ()
 
 GridDataProvider ()
 
 hasAuthorizedContextObject ($assocType)
 
 loadData ()
 
 setAuthorizedContext (&$authorizedContext)
 

Detailed Description

Basic files grid data provider.

The data provider for the admin library files grid.

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

Member Function Documentation

FilesGridDataProvider::FilesGridDataProvider ( )

Constructor

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

FilesGridDataProvider::getAddFileAction (   $request)

Configures and returns the action to add a file.

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

Parameters
$requestRequest
Returns
AddFileLinkAction

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

FilesGridDataProvider::getSelectAction (   $request)

Configures and returns the select files action.

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

Parameters
$requestRequest
Returns
SelectFilesLinkAction

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

& FilesGridDataProvider::getSubmission ( )

Get the authorized submission.

Returns
Submission

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

Referenced by ReviewGridDataProvider\getAddFileAction(), and FinalDraftFilesGridDataProvider\getSelectAction().

FilesGridDataProvider::getUploaderGroupIds ( )

Get the uploader group IDs.

Returns
array

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

FilesGridDataProvider::getUploaderRoles ( )

Get the uploader roles.

Returns
array

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

Referenced by ReviewRevisionsGridDataProvider\getAddFileAction(), and ReviewGridDataProvider\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
$revisionsarray
$viewableOnlyboolean optional
Returns
array

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

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

FilesGridDataProvider::setUploaderGroupIds (   $uploaderGroupIds)

Set the uploader group IDs.

Parameters
$groupIdsarray The group IDs to consider when presenting the file upload modal.

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

FilesGridDataProvider::setUploaderRoles (   $roleAssignments)

Set the uploader roles.

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

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

Referenced by ReviewerReviewAttachmentGridDataProvider\getAuthorizationPolicy().

FilesGridDataProvider::setViewableOnly (   $viewableOnly)

Load only viewable files flag.

Parameters
$viewableOnlyboolean

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

Referenced by FinalDraftFilesGridDataProvider\FinalDraftFilesGridDataProvider().


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