Let users change their email address. More...

Inheritance diagram for SpecialChangeEmail:

Collaboration diagram for SpecialChangeEmail:

[legend]

Public Member Functions
	__construct ()

	execute ( $par)
	Main execution point. More...

	isListed ()

Public Member Functions inherited from UnlistedSpecialPage
	__construct ( $name, $restriction='', $function=false, $file='default')

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='default', $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...

	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...

	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...

	getFile ()
	Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. 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...

	getLang ()
	Shortcut to get user's language. 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...

	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...

	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...

	requireLogin ( $reasonMsg=null, $titleMsg=null)
	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...

	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...

Protected Member Functions
	attemptChange (User $user, $pass, $newaddr)

	doReturnTo ( $type='hard')

	error ( $msg)

	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...

	pretty ( $fields)

	showForm ()

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...

	getRobotPolicy ()
	Return the robot policy. More...

Protected Attributes
string	$mNewEmail
	Users new email address. More...

string	$mPassword
	Users password. More...

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context. More...

	$mIncludable

	$mIncluding

	$mName

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. More...

Detailed Description

Let users change their email address.

Definition at line 29 of file SpecialChangeEmail.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialChangeEmail::__construct ( )

Definition at line 41 of file SpecialChangeEmail.php.

Member Function Documentation

◆ attemptChange()

SpecialChangeEmail::attemptChange	(	User	$user,
			$pass,
			$newaddr
	)

protected

Parameters

$user	User
$pass	string
$newaddr	string

Returns: bool|string true or string on success, false on failure

Definition at line 221 of file SpecialChangeEmail.php.

References $pass, $user, array(), LoginForm\clearLoginThrottle(), error(), SpecialPage\getLanguage(), SpecialPage\getOutput(), global, LoginForm\incLoginThrottle(), Sanitizer\validateEmail(), and wfRunHooks().

Referenced by execute().

◆ doReturnTo()

SpecialChangeEmail::doReturnTo ( $type = 'hard' )

protected

Parameters

$type string

Definition at line 117 of file SpecialChangeEmail.php.

References $type, SpecialPage\getOutput(), SpecialPage\getRequest(), Title\newFromText(), and Title\newMainPage().

Referenced by execute().

◆ error()

SpecialChangeEmail::error ( $msg )

protected

Parameters

$msg string

Definition at line 132 of file SpecialChangeEmail.php.

References SpecialPage\getOutput().

Referenced by attemptChange(), and execute().

◆ execute()

SpecialChangeEmail::execute ( $par )

Main execution point.

Reimplemented from SpecialPage.

Definition at line 57 of file SpecialChangeEmail.php.

References $out, $user, attemptChange(), SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), doReturnTo(), error(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getUser(), global, SpecialPage\outputHeader(), SpecialPage\requireLogin(), SpecialPage\setHeaders(), and showForm().

◆ getGroupName()

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'.

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 269 of file SpecialChangeEmail.php.

◆ isListed()

SpecialChangeEmail::isListed ( )

Returns: Bool

Reimplemented from UnlistedSpecialPage.

Definition at line 48 of file SpecialChangeEmail.php.

References global.

◆ pretty()

SpecialChangeEmail::pretty ( $fields )

protected

Parameters

$fields array

Returns: string

Definition at line 185 of file SpecialChangeEmail.php.

References $attribs, $name, $out, $type, $value, array(), as, Html\input(), Xml\label(), list, SpecialPage\msg(), and text.

Referenced by showForm().

◆ showForm()

SpecialChangeEmail::showForm ( )

protected

Definition at line 136 of file SpecialChangeEmail.php.

References $user, array(), Xml\closeElement(), Xml\fieldset(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getUser(), global, Html\hidden(), SpecialPage\msg(), Xml\openElement(), pretty(), Xml\submitButton(), and text.

Referenced by execute().

Member Data Documentation

◆ $mNewEmail

string SpecialChangeEmail::$mNewEmail

protected

Users new email address.

Definition at line 39 of file SpecialChangeEmail.php.

◆ $mPassword

string SpecialChangeEmail::$mPassword

protected

Users password.

Definition at line 34 of file SpecialChangeEmail.php.

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

includes/specials/SpecialChangeEmail.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ attemptChange()

◆ doReturnTo()

◆ error()

◆ execute()

◆ getGroupName()

◆ isListed()

◆ pretty()

◆ showForm()

Member Data Documentation

◆ $mNewEmail

◆ $mPassword