MediaWiki master
MediaWiki\Specials\SpecialChangeEmail Class Reference

Let users change their email address. More...

Inherits MediaWiki\SpecialPage\FormSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialChangeEmail:

Public Member Functions

 __construct (AuthManager $authManager)
 
 doesWrites ()
 Indicates whether POST requests to this special page require write access to the wiki.
 
 execute ( $par)
 Main execution point.
 
 isListed ()
 
 onSubmit (array $data)
 Process the form on submission.
 
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message.
 
 requiresUnblock ()
 Whether this action cannot be executed by a blocked user, default to requiresPost()
 
- Public Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage
 requiresPost ()
 Whether this action should using POST method to submit, default to true.
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked, default to requiresPost()
 
- Public Member Functions inherited from MediaWiki\SpecialPage\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.
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators.
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError.
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError.
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContentLanguage ()
 Shortcut to get content language.
 
 getContext ()
 Gets the context this SpecialPage is executed in.
 
 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.
 
 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.
 
 getFullTitle ()
 Return the full title, including $par.
 
 getLanguage ()
 Shortcut to get user's language.
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page.
 
 getName ()
 Get the canonical, unlocalized name of this special page without namespace.
 
 getOutput ()
 Get the OutputPage being used for this instance.
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object.
 
 getRequest ()
 Get the WebRequest being used for this instance.
 
 getRestriction ()
 Get the permission that a user must have to execute this page.
 
 getShortDescription (string $path='')
 Similar to getDescription, but takes into account subpages and designed for display in tabs.
 
 getSkin ()
 Shortcut to get the skin being used for this instance.
 
 getUser ()
 Shortcut to get the User executing this instance.
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion.
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode.
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes.
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included.
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context.
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept.
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error.
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false)
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn.
 
 run ( $subPage)
 Entry point.
 
 setContentLanguage (Language $contentLanguage)
 Set content language.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
 

Protected Member Functions

 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially.
 
 checkExecutePermissions (User $user)
 Called from execute() to check if the given user can perform this action.
 
 getDisplayFormat ()
 Get display format for the form.
 
 getFormFields ()
 Get an HTMLForm descriptor array.
 
 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'.
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage
 getForm ()
 Get the HTMLForm to control behavior.
 
 getMessagePrefix ()
 Get message prefix for HTMLForm.
 
 getShowAlways ()
 Whether the form should always be shown despite the success of submission.
 
 getSubpageField ()
 Override this function to set the field name used in the subpage syntax.
 
 postHtml ()
 Add post-HTML to the form.
 
 postText ()
 Add post-text to the form.
 
 preHtml ()
 Add pre-HTML to the form.
 
 preText ()
 Add pre-text to the form.
 
 setParameter ( $par)
 Maybe do something interesting with the subpage parameter.
 
 setReauthPostData (array $data)
 Preserve POST data across reauthentication.
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 authorizeAction (?string $action=null)
 Utility function for authorizing an action to be performed by the special page.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getRobotPolicy ()
 Return the robot policy.
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e.
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages.
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage.
 
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.
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name.
 
static newSearchPage (User $user)
 Get the users preferred search page.
 
- Static Protected Member Functions inherited from MediaWiki\SpecialPage\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).
 
- Protected Attributes inherited from MediaWiki\SpecialPage\FormSpecialPage
string null $par = null
 The subpage of the special page.
 
array null $reauthPostData = null
 POST data preserved across re-authentication.
 
- Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
bool $mIncluding
 Whether or not this special page is being included from an article.
 
string $mName
 The canonical name of this special page Also used as the message key for the default.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Detailed Description

Let users change their email address.

Definition at line 40 of file SpecialChangeEmail.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialChangeEmail::__construct ( AuthManager $authManager)
Parameters
AuthManager$authManager

Definition at line 49 of file SpecialChangeEmail.php.

References MediaWiki\SpecialPage\SpecialPage\setAuthManager().

Member Function Documentation

◆ alterForm()

◆ checkExecutePermissions()

MediaWiki\Specials\SpecialChangeEmail::checkExecutePermissions ( User $user)
protected

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 MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 81 of file SpecialChangeEmail.php.

References MediaWiki\SpecialPage\SpecialPage\getAuthManager(), MediaWiki\SpecialPage\SpecialPage\getAuthority(), and MediaWiki\SpecialPage\SpecialPage\requireNamedUser().

◆ doesWrites()

MediaWiki\Specials\SpecialChangeEmail::doesWrites ( )

Indicates whether POST requests to this special page require write access to the wiki.

Subclasses must override this method to return true if any of the operations that they perform on POST requests are not "safe" per RFC 7231 section 4.2.1. A subclass's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

When handling GET/HEAD requests, subclasses should only perform "safe" operations. Note that some subclasses might only perform "safe" operations even for POST requests, particularly in the case where large input parameters are required.

Stability: stable
to override
Returns
bool
Since
1.27

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 55 of file SpecialChangeEmail.php.

◆ execute()

MediaWiki\Specials\SpecialChangeEmail::execute ( $par)

Main execution point.

Parameters
string | null$par

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 70 of file SpecialChangeEmail.php.

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

◆ getDisplayFormat()

MediaWiki\Specials\SpecialChangeEmail::getDisplayFormat ( )
protected

Get display format for the form.

See HTMLForm documentation for available values.

Since
1.25
Returns
string

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 121 of file SpecialChangeEmail.php.

◆ getFormFields()

MediaWiki\Specials\SpecialChangeEmail::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Returns
array

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 97 of file SpecialChangeEmail.php.

References MediaWiki\SpecialPage\SpecialPage\getUser(), and MediaWiki\SpecialPage\SpecialPage\msg().

◆ getGroupName()

MediaWiki\Specials\SpecialChangeEmail::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'.

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 221 of file SpecialChangeEmail.php.

◆ getLoginSecurityLevel()

MediaWiki\Specials\SpecialChangeEmail::getLoginSecurityLevel ( )
protected

Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

a reauthentication). What exactly that will mean is decided by the authentication framework.

Stability: stable
to override
Returns
string|false False or the argument for AuthManager::securitySensitiveOperationStatus(). Typically a special page needing elevated security would return its name here.

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 77 of file SpecialChangeEmail.php.

References MediaWiki\SpecialPage\SpecialPage\getName().

◆ isListed()

MediaWiki\Specials\SpecialChangeEmail::isListed ( )
Returns
bool

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 62 of file SpecialChangeEmail.php.

References MediaWiki\SpecialPage\SpecialPage\getAuthManager().

◆ onSubmit()

MediaWiki\Specials\SpecialChangeEmail::onSubmit ( array $data)

Process the form on submission.

@phpcs:disable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Parameters
array$data
HTMLForm | null$form
Returns
bool|string|array|Status As documented for HTMLForm::trySubmit. @phpcs:enable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 135 of file SpecialChangeEmail.php.

References MediaWiki\SpecialPage\SpecialPage\getUser().

◆ onSuccess()

MediaWiki\Specials\SpecialChangeEmail::onSuccess ( )

Do something exciting on successful processing of the form, most likely to show a confirmation message.

Since
1.22 Default is to do nothing

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 141 of file SpecialChangeEmail.php.

References MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getRequest(), and wfCgiToArray().

◆ requiresUnblock()

MediaWiki\Specials\SpecialChangeEmail::requiresUnblock ( )

Whether this action cannot be executed by a blocked user, default to requiresPost()

Returns
bool

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 217 of file SpecialChangeEmail.php.


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