MediaWiki
REL1_31
LoginHelper.php
Go to the documentation of this file.
1
<?php
2
8
class
LoginHelper
extends
ContextSource
{
21
public
static
$validErrorMessages
= [
22
'exception-nologin-text'
,
23
'watchlistanontext'
,
24
'changeemail-no-info'
,
25
'resetpass-no-info'
,
26
'confirmemail_needlogin'
,
27
'prefsnologintext2'
,
28
];
29
36
public
static
function
getValidErrorMessages
() {
37
static
$messages
=
null
;
38
if
( !
$messages
) {
39
$messages
=
self::$validErrorMessages
;
40
Hooks::run(
'LoginFormValidErrorMessages'
, [ &
$messages
] );
41
}
42
43
return
$messages
;
44
}
45
46
public
function
__construct
(
IContextSource
$context
) {
47
$this->
setContext
( $context );
48
}
49
64
public
function
showReturnToPage
(
65
$type
, $returnTo =
''
, $returnToQuery =
''
, $stickHTTPS =
false
66
) {
67
$config = $this->
getConfig
();
68
if
(
$type
!==
'error'
&& $config->get(
'RedirectOnLogin'
) !==
null
) {
69
$returnTo = $config->get(
'RedirectOnLogin'
);
70
$returnToQuery = [];
71
} elseif ( is_string( $returnToQuery ) ) {
72
$returnToQuery =
wfCgiToArray
( $returnToQuery );
73
}
74
75
// Allow modification of redirect behavior
76
Hooks::run(
'PostLoginRedirect'
, [ &$returnTo, &$returnToQuery, &
$type
] );
77
78
$returnToTitle = Title::newFromText( $returnTo ) ?: Title::newMainPage();
79
80
if
( $config->get(
'ForceHTTPS'
)
81
|| ( $config->get(
'SecureLogin'
) && $stickHTTPS )
82
) {
83
$options
= [
'https'
];
84
$proto =
PROTO_HTTPS
;
85
} elseif ( $config->get(
'SecureLogin'
) && !$stickHTTPS ) {
86
$options
= [
'http'
];
87
$proto =
PROTO_HTTP
;
88
}
else
{
89
$options
= [];
90
$proto =
PROTO_RELATIVE
;
91
}
92
93
if
(
$type
===
'successredirect'
) {
94
$redirectUrl = $returnToTitle->getFullUrlForRedirect( $returnToQuery, $proto );
95
$this->
getOutput
()->redirect( $redirectUrl );
96
}
else
{
97
$this->
getOutput
()->addReturnTo( $returnToTitle, $returnToQuery,
null
,
$options
);
98
}
99
}
100
}
wfCgiToArray
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
Definition
GlobalFunctions.php:422
$messages
$messages
Definition
LogTests.i18n.php:8
ContextSource
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
Definition
ContextSource.php:29
ContextSource\getConfig
getConfig()
Definition
ContextSource.php:63
ContextSource\getOutput
getOutput()
Definition
ContextSource.php:112
ContextSource\$context
IContextSource $context
Definition
ContextSource.php:33
ContextSource\setContext
setContext(IContextSource $context)
Definition
ContextSource.php:55
LoginHelper
Helper functions for the login form that need to be shared with other special pages (such as CentralA...
Definition
LoginHelper.php:8
LoginHelper\getValidErrorMessages
static getValidErrorMessages()
Returns an array of all valid error messages.
Definition
LoginHelper.php:36
LoginHelper\__construct
__construct(IContextSource $context)
Definition
LoginHelper.php:46
LoginHelper\$validErrorMessages
static string[] $validErrorMessages
Valid error and warning messages.
Definition
LoginHelper.php:21
LoginHelper\showReturnToPage
showReturnToPage( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)
Show a return link or redirect to it.
Definition
LoginHelper.php:64
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition
hooks.txt:2001
PROTO_HTTPS
const PROTO_HTTPS
Definition
Defines.php:230
PROTO_HTTP
const PROTO_HTTP
Definition
Defines.php:229
PROTO_RELATIVE
const PROTO_RELATIVE
Definition
Defines.php:231
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition
IContextSource.php:53
$type
$type
Definition
testCompression.php:48
includes
specials
helpers
LoginHelper.php
Generated on Mon Nov 25 2024 15:35:23 for MediaWiki by
1.10.0