[ticket/14258] Add event into auth::login before session creation

Update comments regarding variables.

PHPBB3-14258
This commit is contained in:
Paul Sohier 2015-10-24 17:47:04 +02:00
parent 7615a5c22f
commit 2a218c2959

View file

@ -984,14 +984,13 @@ class auth
} }
/** /**
* This event is triggered just after the user has been checked if he has a valid username/password, * TEvent is triggered after checking for valid username and password, and before the actual session creation.
* but before the actual session creation.
* *
* @event core.auth_login_before_session_create * @event core.auth_login_session_create_before
* @var array login Variable containing login array value * @var array login Variable containing login array
* @var bool admin Variable containing if is logging into the acp * @var bool admin Boolean variable whether user is logging into the ACP
* @var string username Variable containing the username * @var string username Username of user to log in
* @var bool autologin Variable containing if this is by auto login * @var bool autologin Boolean variable signaling whether login is triggered via auto login
* @since 3.1.7-RC1 * @since 3.1.7-RC1
*/ */
$vars = array( $vars = array(
@ -1000,7 +999,7 @@ class auth
'username', 'username',
'autologin', 'autologin',
); );
extract($phpbb_dispatcher->trigger_event('core.auth_login_before_session_create', compact($vars))); extract($phpbb_dispatcher->trigger_event('core.auth_login_session_create_before', compact($vars)));
// If login succeeded, we will log the user in... else we pass the login array through... // If login succeeded, we will log the user in... else we pass the login array through...
if ($login['status'] == LOGIN_SUCCESS) if ($login['status'] == LOGIN_SUCCESS)