Open Journal Systems  3.3.0
PKPAuthorDashboardHandler Class Reference
Inheritance diagram for PKPAuthorDashboardHandler:
Handler PKPHandler AuthorDashboardHandler AuthorDashboardReviewRoundTabHandler

Public Member Functions

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

Data Fields

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

Protected Member Functions

 _fileStageFromWorkflowStage ($currentStage)
 
 _getRepresentationsGridUrl ($request, $submission)
 

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 for the author dashboard.

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

Constructor & Destructor Documentation

◆ __construct()

PKPAuthorDashboardHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Reimplemented in AuthorDashboardReviewRoundTabHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ _fileStageFromWorkflowStage()

PKPAuthorDashboardHandler::_fileStageFromWorkflowStage (   $currentStage)
protected

Get the SUBMISSION_FILE_... file stage based on the current WORKFLOW_STAGE_... workflow stage.

Parameters
$currentStageint WORKFLOW_STAGE_...
Returns
int SUBMISSION_FILE_...

Definition at line 100 of file PKPAuthorDashboardHandler.inc.php.

Referenced by setupTemplate().

◆ _getRepresentationsGridUrl()

PKPAuthorDashboardHandler::_getRepresentationsGridUrl (   $request,
  $submission 
)
abstractprotected

Get the URL for the galley/publication formats grid with a placeholder for the publicationId value

Parameters
Request$request
Submission$submission
Returns
string

Reimplemented in AuthorDashboardHandler.

Referenced by setupTemplate().

◆ authorize()

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

Reimplemented in AuthorDashboardReviewRoundTabHandler.

Definition at line 46 of file PKPAuthorDashboardHandler.inc.php.

References PKPHandler\addPolicy().

◆ readSubmissionEmail()

PKPAuthorDashboardHandler::readSubmissionEmail (   $args,
  $request 
)

Fetches information about a specific email and returns it.

Parameters
$argsarray
$requestRequest
Returns
JSONMessage JSON object

Definition at line 78 of file PKPAuthorDashboardHandler.inc.php.

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

◆ setupTemplate()

◆ submission()

PKPAuthorDashboardHandler::submission (   $args,
  $request 
)

Displays the author dashboard.

Parameters
$argsarray
$requestPKPRequest

Definition at line 63 of file PKPAuthorDashboardHandler.inc.php.

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

Field Documentation

◆ $_isBackendPage

PKPAuthorDashboardHandler::$_isBackendPage = true

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


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