MediaWiki  master
LoginForm Class Reference

A horrible hack to handle AuthManager's feature flag. More...

Inheritance diagram for LoginForm:
Collaboration diagram for LoginForm:

Public Member Functions

 __call ($name, $args)
 
 __construct ($request=null)
 
 __get ($name)
 
 __set ($name, $value)
 
 checkPermissions ()
 
 checkReadOnly ()
 
 displayRestrictionError ()
 
 doesWrites ()
 
 execute ($subPage)
 
 getConfig ()
 
 getContext ()
 
 getDescription ()
 
 getFinalGroupName ()
 
 getFullTitle ()
 
 getLanguage ()
 
 getLocalName ()
 
 getName ()
 
 getOutput ()
 
 getPageTitle ($subpage=false)
 
 getRequest ()
 
 getRestriction ()
 
 getSkin ()
 
 getTitle ($subpage=false)
 
 getUser ()
 
 including ($x=null)
 
 isCached ()
 
 isExpensive ()
 
 isIncludable ()
 
 isListed ()
 
 isRestricted ()
 
 listed ($x=null)
 
 prefixSearchSubpages ($search, $limit, $offset)
 
 requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
 
 setContext ($context)
 
 setListed ($listed)
 
 userCanExecute (User $user)
 
- Public Member Functions inherited from SpecialPage
 __construct ($name= '', $restriction= '', $listed=true, $function=false, $file= '', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ($to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ($subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ($subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getTitle ($subpage=false)
 Get a self-referential title object. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ($x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ($x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ()
 Wrapper around wfMessage that sets the current context. More...
 
 outputHeader ($summaryMessageKey= '')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchSubpages ($search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ($subPage)
 Entry point. More...
 
 setContext ($context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ($listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Static Public Member Functions

static __callStatic ($name, $args)
 
- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ($name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ($name, $subpage=false, $fragment= '')
 Get a localised Title object for a specified special page name. More...
 

Public Attributes

const ABORTED = 8
 
const CREATE_BLOCKED = 9
 
const EMPTY_PASS = 6
 
const ILLEGAL = 2
 
const NEED_TOKEN = 12
 
const NO_NAME = 1
 
const NOT_EXISTS = 4
 
const RESET_PASS = 7
 
const SUCCESS = 0
 
const THROTTLED = 10
 
const USER_BLOCKED = 11
 
const USER_MIGRATED = 14
 
const WRONG_PASS = 5
 
const WRONG_PLUGIN_PASS = 3
 
const WRONG_TOKEN = 13
 

Static Public Attributes

static $statusCodes
 
static $validErrorMessages
 

Private Attributes

 $realLoginForm
 

Additional Inherited Members

- Protected Member Functions inherited from SpecialPage
 addFeedLinks ($params)
 Adds RSS/atom links. More...
 
 afterExecute ($subPage)
 Gets called after. More...
 
 beforeExecute ($subPage)
 Gets called before. More...
 
 checkLoginSecurityLevel ($level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getLinkRenderer ()
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ($search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ($search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

A horrible hack to handle AuthManager's feature flag.

For other special pages this is done in SpecialPageFactory, but LoginForm is used directly by some extensions. Will be killed as soon as AuthManager is stable.

Definition at line 1350 of file LoginSignupSpecialPage.php.

Constructor & Destructor Documentation

LoginForm::__construct (   $request = null)

Definition at line 1353 of file LoginSignupSpecialPage.php.

References $request, $wgDisableAuthManager, and global.

Member Function Documentation

LoginForm::__call (   $name,
  $args 
)

Definition at line 1372 of file LoginSignupSpecialPage.php.

References $args, and $name.

static LoginForm::__callStatic (   $name,
  $args 
)
static

Definition at line 1376 of file LoginSignupSpecialPage.php.

References $args, $name, $wgDisableAuthManager, class, and global.

LoginForm::__get (   $name)

Definition at line 1364 of file LoginSignupSpecialPage.php.

LoginForm::__set (   $name,
  $value 
)

Definition at line 1368 of file LoginSignupSpecialPage.php.

References $value.

LoginForm::checkPermissions ( )

Definition at line 1423 of file LoginSignupSpecialPage.php.

LoginForm::checkReadOnly ( )

Definition at line 1426 of file LoginSignupSpecialPage.php.

LoginForm::displayRestrictionError ( )

Definition at line 1420 of file LoginSignupSpecialPage.php.

LoginForm::doesWrites ( )

Definition at line 1479 of file LoginSignupSpecialPage.php.

LoginForm::execute (   $subPage)

Definition at line 1437 of file LoginSignupSpecialPage.php.

LoginForm::getConfig ( )

Definition at line 1470 of file LoginSignupSpecialPage.php.

LoginForm::getContext ( )

Definition at line 1452 of file LoginSignupSpecialPage.php.

LoginForm::getDescription ( )

Definition at line 1440 of file LoginSignupSpecialPage.php.

LoginForm::getFinalGroupName ( )

Definition at line 1476 of file LoginSignupSpecialPage.php.

LoginForm::getFullTitle ( )

Definition at line 1473 of file LoginSignupSpecialPage.php.

LoginForm::getLanguage ( )

Definition at line 1467 of file LoginSignupSpecialPage.php.

LoginForm::getLocalName ( )

Definition at line 1405 of file LoginSignupSpecialPage.php.

LoginForm::getName ( )

Definition at line 1384 of file LoginSignupSpecialPage.php.

LoginForm::getOutput ( )

Definition at line 1458 of file LoginSignupSpecialPage.php.

LoginForm::getPageTitle (   $subpage = false)

Definition at line 1446 of file LoginSignupSpecialPage.php.

LoginForm::getRequest ( )

Definition at line 1455 of file LoginSignupSpecialPage.php.

LoginForm::getRestriction ( )

Definition at line 1387 of file LoginSignupSpecialPage.php.

LoginForm::getSkin ( )

Definition at line 1464 of file LoginSignupSpecialPage.php.

LoginForm::getTitle (   $subpage = false)

Definition at line 1443 of file LoginSignupSpecialPage.php.

LoginForm::getUser ( )

Definition at line 1461 of file LoginSignupSpecialPage.php.

LoginForm::including (   $x = null)

Definition at line 1402 of file LoginSignupSpecialPage.php.

LoginForm::isCached ( )

Definition at line 1411 of file LoginSignupSpecialPage.php.

LoginForm::isExpensive ( )

Definition at line 1408 of file LoginSignupSpecialPage.php.

LoginForm::isIncludable ( )

Definition at line 1399 of file LoginSignupSpecialPage.php.

LoginForm::isListed ( )

Definition at line 1390 of file LoginSignupSpecialPage.php.

LoginForm::isRestricted ( )

Definition at line 1414 of file LoginSignupSpecialPage.php.

LoginForm::listed (   $x = null)

Definition at line 1396 of file LoginSignupSpecialPage.php.

LoginForm::prefixSearchSubpages (   $search,
  $limit,
  $offset 
)

Definition at line 1434 of file LoginSignupSpecialPage.php.

LoginForm::requireLogin (   $reasonMsg = 'exception-nologin-text',
  $titleMsg = 'exception-nologin' 
)

Definition at line 1429 of file LoginSignupSpecialPage.php.

LoginForm::setContext (   $context)

Definition at line 1449 of file LoginSignupSpecialPage.php.

LoginForm::setListed (   $listed)

Definition at line 1393 of file LoginSignupSpecialPage.php.

LoginForm::userCanExecute ( User  $user)

Definition at line 1417 of file LoginSignupSpecialPage.php.

Member Data Documentation

LoginForm::$realLoginForm
private

Definition at line 1351 of file LoginSignupSpecialPage.php.

LoginForm::$statusCodes
static
Initial value:
= [
self::SUCCESS => 'success'

Definition at line 1501 of file LoginSignupSpecialPage.php.

Referenced by ApiLogin\execute(), and LoginFormPreAuthManager\processLogin().

LoginForm::$validErrorMessages
static
Initial value:
= [
'exception-nologin-text',
'watchlistanontext',
'changeemail-no-info',
'resetpass-no-info',
'confirmemail_needlogin',
'prefsnologintext2',
]

Definition at line 1519 of file LoginSignupSpecialPage.php.

const LoginForm::CREATE_BLOCKED = 9

The documentation for this class was generated from the following file: