Open Journal Systems  3.3.0
GridDataProvider Class Reference
Inheritance diagram for GridDataProvider:
CategoryGridDataProvider FilesGridDataProvider LibraryFileAdminGridDataProvider SubmissionDocumentsFilesGridDataProvider SubmissionFilesCategoryGridDataProvider SubmissionFilesGridDataProvider QueryNoteFilesCategoryGridDataProvider ReviewCategoryGridDataProvider CopyeditFilesGridDataProvider DependentFilesGridDataProvider FinalDraftFilesGridDataProvider QueryNoteFilesGridDataProvider ReviewerReviewAttachmentGridDataProvider ReviewGridDataProvider

Public Member Functions

 __construct ()
 
 getAuthorizationPolicy ($request, $args, $roleAssignments)
 
getAuthorizedContextObject ($assocType)
 
 getRequestArgs ()
 
 hasAuthorizedContextObject ($assocType)
 
 loadData ($filter=array())
 
 setAuthorizedContext (&$authorizedContext)
 

Data Fields

 $_authorizedContext
 

Detailed Description

Grid data providers serve data to the grid classes for presentation in a grid.

For general information about grids, see GridHandler.

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

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAuthorizationPolicy()

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

◆ getAuthorizedContextObject()

◆ getRequestArgs()

GridDataProvider::getRequestArgs ( )

◆ hasAuthorizedContextObject()

GridDataProvider::hasAuthorizedContextObject (   $assocType)

Check whether an object already exists in the authorized context.

Parameters
$assocTypeinteger
Returns
boolean

Definition at line 67 of file GridDataProvider.inc.php.

Referenced by getAuthorizedContextObject().

◆ loadData()

GridDataProvider::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 in SubmissionFilesGridDataProvider, ReviewerReviewAttachmentGridDataProvider, SubmissionFilesCategoryGridDataProvider, ReviewGridDataProvider, QueryNoteFilesGridDataProvider, ReviewerReviewFilesGridDataProvider, DependentFilesGridDataProvider, and ReviewRevisionsGridDataProvider.

Definition at line 103 of file GridDataProvider.inc.php.

◆ setAuthorizedContext()

GridDataProvider::setAuthorizedContext ( $authorizedContext)

Set the authorized context once it is established.

Parameters
$authorizedContextarray

Reimplemented in CategoryGridDataProvider.

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

Field Documentation

◆ $_authorizedContext

array GridDataProvider::$_authorizedContext

Definition at line 24 of file GridDataProvider.inc.php.


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