Open Journal Systems  3.3.0
ReviewGridDataProvider Class Reference
Inheritance diagram for ReviewGridDataProvider:
SubmissionFilesGridDataProvider FilesGridDataProvider GridDataProvider ReviewerReviewFilesGridDataProvider ReviewRevisionsGridDataProvider

Public Member Functions

 __construct ($fileStageId, $viewableOnly=false, $showAll=false)
 
 getAddFileAction ($request)
 
 getAuthorizationPolicy ($request, $args, $roleAssignments)
 
 getRequestArgs ()
 
 getReviewRound ()
 
 getSelectAction ($request)
 
 loadData ($filter=array())
 
- Public Member Functions inherited from SubmissionFilesGridDataProvider
 __construct ($fileStage, $viewableOnly=false)
 
 getFileStage ()
 
 getStageId ()
 
 prepareSubmissionFileData ($revisions, $viewableOnly=false, $filter=array())
 
 setStageId ($stageId)
 
- Public Member Functions inherited from FilesGridDataProvider
 getUploaderRoles ()
 
 setUploaderRoles ($roleAssignments)
 
 setViewableOnly ($viewableOnly)
 
- Public Member Functions inherited from GridDataProvider
 __construct ()
 
getAuthorizedContextObject ($assocType)
 
 hasAuthorizedContextObject ($assocType)
 
 setAuthorizedContext (&$authorizedContext)
 

Protected Attributes

 $_showAll
 

Additional Inherited Members

- Data Fields inherited from SubmissionFilesGridDataProvider
 $_fileStage
 
 $_stageId
 
- Data Fields inherited from FilesGridDataProvider
 $_uploaderRoles
 
 $_viewableOnly = false
 
- Data Fields inherited from GridDataProvider
 $_authorizedContext
 
- Protected Member Functions inherited from SubmissionFilesGridDataProvider
 applyFilter ($revisions, $filter)
 
- Protected Member Functions inherited from FilesGridDataProvider
 getSubmission ()
 

Detailed Description

Provide access to review file data for grids.

Definition at line 17 of file ReviewGridDataProvider.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ReviewGridDataProvider::__construct (   $fileStageId,
  $viewableOnly = false,
  $showAll = false 
)

Constructor Constructor

Parameters
$showAllboolean True iff all review round files should be included.

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

Member Function Documentation

◆ getAddFileAction()

ReviewGridDataProvider::getAddFileAction (   $request)

Configures and returns the action to add a file.

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

Parameters
$requestRequest
Returns
AddFileLinkAction

Reimplemented from SubmissionFilesGridDataProvider.

Reimplemented in ReviewRevisionsGridDataProvider.

Definition at line 94 of file ReviewGridDataProvider.inc.php.

References getReviewRound(), and FilesGridDataProvider\getSubmission().

◆ getAuthorizationPolicy()

ReviewGridDataProvider::getAuthorizationPolicy (   $request,
  $args,
  $roleAssignments 
)

Get the authorization policy.

Parameters
$requestPKPRequest
$argsarray
$roleAssignmentsarray
Returns
PolicySet

Reimplemented from SubmissionFilesGridDataProvider.

Reimplemented in ReviewerReviewFilesGridDataProvider.

Definition at line 41 of file ReviewGridDataProvider.inc.php.

◆ getRequestArgs()

ReviewGridDataProvider::getRequestArgs ( )

Get an array with all request parameters necessary to uniquely identify the data selection of this data provider.

Returns
array

Reimplemented from SubmissionFilesGridDataProvider.

Reimplemented in ReviewerReviewFilesGridDataProvider.

Definition at line 55 of file ReviewGridDataProvider.inc.php.

References getReviewRound().

◆ getReviewRound()

◆ getSelectAction()

ReviewGridDataProvider::getSelectAction (   $request)

Configures and returns the select files action.

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

Parameters
$requestRequest
Returns
SelectFilesLinkAction

Reimplemented from FilesGridDataProvider.

Definition at line 80 of file ReviewGridDataProvider.inc.php.

References getReviewRound().

◆ loadData()

ReviewGridDataProvider::loadData (   $filter = array())

Retrieve the data to load into the grid.

Parameters
$filterarray An optional associative array with filter data as returned by GridHandler::getFilterSelectionData(). If no filter has been selected by the user then the array will be empty.
Returns
array

Reimplemented from SubmissionFilesGridDataProvider.

Reimplemented in ReviewerReviewFilesGridDataProvider, and ReviewRevisionsGridDataProvider.

Definition at line 66 of file ReviewGridDataProvider.inc.php.

References DAORegistry\getDAO(), SubmissionFilesGridDataProvider\getFileStage(), getReviewRound(), and SubmissionFilesGridDataProvider\prepareSubmissionFileData().

Field Documentation

◆ $_showAll

boolean ReviewGridDataProvider::$_showAll
protected

Definition at line 22 of file ReviewGridDataProvider.inc.php.


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