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

Public Member Functions

 _getAssocId ()
 
 _getAssocType ()
 
 authorize ($request, &$args, $roleAssignments)
 
 saveNote ($args, $request)
 
 viewHistory ($args, $request)
 
 viewInformationCenter ($args, $request)
 
 viewNotes ($args, $request)
 
- Public Member Functions inherited from InformationCenterHandler
 __construct ()
 
 _getLinkParams ()
 
 _listNotes ($args, $request)
 
 _logEvent ($request, $object, $eventType, $logClass)
 
 deleteNote ($args, $request)
 
 initialize ($request)
 
 setupTemplate ($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

 $_isCurrentUserAssignedEditor
 
- 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 submission.

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

Member Function Documentation

◆ _getAssocId()

SubmissionInformationCenterHandler::_getAssocId ( )

Get the association ID for this information center view

Returns
int

Reimplemented from InformationCenterHandler.

Definition at line 142 of file SubmissionInformationCenterHandler.inc.php.

◆ _getAssocType()

SubmissionInformationCenterHandler::_getAssocType ( )

Get the association type for this information center view

Returns
int

Reimplemented from InformationCenterHandler.

Definition at line 150 of file SubmissionInformationCenterHandler.inc.php.

◆ authorize()

SubmissionInformationCenterHandler::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 31 of file SubmissionInformationCenterHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ saveNote()

SubmissionInformationCenterHandler::saveNote (   $args,
  $request 
)

◆ viewHistory()

SubmissionInformationCenterHandler::viewHistory (   $args,
  $request 
)

Fetch the contents of the event log.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 130 of file SubmissionInformationCenterHandler.inc.php.

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

◆ viewInformationCenter()

SubmissionInformationCenterHandler::viewInformationCenter (   $args,
  $request 
)

Display the main information center modal.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Reimplemented from InformationCenterHandler.

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

References PKPTemplateManager\getManager().

◆ viewNotes()

SubmissionInformationCenterHandler::viewNotes (   $args,
  $request 
)

Display the notes tab.

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Reimplemented from InformationCenterHandler.

Definition at line 77 of file SubmissionInformationCenterHandler.inc.php.

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

Referenced by saveNote().

Field Documentation

◆ $_isCurrentUserAssignedEditor

boolean SubmissionInformationCenterHandler::$_isCurrentUserAssignedEditor

Is the current user assigned to an editorial role for this submission

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


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