Open Journal Systems  3.3.0
PKPWorkflowTabHandler Class Reference
Inheritance diagram for PKPWorkflowTabHandler:
Handler PKPHandler WorkflowTabHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 fetchTab ($args, $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)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Protected Member Functions

 getEditorAssignmentNotificationTypeByStageId ($stageId)
 
 getProductionNotificationOptions ($submissionId)
 

Additional Inherited Members

- Static Public Member Functions inherited from PKPHandler
static getPageParamName ($rangeName)
 
static getRangeInfo ($request, $rangeName, $contextData=null)
 
static hashPageContext ($request, $contextData=array())
 
- Data Fields inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_enforceRestrictedSite = true
 
 $_id
 
 $_isBackendPage = false
 
 $_roleAssignments = array()
 
 $_roleAssignmentsChecked = false
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

Handle AJAX operations for workflow tabs.

Definition at line 23 of file PKPWorkflowTabHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PKPWorkflowTabHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 28 of file PKPWorkflowTabHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

PKPWorkflowTabHandler::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 PKPHandler.

Definition at line 40 of file PKPWorkflowTabHandler.inc.php.

References PKPHandler\addPolicy().

◆ fetchTab()

PKPWorkflowTabHandler::fetchTab (   $args,
  $request 
)

Fetch the specified workflow tab.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Reimplemented in WorkflowTabHandler.

Definition at line 58 of file PKPWorkflowTabHandler.inc.php.

References PKPHandler\getAuthorizedContextObject(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), getProductionNotificationOptions(), and setupTemplate().

◆ getEditorAssignmentNotificationTypeByStageId()

PKPWorkflowTabHandler::getEditorAssignmentNotificationTypeByStageId (   $stageId)
protected

Return the editor assignment notification type based on stage id.

Parameters
$stageIdint
Returns
int

Definition at line 185 of file PKPWorkflowTabHandler.inc.php.

Referenced by setupTemplate().

◆ getProductionNotificationOptions()

PKPWorkflowTabHandler::getProductionNotificationOptions (   $submissionId)
abstractprotected

Get all production notification options to be used in the production stage tab.

Parameters
$submissionIdint
Returns
array

Reimplemented in WorkflowTabHandler.

Referenced by fetchTab().

◆ setupTemplate()

PKPWorkflowTabHandler::setupTemplate (   $request)

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