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 ) {
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 }
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
Title\newMainPage
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:586
LoginHelper
Helper functions for the login form that need to be shared with other special pages (such as CentralA...
Definition: LoginHelper.php:8
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
LoginHelper\$validErrorMessages
static string[] $validErrorMessages
Valid error and warning messages.
Definition: LoginHelper.php:21
ContextSource\getOutput
getOutput()
Definition: ContextSource.php:112
ContextSource
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
Definition: ContextSource.php:29
wfCgiToArray
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
Definition: GlobalFunctions.php:422
ContextSource\setContext
setContext(IContextSource $context)
Definition: ContextSource.php:55
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:230
$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
LoginHelper\__construct
__construct(IContextSource $context)
Definition: LoginHelper.php:46
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
LoginHelper\showReturnToPage
showReturnToPage( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)
Show a return link or redirect to it.
Definition: LoginHelper.php:64
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
LoginHelper\getValidErrorMessages
static getValidErrorMessages()
Returns an array of all valid error messages.
Definition: LoginHelper.php:36
$messages
$messages
Definition: LogTests.i18n.php:8
$type
$type
Definition: testCompression.php:48