Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2/**
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
17 *
18 * @file
19 */
20
21namespace MediaWiki\Extension\CentralAuth\Hooks;
22
23use MediaWiki\Extension\CentralAuth\User\CentralAuthUser;
24
25/**
26 * This is a hook handler interface, see docs/Hooks.md in core.
27 * Use the hook name "CentralAuthLoginRedirectData" to register handlers implementing this interface.
28 *
29 * @stable to implement
30 * @ingroup Hooks
31 * @author Taavi "Majavah" Väänänen
32 */
33interface CentralAuthLoginRedirectDataHook {
34    /**
35     * This hook is called after a user has logged in to a single wiki during the login process,
36     * when saving any required data to the token store before redirecting to the login wiki.
37     *
38     * @param CentralAuthUser $centralAuthUser User logging in
39     * @param array &$data Data stored on the token store that can be used on the login wiki.
40     *
41     * @return bool|void True or no return value to continue or false to abort
42     * @since 1.39
43     */
44    public function onCentralAuthLoginRedirectData( CentralAuthUser $centralAuthUser, array &$data );
45}