Open Journal Systems  3.3.0
FileInformationCenterHandler Class Reference
Inheritance diagram for FileInformationCenterHandler:
InformationCenterHandler Handler PKPHandler

Public Member Functions

 __construct ()
 
 _getAssocId ()
 
 _getAssocType ()
 
 _getLinkParams ()
 
 _listPastNotes ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 initialize ($request)
 
 saveNote ($args, $request)
 
 setupTemplate ($request)
 
 viewHistory ($args, $request)
 
 viewInformationCenter ($args, $request)
 
 viewNotes ($args, $request)
 
- Public Member Functions inherited from InformationCenterHandler
 _listNotes ($args, $request)
 
 _logEvent ($request, $object, $eventType, $logClass)
 
 deleteNote ($args, $request)
 
- Public Member Functions inherited from PKPHandler
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 getApiToken ()
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, &$contextsCount=null)
 
 index ($args, $request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Data Fields

 $_stageId
 
 $submissionFile
 
- Data Fields inherited from InformationCenterHandler
 $_submission
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle requests to view the information center for a file.

Definition at line 20 of file FileInformationCenterHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

FileInformationCenterHandler::__construct ( )

Constructor

Reimplemented from InformationCenterHandler.

Definition at line 36 of file FileInformationCenterHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _getAssocId()

FileInformationCenterHandler::_getAssocId ( )

Get the association ID for this information center view

Returns
int

Reimplemented from InformationCenterHandler.

Definition at line 218 of file FileInformationCenterHandler.inc.php.

◆ _getAssocType()

FileInformationCenterHandler::_getAssocType ( )

Get the association type for this information center view

Returns
int

Reimplemented from InformationCenterHandler.

Definition at line 226 of file FileInformationCenterHandler.inc.php.

Referenced by _listPastNotes().

◆ _getLinkParams()

FileInformationCenterHandler::_getLinkParams ( )

Get an array representing link parameters that subclasses need to have passed to their various handlers (i.e. submission ID to the delete note handler).

Returns
array

Reimplemented from InformationCenterHandler.

Definition at line 204 of file FileInformationCenterHandler.inc.php.

◆ _listPastNotes()

FileInformationCenterHandler::_listPastNotes (   $args,
  $request 
)

Display the list of existing notes from prior files.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 118 of file FileInformationCenterHandler.inc.php.

References $submissionFile, _getAssocType(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), and setupTemplate().

Referenced by viewNotes().

◆ authorize()

FileInformationCenterHandler::authorize (   $request,
$args,
  $roleAssignments 
)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters
$requestRequest
$argsarray request arguments
$roleAssignmentsarray the operation role assignment, see getRoleAssignment() for more details.
Returns
boolean

Reimplemented from InformationCenterHandler.

Definition at line 51 of file FileInformationCenterHandler.inc.php.

References PKPHandler\addPolicy().

◆ initialize()

FileInformationCenterHandler::initialize (   $request)

Fetch and store away objects

Parameters
$requestPKPRequest

Reimplemented from InformationCenterHandler.

Definition at line 62 of file FileInformationCenterHandler.inc.php.

References fatalError(), PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().

◆ saveNote()

FileInformationCenterHandler::saveNote (   $args,
  $request 
)

Save a note.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Reimplemented from InformationCenterHandler.

Definition at line 153 of file FileInformationCenterHandler.inc.php.

References InformationCenterHandler\_logEvent(), PKPNotificationOperationManager\createTrivialNotification(), setupTemplate(), and viewNotes().

◆ setupTemplate()

FileInformationCenterHandler::setupTemplate (   $request)

Set up the template

Parameters
$requestPKPRequest

Reimplemented from InformationCenterHandler.

Definition at line 234 of file FileInformationCenterHandler.inc.php.

References DAORegistry\getDAO(), and PKPTemplateManager\getManager().

Referenced by _listPastNotes(), saveNote(), viewHistory(), viewInformationCenter(), and viewNotes().

◆ viewHistory()

FileInformationCenterHandler::viewHistory (   $args,
  $request 
)

Fetch the contents of the event log.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 188 of file FileInformationCenterHandler.inc.php.

References PKPTemplateManager\getManager(), and setupTemplate().

◆ viewInformationCenter()

FileInformationCenterHandler::viewInformationCenter (   $args,
  $request 
)

Display the main information center modal.

Parameters
$argsarray
$requestPKPRequest

Reimplemented from InformationCenterHandler.

Definition at line 79 of file FileInformationCenterHandler.inc.php.

References PKPTemplateManager\getManager(), and setupTemplate().

◆ viewNotes()

FileInformationCenterHandler::viewNotes (   $args,
  $request 
)

Display the notes tab.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Reimplemented from InformationCenterHandler.

Definition at line 98 of file FileInformationCenterHandler.inc.php.

References InformationCenterHandler\_listNotes(), _listPastNotes(), PKPTemplateManager\getManager(), and setupTemplate().

Referenced by saveNote().

Field Documentation

◆ $_stageId

int FileInformationCenterHandler::$_stageId

Definition at line 31 of file FileInformationCenterHandler.inc.php.

◆ $submissionFile

object FileInformationCenterHandler::$submissionFile

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

Referenced by _listPastNotes().


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