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

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 initialize ($request)
 
 publish ($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)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=null)
 

Data Fields

 $publication
 
 $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

A handler to load final publishing confirmation checks.

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

Constructor & Destructor Documentation

◆ __construct()

PublishHandler::__construct ( )

Constructor.

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

PublishHandler::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 61 of file PublishHandler.inc.php.

References PKPHandler\addPolicy().

◆ initialize()

PublishHandler::initialize (   $request)

Subclasses can override this method to configure the handler.

NB: This method will be called after validation and authorization.

Parameters
$requestPKPRequest

Reimplemented from PKPHandler.

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

References PKPHandler\getAuthorizedContextObject(), and PKPHandler\setupTemplate().

◆ publish()

PublishHandler::publish (   $args,
  $request 
)

Display a publishing confirmation form

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage JSON object

Definition at line 80 of file PublishHandler.inc.php.

References PKPServices\get(), PKPTemplateManager\getManager(), and AppLocale\requireComponents().

Field Documentation

◆ $publication

Publication PublishHandler::$publication

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

◆ $submission

Submission PublishHandler::$submission

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


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