Open Monograph Press  3.3.0
PublicationFormatCategoryGridDataProvider Class Reference
Inheritance diagram for PublicationFormatCategoryGridDataProvider:
SubmissionFilesCategoryGridDataProvider CategoryGridDataProvider GridDataProvider

Public Member Functions

 __construct ($gridHandler)
 
 getPublication ()
 
 getRepresentation ()
 
 getRequestArgs ()
 
 getSubmission ()
 
 loadCategoryData ($request, $categoryDataElement, $filter=null, $reviewRound=null)
 
 loadData ($filter=array())
 
- Public Member Functions inherited from SubmissionFilesCategoryGridDataProvider
 __construct ($fileStage, $dataProviderInitParams=null)
 
 _getFileStageByStageId ($stageId)
 
 getAddFileAction ($request)
 
 getAuthorizationPolicy ($request, $args, $roleAssignments)
 
 getFileStage ()
 
 initGridDataProvider ($fileStage, $initParams=null)
 
 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)
 

Data Fields

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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

PublicationFormatCategoryGridDataProvider::__construct (   $gridHandler)

Member Function Documentation

◆ getPublication()

PublicationFormatCategoryGridDataProvider::getPublication ( )

Get the publication associated with this grid

Returns
Publication

Definition at line 61 of file PublicationFormatCategoryGridDataProvider.inc.php.

References GridDataProvider\getAuthorizedContextObject().

Referenced by loadData().

◆ getRepresentation()

PublicationFormatCategoryGridDataProvider::getRepresentation ( )

Get the representation associated with this grid

Returns
Representation

Definition at line 45 of file PublicationFormatCategoryGridDataProvider.inc.php.

References GridDataProvider\getAuthorizedContextObject().

Referenced by getRequestArgs().

◆ getRequestArgs()

PublicationFormatCategoryGridDataProvider::getRequestArgs ( )

Get the grid request parameters. These are the parameters that uniquely identify the data within a grid.

NB: You should make sure to authorize and/or validate parameters before you publish them through this interface. Callers will assume that data accessed through this method will not have to be sanitized.

The default implementation tries to retrieve request parameters from a data provider if there is one.

Returns
array

Reimplemented from SubmissionFilesCategoryGridDataProvider.

Definition at line 71 of file PublicationFormatCategoryGridDataProvider.inc.php.

References getRepresentation().

◆ getSubmission()

PublicationFormatCategoryGridDataProvider::getSubmission ( )

Get the submission associated with this grid

Returns
Submission

Definition at line 53 of file PublicationFormatCategoryGridDataProvider.inc.php.

References GridDataProvider\getAuthorizedContextObject().

◆ loadCategoryData()

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

◆ loadData()

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

Implement this method to load data into the grid.

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

Reimplemented from SubmissionFilesCategoryGridDataProvider.

Definition at line 87 of file PublicationFormatCategoryGridDataProvider.inc.php.

References getPublication(), and Application\getRepresentationDAO().

Field Documentation

◆ $_gridHandler

PublicationFormatGridHandler PublicationFormatCategoryGridDataProvider::$_gridHandler

this data provider is used in

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


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