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

Public Member Functions

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

Protected Attributes

 $_parentPlugin = null
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

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
 

Detailed Description

Handles request for sword plugin.

Definition at line 15 of file SwordHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

SwordHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

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

References PKPHandler\addRoleAssignment(), and PluginRegistry\getPlugin().

Member Function Documentation

◆ authorize()

SwordHandler::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 42 of file SwordHandler.inc.php.

References PKPHandler\addPolicy().

◆ depositPoints()

SwordHandler::depositPoints (   $args,
  $request 
)

Returns deposit point details

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage

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

References DAORegistry\getDAO(), getSwordPlugin(), and DepositPointsHelper\loadCollectionsFromServer().

◆ getSwordPlugin()

SwordHandler::getSwordPlugin ( )

Get reference to the sword plugin

Returns
SwordPlugin

Definition at line 52 of file SwordHandler.inc.php.

References $_parentPlugin.

Referenced by depositPoints(), and index().

◆ index()

SwordHandler::index (   $args,
  $request 
)

Returns author deposit points page

Parameters
$argsarray
$requestPKPRequest
Returns
JSONMessage

Reimplemented from PKPHandler.

Definition at line 95 of file SwordHandler.inc.php.

References DAORegistry\getDAO(), Application\getSubmissionDAO(), and getSwordPlugin().

Field Documentation

◆ $_parentPlugin

SwordPlugin SwordHandler::$_parentPlugin = null
protected

Sword plugin

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

Referenced by getSwordPlugin().


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