MediaWiki  1.29.1
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 
63  public function showReturnToPage(
64  $type, $returnTo = '', $returnToQuery = '', $stickHTTPS = false
65  ) {
66  global $wgRedirectOnLogin, $wgSecureLogin;
67 
68  if ( $type !== 'error' && $wgRedirectOnLogin !== null ) {
69  $returnTo = $wgRedirectOnLogin;
70  $returnToQuery = [];
71  } elseif ( is_string( $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 ( $wgSecureLogin && !$stickHTTPS ) {
81  $options = [ 'http' ];
82  $proto = PROTO_HTTP;
83  } elseif ( $wgSecureLogin ) {
84  $options = [ 'https' ];
85  $proto = PROTO_HTTPS;
86  } else {
87  $options = [];
88  $proto = PROTO_RELATIVE;
89  }
90 
91  if ( $type === 'successredirect' ) {
92  $redirectUrl = $returnToTitle->getFullUrlForRedirect( $returnToQuery, $proto );
93  $this->getOutput()->redirect( $redirectUrl );
94  } else {
95  $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
96  }
97  }
98 }
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:34
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:265
$returnToQuery
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string & $returnToQuery
Definition: hooks.txt:2536
Title\newMainPage
static newMainPage()
Create a new Title for the Main Page.
Definition: Title.php:559
$type
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2536
LoginHelper
Helper functions for the login form that need to be shared with other special pages (such as CentralA...
Definition: LoginHelper.php:8
$messages
$messages
Definition: LogTests.i18n.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:35
LoginHelper\$validErrorMessages
static string[] $validErrorMessages
Valid error and warning messages.
Definition: LoginHelper.php:21
ContextSource\getOutput
getOutput()
Get the OutputPage object.
Definition: ContextSource.php:123
ContextSource
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
Definition: ContextSource.php:30
wfCgiToArray
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
Definition: GlobalFunctions.php:453
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
ContextSource\setContext
setContext(IContextSource $context)
Set the IContextSource object.
Definition: ContextSource.php:58
PROTO_HTTPS
const PROTO_HTTPS
Definition: Defines.php:218
LoginHelper\__construct
__construct(IContextSource $context)
Definition: LoginHelper.php:46
PROTO_HTTP
const PROTO_HTTP
Definition: Defines.php:217
PROTO_RELATIVE
const PROTO_RELATIVE
Definition: Defines.php:219
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:55
LoginHelper\showReturnToPage
showReturnToPage( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)
Show a return link or redirect to it.
Definition: LoginHelper.php:63
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
LoginHelper\getValidErrorMessages
static getValidErrorMessages()
Returns an array of all valid error messages.
Definition: LoginHelper.php:36
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1049
$returnTo
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect & $returnTo
Definition: hooks.txt:2536