Open Journal Systems
3.3.0
|
Public Member Functions | |
_redirectAfterLogin ($request) | |
_redirectByURL ($request) | |
_setMailFrom ($request, $mail, $site) | |
authorize ($request, &$args, $roleAssignments) | |
changePassword ($args, $request) | |
index ($args, $request) | |
lostPassword ($args, $request) | |
requestResetPassword ($args, $request) | |
resetPassword ($args, $request) | |
savePassword ($args, $request) | |
setupTemplate ($request) | |
signIn ($args, $request) | |
signInAsUser ($args, $request) | |
signOut ($args, $request) | |
signOutAsUser ($args, $request) | |
Public Member Functions inherited from PKPHandler | |
__construct () | |
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) | |
Protected Member Functions | |
sendHome ($request) | |
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 Attributes inherited from PKPHandler | |
$_apiToken = null | |
Handle login/logout requests.
Definition at line 19 of file LoginHandler.inc.php.
LoginHandler::_redirectAfterLogin | ( | $request | ) |
After a login has completed, direct the user somewhere.
$request | PKPRequest |
Definition at line 74 of file LoginHandler.inc.php.
References PKPHandler\getAuthorizedContextObject(), and PKPHandler\getTargetContext().
Referenced by signIn().
LoginHandler::_redirectByURL | ( | $request | ) |
Redirect to redirectURL if exists else send to Home
$request | PKPRequest |
Definition at line 382 of file LoginHandler.inc.php.
References sendHome().
Referenced by signInAsUser(), and signOutAsUser().
LoginHandler::_setMailFrom | ( | $request, | |
$mail, | |||
$site | |||
) |
Helper function - set mail From can be overriden by child classes
$request | PKPRequest | |
MailTemplate | ||
$site | Site |
Definition at line 399 of file LoginHandler.inc.php.
Referenced by requestResetPassword(), and resetPassword().
LoginHandler::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.
$request | Request |
$args | array request arguments |
$roleAssignments | array the operation role assignment, see getRoleAssignment() for more details. |
Reimplemented from PKPHandler.
Definition at line 23 of file LoginHandler.inc.php.
References $op, and PKPHandler\addPolicy().
LoginHandler::changePassword | ( | $args, | |
$request | |||
) |
Display form to change user's password.
$args | array first argument may contain user's username |
Definition at line 274 of file LoginHandler.inc.php.
References PKPTemplateManager\getManager(), and setupTemplate().
LoginHandler::index | ( | $args, | |
$request | |||
) |
Display user login form. Redirect to user index page if user is already validated.
Reimplemented from PKPHandler.
Definition at line 37 of file LoginHandler.inc.php.
References SessionManager\getManager(), PKPTemplateManager\getManager(), Config\getVar(), Validation\isLoggedIn(), PKPString\regexp_replace(), sendHome(), and setupTemplate().
LoginHandler::lostPassword | ( | $args, | |
$request | |||
) |
Display form to reset a user's password.
Definition at line 155 of file LoginHandler.inc.php.
References PKPTemplateManager\getManager(), and setupTemplate().
LoginHandler::requestResetPassword | ( | $args, | |
$request | |||
) |
Send a request to reset a user's password
Definition at line 164 of file LoginHandler.inc.php.
References _setMailFrom(), Validation\generatePasswordResetHash(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), and setupTemplate().
LoginHandler::resetPassword | ( | $args, | |
$request | |||
) |
Reset a user's password
$args | array first param contains the username of the user whose password is to be reset |
Definition at line 203 of file LoginHandler.inc.php.
References _setMailFrom(), Validation\encryptCredentials(), Validation\generatePassword(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), setupTemplate(), and Validation\verifyPasswordResetHash().
LoginHandler::savePassword | ( | $args, | |
$request | |||
) |
Save user's new password.
Definition at line 294 of file LoginHandler.inc.php.
References Validation\login(), sendHome(), and setupTemplate().
|
protected |
Send the user "home" (typically to the dashboard, but that may not always be available).
$request | PKPRequest |
Definition at line 409 of file LoginHandler.inc.php.
Referenced by _redirectByURL(), index(), savePassword(), and signIn().
LoginHandler::setupTemplate | ( | $request | ) |
Configure the template for display.
Reimplemented from PKPHandler.
Definition at line 417 of file LoginHandler.inc.php.
References AppLocale\requireComponents().
Referenced by changePassword(), index(), lostPassword(), requestResetPassword(), resetPassword(), savePassword(), signIn(), signInAsUser(), and signOut().
LoginHandler::signIn | ( | $args, | |
$request | |||
) |
Validate a user's credentials and log the user in.
Definition at line 90 of file LoginHandler.inc.php.
References _redirectAfterLogin(), SessionManager\getManager(), PKPTemplateManager\getManager(), Config\getVar(), Validation\isLoggedIn(), Validation\login(), Validation\logout(), sendHome(), and setupTemplate().
LoginHandler::signInAsUser | ( | $args, | |
$request | |||
) |
Sign in as another user.
$args | array ($userId) |
$request | PKPRequest |
Definition at line 317 of file LoginHandler.inc.php.
References _redirectByURL(), Validation\canAdminister(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), and setupTemplate().
LoginHandler::signOut | ( | $args, | |
$request | |||
) |
Log a user out.
Definition at line 138 of file LoginHandler.inc.php.
References Validation\isLoggedIn(), Validation\logout(), and setupTemplate().
LoginHandler::signOutAsUser | ( | $args, | |
$request | |||
) |
Restore original user account after signing in as a user.
$args | array |
$request | PKPRequest |
Definition at line 356 of file LoginHandler.inc.php.
References _redirectByURL(), and DAORegistry\getDAO().