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

Public Member Functions

 activateUser ($args, $request)
 
 initialize ($request)
 
 register ($args, $request)
 
 registerUser ($args, $request)
 
 validate ($requiredContexts=null, $request=null)
 
- Public Member Functions inherited from UserHandler
 _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)
 
 markRoleAssignmentsChecked ()
 
 requireSSL ()
 
 setApiToken ($apiToken)
 
 setDispatcher ($dispatcher)
 
 setEnforceRestrictedSite ($enforceRestrictedSite)
 
 setId ($id)
 

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 requests for user registration.

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

Member Function Documentation

◆ activateUser()

RegistrationHandler::activateUser (   $args,
  $request 
)

Check credentials and activate a new user

Parameters
$argsarray
$requestPKPRequest

Definition at line 127 of file RegistrationHandler.inc.php.

References AccessKeyManager\generateKeyHash(), Core\getCurrentDate(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), and AppLocale\requireComponents().

◆ initialize()

RegistrationHandler::initialize (   $request)
See also
PKPHandler::initialize()

Reimplemented from PKPHandler.

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

References AppLocale\requireComponents().

◆ register()

RegistrationHandler::register (   $args,
  $request 
)

Display registration form for new users, validate and execute that form, or display a registration success page if the user is logged in.

Parameters
$argsarray
$requestPKPRequest

Definition at line 35 of file RegistrationHandler.inc.php.

References PKPTemplateManager\getManager(), Config\getVar(), Validation\isLoggedIn(), Validation\login(), UserHandler\setupTemplate(), and validate().

◆ registerUser()

RegistrationHandler::registerUser (   $args,
  $request 
)

Re-route request to the register method. Backwards-compatible with third-party themes that submit the registration form to the registerUser method.

See also
RegistrationHandler::register

Definition at line 118 of file RegistrationHandler.inc.php.

◆ validate()

RegistrationHandler::validate (   $requiredContexts = null,
  $request = null 
)

Perform data integrity checks.

This method will be called once for every request only.

NB: Any kind of authorization check is now deprecated within this method. This method is purely meant for data integrity checks that do not lead to denial of access to resources (e.g. via redirect) like handler operations or data objects.

Parameters
$requiredContextsarray
$requestRequest

Reimplemented from PKPHandler.

Definition at line 162 of file RegistrationHandler.inc.php.

References Application\getContextDAO(), PKPTemplateManager\getManager(), and UserHandler\setupTemplate().

Referenced by register().


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