Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPLoginHandler Class Reference
Inheritance diagram for PKPLoginHandler:
Handler PKPHandler LoginHandler

Public Member Functions

 _redirectAfterLogin ($request)
 
 _setMailFrom ($request, $mail, $site)
 
 changePassword ($args, $request)
 
 implicitAuthLogin ($args, $request)
 
 implicitAuthReturn ($args, $request)
 
 index ($args, $request)
 
 lostPassword ($args, $request)
 
 PKPLoginHandler ()
 
 requestResetPassword ($args, $request)
 
 resetPassword ($args, $request)
 
 savePassword ($args, $request)
 
 signIn ($args, $request)
 
 signOut ($args, $request)
 
- Public Member Functions inherited from Handler
 getSiteRedirectContext ($request)
 
 getTargetContext ($request, $bestGuess=true)
 
 getWorkingContexts ($request)
 
 Handler ()
 
- Public Member Functions inherited from PKPHandler
 addCheck (&$handlerValidator)
 
 addPolicy ($authorizationPolicy, $addToTop=false)
 
 addRoleAssignment ($roleIds, $operations)
 
 authorize ($request, &$args, $roleAssignments, $enforceRestrictedSite=true)
 
getAuthorizedContext ()
 
getAuthorizedContextObject ($assocType)
 
getDispatcher ()
 
 getFirstUserContext ($user, $contexts)
 
 getId ()
 
 getLastAuthorizationMessage ()
 
 getLoginExemptions ()
 
 getRoleAssignment ($roleId)
 
 getRoleAssignments ()
 
 getWorkingContexts ($request)
 
 index ($args, $request)
 
 initialize ($request, $args=null)
 
 PKPHandler ()
 
 setDispatcher ($dispatcher)
 
 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())
 
- Public Attributes inherited from PKPHandler
 $_authorizationDecisionManager
 
 $_checks = array()
 
 $_dispatcher
 
 $_id
 
 $_roleAssignments = array()
 

Detailed Description

Handle login/logout requests.

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

Member Function Documentation

PKPLoginHandler::_redirectAfterLogin (   $request)

After a login has completed, direct the user somewhere. (May be extended by subclasses.)

Parameters
$requestPKPRequest

Definition at line 103 of file PKPLoginHandler.inc.php.

Referenced by signIn().

PKPLoginHandler::_setMailFrom (   $request,
  $mail,
  $site 
)

Helper function - set mail From can be overriden by child classes

Parameters
$requestPKPRequest
MailTemplate$mail
$siteSite

Definition at line 326 of file PKPLoginHandler.inc.php.

Referenced by requestResetPassword(), and resetPassword().

PKPLoginHandler::changePassword (   $args,
  $request 
)

Display form to change user's password.

Parameters
$argsarray first argument may contain user's username

Definition at line 284 of file PKPLoginHandler.inc.php.

References Form\initData(), and PKPHandler\setupTemplate().

PKPLoginHandler::implicitAuthLogin (   $args,
  $request 
)

Handle login when implicitAuth is enabled. If the user came in on a non-ssl url - then redirect back to the ssl url

Definition at line 72 of file PKPLoginHandler.inc.php.

References Config\getVar().

PKPLoginHandler::implicitAuthReturn (   $args,
  $request 
)

This is the function that Shibboleth redirects to - after the user has authenticated.

Definition at line 87 of file PKPLoginHandler.inc.php.

References PKPValidation\login().

PKPLoginHandler::index (   $args,
  $request 
)

Display user login form. Redirect to user index page if user is already validated.

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

References SessionManager\getManager(), Config\getVar(), String\regexp_replace(), and PKPHandler\setupTemplate().

PKPLoginHandler::lostPassword (   $args,
  $request 
)

Display form to reset a user's password.

Definition at line 175 of file PKPLoginHandler.inc.php.

References PKPHandler\setupTemplate().

PKPLoginHandler::PKPLoginHandler ( )

Constructor

Definition at line 23 of file PKPLoginHandler.inc.php.

PKPLoginHandler::requestResetPassword (   $args,
  $request 
)

Send a request to reset a user's password

Definition at line 184 of file PKPLoginHandler.inc.php.

References _setMailFrom(), PKPValidation\generatePasswordResetHash(), DAORegistry\getDAO(), and PKPHandler\setupTemplate().

PKPLoginHandler::resetPassword (   $args,
  $request 
)

Reset a user's password

Parameters
$argsarray first param contains the username of the user whose password is to be reset

Definition at line 221 of file PKPLoginHandler.inc.php.

References _setMailFrom(), PKPValidation\encryptCredentials(), PKPValidation\generatePassword(), PKPValidation\generatePasswordResetHash(), DAORegistry\getDAO(), and PKPHandler\setupTemplate().

PKPLoginHandler::savePassword (   $args,
  $request 
)

Save user's new password.

Definition at line 300 of file PKPLoginHandler.inc.php.

References PKPValidation\login(), LoginChangePasswordForm\readInputData(), and PKPHandler\setupTemplate().

PKPLoginHandler::signIn (   $args,
  $request 
)

Validate a user's credentials and log the user in.

Definition at line 110 of file PKPLoginHandler.inc.php.

References _redirectAfterLogin(), SessionManager\getManager(), Config\getVar(), PKPValidation\login(), PKPValidation\logout(), and PKPHandler\setupTemplate().

PKPLoginHandler::signOut (   $args,
  $request 
)

Log a user out.

Definition at line 158 of file PKPLoginHandler.inc.php.

References PKPValidation\logout(), and PKPHandler\setupTemplate().


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