1	<?php
2	/**
3	* MediaWiki\Session\Provider interface
4	*
5	* This program is free software; you can redistribute it and/or modify
6	* it under the terms of the GNU General Public License as published by
7	* the Free Software Foundation; either version 2 of the License, or
8	* (at your option) any later version.
9	*
10	* This program is distributed in the hope that it will be useful,
11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13	* GNU General Public License for more details.
14	*
15	* You should have received a copy of the GNU General Public License along
16	* with this program; if not, write to the Free Software Foundation, Inc.,
17	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18	* http://www.gnu.org/copyleft/gpl.html
19	*
20	* @file
21	* @ingroup Session
22	*/
23
24	namespace MediaWiki\Session;
25
26	use MediaWiki\Language\Language;
27	use MediaWiki\Message\Message;
28
29	/**
30	* This exists to make IDEs happy, so they don't see the
31	* internal-but-required-to-be-public methods on SessionProvider.
32	*
33	* @ingroup Session
34	* @since 1.27
35	*/
36	interface SessionProviderInterface {
37
38	/**
39	* Return an identifier for this session type
40	*
41	* @param Language $lang Language to use.
42	* @return string
43	*/
44	public function describe( Language $lang );
45
46	/**
47	* Return a Message for why sessions might not be being persisted.
48	*
49	* For example, "check whether you're blocking our cookies".
50	*
51	* @return Message|null
52	*/
53	public function whyNoSession();
54
55	/**
56	* Returns true if this provider is safe against csrf attacks, or false otherwise
57	*
58	* @return bool
59	*/
60	public function safeAgainstCsrf();
61
62	/**
63	* Returns true if this provider is exempt from autocreate user permissions check.
64	*
65	* @return bool
66	* @since 1.42
67	*/
68	public function canAlwaysAutocreate(): bool;
69	}