wCMF  3.6
 All Classes Namespaces Files Functions Variables Groups Pages
LoginController Class Reference
+ Inheritance diagram for LoginController:

Public Member Functions

 initialize (&$request, &$response)
 
 validate ()
 
 hasView ()
 
 executeKernel ()
 
 isCookieLogin ()
 
- Public Member Functions inherited from Controller
 Controller (&$delegate)
 
 initialize (&$request, &$response)
 
 validate ()
 
 hasView ()
 
 execute ()
 
 executeKernel ()
 
 getErrorMsg ()
 
 setErrorMsg ($msg)
 
 appendErrorMsg ($msg)
 
getRequest ()
 
getResponse ()
 
getView ()
 
getDelegate ()
 
 getViewTemplate ($controller, $context, $action)
 
 getCacheId ()
 
 assignViewDefaults (&$view)
 
 isLocalizedRequest ()
 

Public Attributes

 $_anonymous = 0
 
 $NUM_LOGINTRIES_VARNAME = 'LoginController.logintries'
 
 $LOGINMESSAGE_VARNAME = 'LoginController.loginmessage'
 
- Public Attributes inherited from Controller
 $_request = null
 
 $_response = null
 
 $_errorMsg = ''
 
 $_view = null
 
 $_delegate = null
 

Detailed Description

LoginController is a controller that handles the login process.

wCMF - wemove Content Management Framework Copyright (C) 2005-2014 wemove digital solutions GmbH

Licensed under the terms of any of the following licenses at your choice:

See the license.txt file distributed with this work for additional information.

Id:
class.LoginController.php 1462 2014-02-04 23:52:27Z iherwig

Input actions:

  • login Present the login dialog
  • dologin Try to login the user with the given credentials
  • logout Terminate the user session

Output actions:

  • ok If login succeeded
  • login If login failed
Parameters
[in]loginThe users login name
[in]passwordThe user's password
[in]remember_meIf given with any value a login cookie will be created in the browser
[in]password_is_encryptedTrue/False wether the given password is encrypted on not (default: false)
[out]loginmessageA message if login failed
Author
ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 48 of file class.LoginController.php.

Member Function Documentation

LoginController::initialize ( $request,
$response 
)
See Also
Controller::initialize()

Definition at line 59 of file class.LoginController.php.

References InifileParser\getInstance().

+ Here is the call graph for this function:

LoginController::validate ( )
See Also
Controller::validate()

Definition at line 73 of file class.LoginController.php.

References $_anonymous, and Controller\setErrorMsg().

+ Here is the call graph for this function:

LoginController::hasView ( )
See Also
Controller::hasView()

Definition at line 93 of file class.LoginController.php.

References isCookieLogin().

+ Here is the call graph for this function:

LoginController::executeKernel ( )

If called with any usr_action except 'dologin' this Controller presents the login dialog else if usr_action is 'dologin' it checks the login data ('login' & 'password') and creates AuthUser object in the Session on success.

Returns
Array of given context and action 'ok' on success, action 'failure' on failure. False if the login dialog is presented (Stop action processing chain). In case of 'failure' a detailed description is provided by getErrorMsg().
See Also
Controller::executeKernel()

Definition at line 109 of file class.LoginController.php.

References UserManager\encryptPassword(), Message\get(), RightsManager\getAuthUserVarname(), Controller\getErrorMsg(), LockManager\getInstance(), SessionData\getInstance(), isCookieLogin(), MSG_FORMAT_HTML, and Controller\setErrorMsg().

+ Here is the call graph for this function:

LoginController::isCookieLogin ( )

Check if the user logs in via cookies

Returns
True/False

Definition at line 225 of file class.LoginController.php.

Referenced by executeKernel(), and hasView().

Member Data Documentation

LoginController::$_anonymous = 0

Definition at line 50 of file class.LoginController.php.

Referenced by validate().

LoginController::$NUM_LOGINTRIES_VARNAME = 'LoginController.logintries'

Definition at line 53 of file class.LoginController.php.

LoginController::$LOGINMESSAGE_VARNAME = 'LoginController.loginmessage'

Definition at line 54 of file class.LoginController.php.


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