Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
UserHandler Class Reference
Inheritance diagram for UserHandler:
Handler PKPHandler EmailHandler ProfileHandler RegistrationHandler

Public Member Functions

 _checkIncompleteSetup ($journal)
 
 _getRoleDataForJournal ($userId, $journalId, &$submissionsCount, &$isValid)
 
 authorizationDenied ($args, &$request)
 
 become ($args, &$request)
 
 completePurchaseSubscription ($args, &$request)
 
 gifts ($args, $request)
 
 index ($args, &$request)
 
 payMembership ($args, &$request)
 
 payPurchaseSubscription ($args, &$request)
 
 payRenewSubscription ($args, &$request)
 
 purchaseSubscription ($args, &$request)
 
 redeemGift ($args, $request)
 
 setLocale ($args, $request)
 
 setupTemplate (&$request, $subclass=false)
 
 subscriptions ($args, &$request)
 
 UserHandler ()
 
 validate ($loginCheck=true)
 
 viewPublicProfile ($args, &$request)
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy (&$authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize (&$request, &$args, $roleAssignments)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
getRangeInfo ($rangeName, $contextData=null)
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 hashPageContext ($contextData=array())
 
 index ()
 
 initialize (&$request, $args=null)
 
 PKPHandler ()
 
 requireSSL ()
 
 setDispatcher (&$dispatcher)
 
 setId ($id)
 
 validate ($requiredContexts=null, $request=null)
 

Detailed Description

Handle requests for user functions.

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

Member Function Documentation

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 347 of file UserHandler.inc.php.

Referenced by index().

UserHandler::_getRoleDataForJournal (   $userId,
  $journalId,
$submissionsCount,
$isValid 
)

Gather information about a user's role within a journal.

Parameters
$userIdint
$journalIdint
$submissionsCountarray reference
$isValidarray reference

Definition at line 297 of file UserHandler.inc.php.

References DAORegistry\getDAO(), Validation\isAuthor(), Validation\isCopyeditor(), Validation\isEditor(), Validation\isJournalManager(), Validation\isLayoutEditor(), Validation\isProofreader(), Validation\isReviewer(), Validation\isSectionEditor(), and Validation\isSubscriptionManager().

Referenced by index().

UserHandler::authorizationDenied (   $args,
$request 
)

Display an authorization denied message.

Parameters
$argsarray
$requestRequest

Definition at line 434 of file UserHandler.inc.php.

References AppLocale\requireComponents(), setupTemplate(), and validate().

UserHandler::become (   $args,
$request 
)

Become a given role.

Parameters
$argsarray
$requestPKPRequest

Definition at line 392 of file UserHandler.inc.php.

References DAORegistry\getDAO().

UserHandler::completePurchaseSubscription (   $args,
$request 
)

Complete the purchase subscription process.

Parameters
$argsarray
$requestPKPRequest

Definition at line 712 of file UserHandler.inc.php.

References DAORegistry\getDAO(), setupTemplate(), and validate().

UserHandler::gifts (   $args,
  $request 
)

Display user gifts page

Parameters
$argsarray
$requestPKPRequest

Definition at line 123 of file UserHandler.inc.php.

References DAORegistry\getDAO(), setupTemplate(), and validate().

UserHandler::index (   $args,
$request 
)

Display user index page.

Parameters
$argsarray
$requestPKPRequest

Definition at line 31 of file UserHandler.inc.php.

References _checkIncompleteSetup(), _getRoleDataForJournal(), DAORegistry\getDAO(), SessionManager\getManager(), setupTemplate(), and validate().

UserHandler::payMembership (   $args,
$request 
)

Pay for a membership.

Parameters
$argsarray
$requestPKPRequest

Definition at line 821 of file UserHandler.inc.php.

References setupTemplate(), and validate().

UserHandler::payPurchaseSubscription (   $args,
$request 
)

Pay for a subscription purchase.

Parameters
$argsarray
$requestPKPRequest

Definition at line 608 of file UserHandler.inc.php.

References DAORegistry\getDAO(), setupTemplate(), and validate().

UserHandler::payRenewSubscription (   $args,
$request 
)

Pay the "renew subscription" fee.

Parameters
$argsarray
$requestPKPRequest

Definition at line 763 of file UserHandler.inc.php.

References DAORegistry\getDAO(), setupTemplate(), and validate().

UserHandler::purchaseSubscription (   $args,
$request 
)

Purchase a subscription.

Parameters
$argsarray
$requestPKPRequest

Definition at line 529 of file UserHandler.inc.php.

References DAORegistry\getDAO(), setupTemplate(), and validate().

UserHandler::redeemGift (   $args,
  $request 
)

User redeems a gift

Parameters
$argsarray
$requestPKPRequest

Definition at line 165 of file UserHandler.inc.php.

References DAORegistry\getDAO(), and validate().

UserHandler::setLocale (   $args,
  $request 
)

Change the locale for the current user.

Parameters
$argsarray first parameter is the new locale

Definition at line 358 of file UserHandler.inc.php.

References PKPLocale\isLocaleValid().

UserHandler::subscriptions (   $args,
$request 
)

Display subscriptions page

Parameters
$argsarray
$requestPKPRequest

Definition at line 231 of file UserHandler.inc.php.

References DAORegistry\getDAO(), setupTemplate(), and validate().

UserHandler::UserHandler ( )

Constructor

Definition at line 22 of file UserHandler.inc.php.

UserHandler::viewPublicProfile (   $args,
$request 
)

View the public user profile for a user, specified by user ID, if that user should be exposed for public view.

Parameters
$argsarray
$requestPKPRequest

Definition at line 495 of file UserHandler.inc.php.

References DAORegistry\getDAO(), setupTemplate(), and validate().


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