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

Public Member Functions

 __construct ()
 
 authorize ($request, &$args, $roleAssignments)
 
 index ($args, $request)
 
 payments ($args, $request)
 
 paymentTypes ($args, $request)
 
 savePaymentTypes ($args, $request)
 
 saveSubscriptionPolicies ($args, $request)
 
 subscriptionPolicies ($args, $request)
 
 subscriptions ($args, $request)
 
 subscriptionTypes ($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)
 

Data Fields

 $_isBackendPage = true
 
- 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

Handle requests for payment management.

Definition at line 18 of file PaymentsHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PaymentsHandler::__construct ( )

Constructor.

Reimplemented from PKPHandler.

Definition at line 26 of file PaymentsHandler.inc.php.

References PKPHandler\addRoleAssignment().

Member Function Documentation

◆ authorize()

PaymentsHandler::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 52 of file PaymentsHandler.inc.php.

References PKPHandler\addPolicy().

◆ index()

PaymentsHandler::index (   $args,
  $request 
)

Display a list of payment tabs for the current journal.

Parameters
$argsarray
$requestPKPRequest

Reimplemented from PKPHandler.

Definition at line 39 of file PaymentsHandler.inc.php.

References PKPTemplateManager\getManager(), AppLocale\requireComponents(), and PKPHandler\setupTemplate().

◆ payments()

PaymentsHandler::payments (   $args,
  $request 
)

Display a list of payments for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 194 of file PaymentsHandler.inc.php.

References PKPTemplateManager\getManager().

◆ paymentTypes()

PaymentsHandler::paymentTypes (   $args,
  $request 
)

Display payment types for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 156 of file PaymentsHandler.inc.php.

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

◆ savePaymentTypes()

PaymentsHandler::savePaymentTypes (   $args,
  $request 
)

Save payment types for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 172 of file PaymentsHandler.inc.php.

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

◆ saveSubscriptionPolicies()

PaymentsHandler::saveSubscriptionPolicies (   $args,
  $request 
)

Save subscription policies for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 134 of file PaymentsHandler.inc.php.

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

◆ subscriptionPolicies()

PaymentsHandler::subscriptionPolicies (   $args,
  $request 
)

Display subscription policies for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 109 of file PaymentsHandler.inc.php.

References PKPTemplateManager\getManager(), Application\getPaymentManager(), Config\getVar(), PKPHandler\setupTemplate(), and PKPHandler\validate().

◆ subscriptions()

PaymentsHandler::subscriptions (   $args,
  $request 
)

Display a list of subscriptions for the current journal.

Parameters
$argsarray
$requestPKPRequest

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

References PKPTemplateManager\getManager().

◆ subscriptionTypes()

PaymentsHandler::subscriptionTypes (   $args,
  $request 
)

Display a list of subscription types for the current journal.

Parameters
$argsarray
$requestPKPRequest

Definition at line 92 of file PaymentsHandler.inc.php.

References PKPTemplateManager\getManager().

Field Documentation

◆ $_isBackendPage

PaymentsHandler::$_isBackendPage = true

Definition at line 21 of file PaymentsHandler.inc.php.


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