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	/**
24	* This is a hook handler interface, see docs/Hooks.md in core.
25	* Use the hook name "CentralAuthPostLoginRedirect" to register handlers implementing this interface.
26	*
27	* @stable to implement
28	* @ingroup Hooks
29	* @author Taavi "Majavah" Väänänen
30	*/
31	interface CentralAuthPostLoginRedirectHook {
32	/**
33	* This hook is called after the user has been redirected back to
34	* the content wiki after completing the cross-wiki login process.
35	*
36	* @param string &$returnTo page name to redirect to
37	* @param string &$returnToQuery url parameters
38	* @param bool $stickHTTPS Deprecated since MW 1.42, do not use.
39	*   Previously indicated that the login session would force the HTTPS protocol.
40	* @param string $type 'signup' on signup, empty string otherwise.
41	* @param string &$injectedHtml Deprecated since MW 1.42, do not use.
42	*   Previously allowed setting HTML to show on the login success page.
43	*
44	* @return bool|void True or no return value to continue or false to abort
45	* @since 1.39
46	*/
47	public function onCentralAuthPostLoginRedirect(
48	string &$returnTo,
49	string &$returnToQuery,
50	bool $stickHTTPS,
51	string $type,
52	string &$injectedHtml
53	);
54	}