Open Journal Systems  3.3.0
PKPBackendPaymentsSettingsHandler Class Reference
Inheritance diagram for PKPBackendPaymentsSettingsHandler:
APIHandler PKPHandler BackendPaymentsSettingsHandler

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 edit ($slimRequest, $response, $args)
 
- Public Member Functions inherited from APIHandler
 convertStringsToSchema ($schema, $params)
 
 getApp ()
 
 getEndpointPattern ()
 
 getEndpoints ()
 
 getEntityId ($parameterName)
 
 getParameter ($parameterName, $default=null)
 
 getRequest ()
 
 getSlimRequest ()
 
 setSlimRequest ($slimRequest)
 
 setupEndpoints ()
 
- 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)
 
 setupTemplate ($request)
 
 validate ($requiredContexts=null, $request=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
 
- Protected Member Functions inherited from APIHandler
 _validateStatDates ($params, $dateStartParam='dateStart', $dateEndParam='dateEnd')
 
- Protected Attributes inherited from APIHandler
 $_app
 
 $_endpoints = array()
 
 $_handlerPath = null
 
 $_pathPattern
 
 $_request
 
 $_slimRequest = null
 
- Protected Attributes inherited from PKPHandler
 $_apiToken = null
 

Detailed Description

A private API endpoint handler for payment settings. It may be possible to deprecate this when we have a working endpoint for plugin settings.

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

Constructor & Destructor Documentation

◆ __construct()

PKPBackendPaymentsSettingsHandler::__construct ( )

Constructor

Reimplemented from APIHandler.

Definition at line 24 of file PKPBackendPaymentsSettingsHandler.inc.php.

Member Function Documentation

◆ authorize()

PKPBackendPaymentsSettingsHandler::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 44 of file PKPBackendPaymentsSettingsHandler.inc.php.

References PKPHandler\addPolicy().

◆ edit()

PKPBackendPaymentsSettingsHandler::edit (   $slimRequest,
  $response,
  $args 
)

Receive requests to edit the payments form

Parameters
$slimRequestRequest Slim request object
$responseResponse object
Returns
Response

Definition at line 65 of file PKPBackendPaymentsSettingsHandler.inc.php.

References PKPServices\get(), APIHandler\getRequest(), and PluginRegistry\loadCategory().


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