LoginController Class Reference
Detailed Description
LoginController handles the login process.
The controller supports the following actions:
Action login
Try to login the user with the given user/password parameters.
| Parameter | Description |
|---|---|
in user | The login of the user to log in |
in password | The password the user is authenticated with |
out sid | The newly established session id |
out roles | Array of role names assigned to the logged in user |
| Response Actions | |
ok | If login succeeded |
Action logout
Terminate the user session.
Definition at line 55 of file LoginController.php.
Inheritance diagram for LoginController:Public Member Functions | |
| __construct (Session $session, PersistenceFacade $persistenceFacade, PermissionManager $permissionManager, ActionMapper $actionMapper, Localization $localization, Message $message, Configuration $configuration, AuthenticationManager $authenticationManager) | |
| initialize (Request $request, Response $response) | |
| Public Member Functions inherited from Controller | |
| __construct (Session $session, PersistenceFacade $persistenceFacade, PermissionManager $permissionManager, ActionMapper $actionMapper, Localization $localization, Message $message, Configuration $configuration) | |
| execute ($method=null) | |
| getRequest () | |
| getResponse () | |
Protected Member Functions | |
| validate () | |
| doExecute ($method=null) | |
| Protected Member Functions inherited from Controller | |
| executeSubAction ($action) | |
| redirect ($location, $key=null, $data=null) | |
| getLogger () | |
| getSession () | |
| getPersistenceFacade () | |
| getPermissionManager () | |
| getActionMapper () | |
| getLocalization () | |
| getMessage () | |
| getConfiguration () | |
| requireTransaction () | |
| endTransaction ($commit) | |
| isLocalizedRequest () | |
| checkLanguageParameter () | |
| generateCsrfToken ($name, $refresh=true) | |
| validateCsrfToken ($name, $invalidate=true) | |
| getLocalSessionValue ($key, $default=null) | |
| setLocalSessionValue ($key, $value) | |
| clearLocalSessionValues () | |
Additional Inherited Members | |
| Public Attributes inherited from Controller | |
| const | CSRF_TOKEN_PARAM = 'csrf_token' |
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | Session | $session, |
| PersistenceFacade | $persistenceFacade, | ||
| PermissionManager | $permissionManager, | ||
| ActionMapper | $actionMapper, | ||
| Localization | $localization, | ||
| Message | $message, | ||
| Configuration | $configuration, | ||
| AuthenticationManager | $authenticationManager | ||
| ) |
Constructor.
- Parameters
-
$session $persistenceFacade $permissionManager $actionMapper $localization $message $configuration $authenticationManager
Definition at line 70 of file LoginController.php.
Member Function Documentation
◆ initialize()
- See also
- Controller::initialize()
Reimplemented from Controller.
Definition at line 86 of file LoginController.php.
◆ validate()
|
protected |
- See also
- Controller::validate()
Reimplemented from Controller.
Definition at line 98 of file LoginController.php.
◆ doExecute()
|
protected |
- See also
- Controller::doExecute()
Reimplemented from Controller.
Definition at line 122 of file LoginController.php.