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
21	namespace MediaWiki\Extension\CentralAuth\Hooks;
22
23	use MediaWiki\User\User;
24
25	/**
26	* This is a hook handler interface, see docs/Hooks.md in core.
27	* Use the hook name "CentralAuthIsUIReloadRecommended" to register handlers implementing this interface.
28	*
29	* @stable to implement
30	* @ingroup Hooks
31	* @author Taavi "Majavah" Väänänen
32	*/
33	interface CentralAuthIsUIReloadRecommendedHook {
34	/**
35	* This hook is called after a cross-wiki auto login to figure out
36	* if the users preferences are customized enough that they should
37	* refresh the page for the preferences to take effect.
38	*
39	* @param User $user The user logging in.
40	* @param bool &$recommendReload Set to true if the user should be recommended
41	* to reload the page.
42	*
43	* @return bool|void True or no return value to continue or false to abort
44	* @since 1.39
45	*/
46	public function onCentralAuthIsUIReloadRecommended( User $user, bool &$recommendReload );
47	}