Open Journal Systems  3.3.0
Public Member Functions | Data Fields | Protected Member Functions
FilesGridDataProvider Class Reference
Inheritance diagram for FilesGridDataProvider:
GridDataProvider SubmissionFilesGridDataProvider CopyeditFilesGridDataProvider DependentFilesGridDataProvider FinalDraftFilesGridDataProvider QueryNoteFilesGridDataProvider ReviewerReviewAttachmentGridDataProvider ReviewGridDataProvider ReviewerReviewFilesGridDataProvider ReviewRevisionsGridDataProvider

Public Member Functions

 getAddFileAction ($request)
 
 getSelectAction ($request)
 
 getUploaderRoles ()
 
 setUploaderRoles ($roleAssignments)
 
 setViewableOnly ($viewableOnly)
 
- Public Member Functions inherited from GridDataProvider
 __construct ()
 
 getAuthorizationPolicy ($request, $args, $roleAssignments)
 
& getAuthorizedContextObject ($assocType)
 
 getRequestArgs ()
 
 hasAuthorizedContextObject ($assocType)
 
 loadData ($filter=array())
 
 setAuthorizedContext (&$authorizedContext)
 

Data Fields

 $_uploaderRoles
 
 $_viewableOnly = false
 
- Data Fields inherited from GridDataProvider
 $_authorizedContext
 

Protected Member Functions

 getSubmission ()
 

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

◆ getAddFileAction()

FilesGridDataProvider::getAddFileAction (   $request)

Configures and returns the action to add a file.

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

Parameters
$requestRequest
Returns
AddFileLinkAction

Reimplemented in SubmissionFilesGridDataProvider, QueryNoteFilesGridDataProvider, ReviewerReviewAttachmentGridDataProvider, ReviewGridDataProvider, DependentFilesGridDataProvider, and ReviewRevisionsGridDataProvider.

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

◆ getSelectAction()

FilesGridDataProvider::getSelectAction (   $request)

Configures and returns the select files action.

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

Parameters
$requestRequest
Returns
SelectFilesLinkAction

Reimplemented in ReviewGridDataProvider, QueryNoteFilesGridDataProvider, CopyeditFilesGridDataProvider, and FinalDraftFilesGridDataProvider.

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

◆ getSubmission()

FilesGridDataProvider::getSubmission ( )
protected

Get the authorized submission.

Returns
Submission

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

References GridDataProvider\getAuthorizedContextObject().

Referenced by DependentFilesGridDataProvider\getAddFileAction(), ReviewGridDataProvider\getAddFileAction(), ReviewerReviewAttachmentGridDataProvider\getAddFileAction(), QueryNoteFilesGridDataProvider\getAddFileAction(), SubmissionFilesGridDataProvider\getAddFileAction(), SubmissionFilesGridDataProvider\getRequestArgs(), CopyeditFilesGridDataProvider\getSelectAction(), FinalDraftFilesGridDataProvider\getSelectAction(), DependentFilesGridDataProvider\loadData(), QueryNoteFilesGridDataProvider\loadData(), ReviewerReviewAttachmentGridDataProvider\loadData(), and SubmissionFilesGridDataProvider\loadData().

◆ getUploaderRoles()

FilesGridDataProvider::getUploaderRoles ( )

Get the uploader roles.

Returns
array

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

References $_uploaderRoles.

Referenced by ReviewRevisionsGridDataProvider\getAddFileAction().

◆ setUploaderRoles()

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 43 of file FilesGridDataProvider.inc.php.

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

◆ setViewableOnly()

FilesGridDataProvider::setViewableOnly (   $viewableOnly)

Load only viewable files flag.

Parameters
$viewableOnlyboolean

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

Referenced by SubmissionFilesGridDataProvider\__construct().

Field Documentation

◆ $_uploaderRoles

FilesGridDataProvider::$_uploaderRoles

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

Referenced by getUploaderRoles().

◆ $_viewableOnly

boolean FilesGridDataProvider::$_viewableOnly = false

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

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