Open Journal Systems  3.3.0
ReviewCategoryGridDataProvider Class Reference
Inheritance diagram for ReviewCategoryGridDataProvider:
SubmissionFilesCategoryGridDataProvider CategoryGridDataProvider GridDataProvider

Public Member Functions

 __construct ($fileStage, $viewableOnly=false)
 
 getReviewRound ()
 
 getSelectAction ($request)
 
 initGridDataProvider ($fileStage, $initParams=null)
 
 loadCategoryData ($request, $categoryDataElement, $filter=null, $reviewRound=null)
 
- Public Member Functions inherited from SubmissionFilesCategoryGridDataProvider
 _getFileStageByStageId ($stageId)
 
 getAddFileAction ($request)
 
 getAuthorizationPolicy ($request, $args, $roleAssignments)
 
 getFileStage ()
 
 getRequestArgs ()
 
 loadData ($filter=array())
 
 setDataProvider ($gridDataProvider)
 
 setStageId ($stageId)
 
- Public Member Functions inherited from CategoryGridDataProvider
 getDataProvider ()
 
 loadCategoryData ($request, $categoryDataElement, $filter=null)
 
 setAuthorizedContext (&$authorizedContext)
 
- Public Member Functions inherited from GridDataProvider
 __construct ()
 
getAuthorizedContextObject ($assocType)
 
 hasAuthorizedContextObject ($assocType)
 

Additional Inherited Members

- Data Fields inherited from SubmissionFilesCategoryGridDataProvider
 $_submissionFiles
 
- Data Fields inherited from CategoryGridDataProvider
 $_dataProvider
 
- Data Fields inherited from GridDataProvider
 $_authorizedContext
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ReviewCategoryGridDataProvider::__construct (   $fileStage,
  $viewableOnly = false 
)

Constructor

Parameters
$fileStageint
$viewableOnlyint Will be passed to the review grid data provider. See parameter description there.

Reimplemented from SubmissionFilesCategoryGridDataProvider.

Definition at line 26 of file ReviewCategoryGridDataProvider.inc.php.

Member Function Documentation

◆ getReviewRound()

ReviewCategoryGridDataProvider::getReviewRound ( )

◆ getSelectAction()

ReviewCategoryGridDataProvider::getSelectAction (   $request)

Configures and returns the select files action.

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

Parameters
$requestRequest
Returns
SelectFilesLinkAction

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

References CategoryGridDataProvider\getDataProvider().

◆ initGridDataProvider()

ReviewCategoryGridDataProvider::initGridDataProvider (   $fileStage,
  $initParams = null 
)

Init the grid data provider that this category grid data provider will use and return it. Override this to initiate another grid data provider.

Parameters
$fileStageint
$initParamsarray (optional) The parameters to initiate the grid data provider.
Returns
SubmissionFilesGridDataProvider

Reimplemented from SubmissionFilesCategoryGridDataProvider.

Definition at line 57 of file ReviewCategoryGridDataProvider.inc.php.

◆ loadCategoryData()

ReviewCategoryGridDataProvider::loadCategoryData (   $request,
  $categoryDataElement,
  $filter = null,
  $reviewRound = null 
)

Retrieve the category data to load into the grid.

Parameters
$requestPKPRequest
$categoryDataElementmixed
$filtermixed array or null
Returns
array

Reimplemented from SubmissionFilesCategoryGridDataProvider.

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

References getReviewRound().


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