Open Journal Systems  3.3.0
UserHandler Class Reference
Inheritance diagram for UserHandler:
PKPUserHandler APIHandler PKPHandler ProfileHandler RegistrationHandler

Public Member Functions

 _checkIncompleteSetup ($journal)
 
 completePurchaseSubscription ($args, $request)
 
 payMembership ($args, $request)
 
 payPurchaseSubscription ($args, $request)
 
 payRenewSubscription ($args, $request)
 
 purchaseSubscription ($args, $request)
 
 setupTemplate ($request=null)
 
 subscriptions ($args, $request)
 
- Public Member Functions inherited from PKPUserHandler
 __construct ()
 
 authorizationDenied ($args, $request)
 
 authorize ($request, &$args, $roleAssignments)
 
 get ($slimRequest, $response, $args)
 
 getInterests ($args, $request)
 
 getMany ($slimRequest, $response, $args)
 
 getReviewers ($slimRequest, $response, $args)
 
 index ($args, $request)
 
 setLocale ($args, $request)
 
- 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)
 
 initialize ($request)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 
 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

Handle API requests for user operations.

Handle requests for user functions.

Definition at line 19 of file api/v1/users/UserHandler.inc.php.

Member Function Documentation

◆ _checkIncompleteSetup()

UserHandler::_checkIncompleteSetup (   $journal)

Determine if the journal's setup has been sufficiently completed.

Parameters
$journalObject
Returns
boolean True iff setup is incomplete

Definition at line 78 of file pages/user/UserHandler.inc.php.

◆ completePurchaseSubscription()

UserHandler::completePurchaseSubscription (   $args,
  $request 
)

Complete the purchase subscription process.

Parameters
$argsarray
$requestPKPRequest

Definition at line 278 of file pages/user/UserHandler.inc.php.

References DAORegistry\getDAO(), Application\getPaymentManager(), setupTemplate(), and PKPHandler\validate().

◆ payMembership()

UserHandler::payMembership (   $args,
  $request 
)

Pay for a membership.

Parameters
$argsarray
$requestPKPRequest

Definition at line 377 of file pages/user/UserHandler.inc.php.

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

◆ payPurchaseSubscription()

UserHandler::payPurchaseSubscription (   $args,
  $request 
)

Pay for a subscription purchase.

Parameters
$argsarray
$requestPKPRequest

Definition at line 177 of file pages/user/UserHandler.inc.php.

References DAORegistry\getDAO(), Application\getPaymentManager(), setupTemplate(), and PKPHandler\validate().

◆ payRenewSubscription()

UserHandler::payRenewSubscription (   $args,
  $request 
)

Pay the "renew subscription" fee.

Parameters
$argsarray
$requestPKPRequest

Definition at line 324 of file pages/user/UserHandler.inc.php.

References DAORegistry\getDAO(), Application\getPaymentManager(), setupTemplate(), and PKPHandler\validate().

◆ purchaseSubscription()

UserHandler::purchaseSubscription (   $args,
  $request 
)

Purchase a subscription.

Parameters
$argsarray
$requestPKPRequest

Definition at line 103 of file pages/user/UserHandler.inc.php.

References DAORegistry\getDAO(), Application\getPaymentManager(), setupTemplate(), and PKPHandler\validate().

◆ setupTemplate()

UserHandler::setupTemplate (   $request = null)

◆ subscriptions()

UserHandler::subscriptions (   $args,
  $request 
)

Display subscriptions page

Parameters
$argsarray
$requestPKPRequest

Definition at line 24 of file pages/user/UserHandler.inc.php.

References DAORegistry\getDAO(), PKPTemplateManager\getManager(), Application\getPaymentManager(), setupTemplate(), and PKPHandler\validate().


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