MediaWiki  master
SpecialPasswordReset Class Reference

Special page for requesting a password reset email. More...

Inheritance diagram for SpecialPasswordReset:
Collaboration diagram for SpecialPasswordReset:

Public Member Functions

 __construct ()
 
 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 checkExecutePermissions (User $user)
 Called from execute() to check if the given user can perform this action. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $par)
 
 isListed ()
 Hide the password reset page if resets are disabled. More...
 
 onSubmit (array $data)
 Process the form. More...
 
 onSuccess ()
 Show a message on the successful processing of the form. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 
- Public Member Functions inherited from FormSpecialPage
 requiresUnblock ()
 Whether this action cannot be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 
- 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...
 
 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...
 
 getLinkRenderer ()
 
 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...
 
 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...
 
 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 ( $key,... $params)
 Wrapper around wfMessage that sets the current context. 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...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 

Protected Member Functions

 getDisplayFormat ()
 Get display format for the form. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 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...
 
- Protected Member Functions inherited from FormSpecialPage
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getMessagePrefix ()
 Get message prefix for HTMLForm. More...
 
 postText ()
 Add post-text to the form. More...
 
 preText ()
 Add pre-text to the form. More...
 
 setParameter ( $par)
 Maybe do something interesting with the subpage parameter. More...
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication. More...
 
- 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...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 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...
 
 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...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Private Member Functions

 getPasswordReset ()
 

Private Attributes

string $method
 Identifies which password reset field was specified by the user. More...
 
PasswordReset $passwordReset = null
 
Status $result
 

Additional Inherited Members

- 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 If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. 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 FormSpecialPage
string null $par = null
 The sub-page of the special page. More...
 
array null $reauthPostData = null
 POST data preserved across re-authentication. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

Special page for requesting a password reset email.

Requires the TemporaryPasswordPrimaryAuthenticationProvider and the EmailNotificationSecondaryAuthenticationProvider (or something providing equivalent functionality) to be enabled.

Definition at line 35 of file SpecialPasswordReset.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPasswordReset::__construct ( )

Definition at line 49 of file SpecialPasswordReset.php.

Member Function Documentation

◆ alterForm()

SpecialPasswordReset::alterForm ( HTMLForm  $form)

◆ checkExecutePermissions()

SpecialPasswordReset::checkExecutePermissions ( User  $user)

Called from execute() to check if the given user can perform this action.

Failures here must throw subclasses of ErrorPageError.

Parameters
User$user
Exceptions
UserBlockedError

Reimplemented from FormSpecialPage.

Definition at line 68 of file SpecialPasswordReset.php.

References getPasswordReset(), and Status\wrap().

◆ doesWrites()

SpecialPasswordReset::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 60 of file SpecialPasswordReset.php.

◆ execute()

SpecialPasswordReset::execute (   $par)
Parameters
string$par

Reimplemented from FormSpecialPage.

Definition at line 80 of file SpecialPasswordReset.php.

References FormSpecialPage\$par, and SpecialPage\getOutput().

Referenced by onSubmit().

◆ getDisplayFormat()

SpecialPasswordReset::getDisplayFormat ( )
protected

Get display format for the form.

See HTMLForm documentation for available values.

Since
1.25
Returns
string

Reimplemented from FormSpecialPage.

Definition at line 111 of file SpecialPasswordReset.php.

◆ getFormFields()

SpecialPasswordReset::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Returns
array

Reimplemented from FormSpecialPage.

Definition at line 86 of file SpecialPasswordReset.php.

References SpecialPage\getConfig(), SpecialPage\getRequest(), and SpecialPage\getUser().

◆ getGroupName()

SpecialPasswordReset::getGroupName ( )
protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 201 of file SpecialPasswordReset.php.

◆ getPasswordReset()

SpecialPasswordReset::getPasswordReset ( )
private

Definition at line 53 of file SpecialPasswordReset.php.

References $passwordReset.

Referenced by checkExecutePermissions(), isListed(), onSubmit(), and userCanExecute().

◆ isListed()

SpecialPasswordReset::isListed ( )

Hide the password reset page if resets are disabled.

Returns
bool

Reimplemented from SpecialPage.

Definition at line 193 of file SpecialPasswordReset.php.

References getPasswordReset(), and SpecialPage\getUser().

◆ onSubmit()

SpecialPasswordReset::onSubmit ( array  $data)

Process the form.

At this point we know that the user passes all the criteria in userCanExecute(), and if the data array contains 'Username', etc, then Username resets are allowed.

Parameters
array$data
Exceptions
MWException
ThrottledError|PermissionsError
Returns
Status

Reimplemented from FormSpecialPage.

Definition at line 145 of file SpecialPasswordReset.php.

References $result, execute(), getPasswordReset(), SpecialPage\getUser(), and Status\wrap().

◆ onSuccess()

SpecialPasswordReset::onSuccess ( )

Show a message on the successful processing of the form.

This doesn't necessarily mean a reset email was sent.

Reimplemented from FormSpecialPage.

Definition at line 164 of file SpecialPasswordReset.php.

References SpecialPage\getConfig(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\msg(), and wfEscapeWikiText().

◆ userCanExecute()

SpecialPasswordReset::userCanExecute ( User  $user)

Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Can be overridden by sub- classes with more complicated permissions schemes.

Parameters
User$userThe user to check
Returns
bool Does the user have permission to view the page?

Reimplemented from SpecialPage.

Definition at line 64 of file SpecialPasswordReset.php.

References getPasswordReset().

Member Data Documentation

◆ $method

string SpecialPasswordReset::$method
private

Identifies which password reset field was specified by the user.

Definition at line 47 of file SpecialPasswordReset.php.

◆ $passwordReset

PasswordReset SpecialPasswordReset::$passwordReset = null
private

Definition at line 37 of file SpecialPasswordReset.php.

Referenced by getPasswordReset().

◆ $result

Status SpecialPasswordReset::$result
private

Definition at line 42 of file SpecialPasswordReset.php.

Referenced by onSubmit().


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