Open Journal Systems  3.3.0
QueryNoteFilesGridDataProvider Class Reference
Inheritance diagram for QueryNoteFilesGridDataProvider:
SubmissionFilesGridDataProvider FilesGridDataProvider GridDataProvider

Public Member Functions

 __construct ($noteId)
 
 getAddFileAction ($request)
 
 getAuthorizationPolicy ($request, $args, $roleAssignments)
 
 getRequestArgs ()
 
 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)
 

Data Fields

 $_noteId
 
- Data Fields inherited from SubmissionFilesGridDataProvider
 $_fileStage
 
 $_stageId
 
- Data Fields inherited from FilesGridDataProvider
 $_uploaderRoles
 
 $_viewableOnly = false
 
- Data Fields inherited from GridDataProvider
 $_authorizedContext
 

Additional Inherited Members

- Protected Member Functions inherited from SubmissionFilesGridDataProvider
 applyFilter ($revisions, $filter)
 
- Protected Member Functions inherited from FilesGridDataProvider
 getSubmission ()
 

Detailed Description

Provide access to query files management.

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

Constructor & Destructor Documentation

◆ __construct()

QueryNoteFilesGridDataProvider::__construct (   $noteId)

Constructor

Parameters
$noteIdint Note ID

Definition at line 30 of file QueryNoteFilesGridDataProvider.inc.php.

Member Function Documentation

◆ getAddFileAction()

QueryNoteFilesGridDataProvider::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.

Definition at line 101 of file QueryNoteFilesGridDataProvider.inc.php.

References GridDataProvider\getAuthorizedContextObject(), and FilesGridDataProvider\getSubmission().

◆ getAuthorizationPolicy()

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

Get the authorization policy.

Parameters
$requestPKPRequest
$argsarray
$roleAssignmentsarray
Returns
PolicySet

Reimplemented from SubmissionFilesGridDataProvider.

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

References SubmissionFilesGridDataProvider\getStageId(), and FilesGridDataProvider\setUploaderRoles().

◆ getRequestArgs()

QueryNoteFilesGridDataProvider::getRequestArgs ( )

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

Returns
array

Reimplemented from SubmissionFilesGridDataProvider.

Definition at line 83 of file QueryNoteFilesGridDataProvider.inc.php.

References GridDataProvider\getAuthorizedContextObject().

Referenced by getSelectAction().

◆ getSelectAction()

QueryNoteFilesGridDataProvider::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 51 of file QueryNoteFilesGridDataProvider.inc.php.

References GridDataProvider\getAuthorizedContextObject(), and getRequestArgs().

◆ loadData()

QueryNoteFilesGridDataProvider::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.

Definition at line 64 of file QueryNoteFilesGridDataProvider.inc.php.

References fatalError(), GridDataProvider\getAuthorizedContextObject(), DAORegistry\getDAO(), FilesGridDataProvider\getSubmission(), and SubmissionFilesGridDataProvider\prepareSubmissionFileData().

Field Documentation

◆ $_noteId

int QueryNoteFilesGridDataProvider::$_noteId

Note ID

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


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