Special change to change credentials (such as the password). More...

Inheritance diagram for SpecialChangeCredentials:

[legend]

Collaboration diagram for SpecialChangeCredentials:

[legend]

Public Member Functions

__construct ( $name='ChangeCredentials')

doesWrites ()

Indicates whether this special page may perform database writes.

execute ( $subPage)

Default execute method Checks user permissions.

handleFormSubmit ( $data)

Submit handler callback for HTMLForm.

isListed ()

Whether this special page is listed in Special:SpecialPages Stable to override.

onAuthChangeFormFields (array $requests, array $fieldInfo, array &$formDescriptor, $action)

Change the form descriptor that determines how a field will look in the authentication form.Called from fieldInfoToFormDescriptor(). Stable to override

Parameters

AuthenticationRequest[]	$requests
array	$fieldInfo	Field information array (union of all AuthenticationRequest::getFieldInfo() responses).
array	&$formDescriptor	HTMLForm descriptor. The special key 'weight' can be set to change the order of the fields.
string	$action	Authentication type (one of the AuthManager::ACTION_* constants)

Public Member Functions inherited from AuthManagerSpecialPage

getRequest ()

Get the WebRequest being used for this instance.

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.

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.

getConfig ()

Shortcut to get main config object.

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 Stable to override.

getName ()

Get the name of this Special Page.

getOutput ()

Get the OutputPage being used for this instance.

getPageTitle ( $subpage=false)

Get a self-referential title object.

getRestriction ()

Get the permission that a user must have to execute this page.

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}} Stable to override.

isRestricted ()

Can be overridden by subclasses with more complicated permissions schemes.

listed ( $x=null)

Get or set whether this special page is listed in Special:SpecialPages.

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.

run ( $subPage)

Entry point.

setContext ( $context)

Sets the context this SpecialPage is executed in.

setHookContainer (HookContainer $hookContainer)

setLinkRenderer (LinkRenderer $linkRenderer)

setListed ( $listed)

Set whether this page is listed in Special:Specialpages, at run-time.

userCanExecute (User $user)

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

Protected Member Functions
	getAuthForm (array $requests, $action)
	Stable to override.

	getAuthFormDescriptor ( $requests, $action)
	Generates a HTMLForm descriptor array from a set of authentication requests.

	getDefaultAction ( $subPage)
	Get the default action for this special page, if none is given via URL/POST data.

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

	getPreservedParams ( $withToken=false)
	Returns URL query parameters which can be used to reload the page (or leave and return) while preserving all information that is necessary for authentication to continue.

	getRequestBlacklist ()
	Allows blacklisting certain request types.

	getReturnUrl ()

	loadAuth ( $subPage, $authAction=null, $reset=false)
	Load or initialize $authAction, $authRequests and $subPage.

	needsSubmitButton (array $requests)
	Returns true if the form built from the given AuthenticationRequests needs a submit button.

	showSubpageList ( $error=null)

	success ()

Protected Member Functions inherited from AuthManagerSpecialPage
	addTabIndex (&$formDescriptor)
	Adds a sequential tabindex starting from 1 to all form elements.

	beforeExecute ( $subPage)
	Stable to override.

	displayForm ( $status)
	Display the form.

	fieldInfoToFormDescriptor (array $requests, array $fieldInfo, $action)
	Turns a field info array into a form descriptor.

	getContinueAction ( $action)
	Gets the _CONTINUE version of an action.

	getLoginSecurityLevel ()
	Stable to override.

	getToken ()
	Returns the CSRF token.

	getTokenName ()
	Returns the name of the CSRF token (under which it should be found in the POST or GET data).

	handleReauthBeforeExecute ( $subPage)
	Handle redirection when the user needs to (re)authenticate.

	handleReturnBeforeExecute ( $subPage)
	Handle redirection from the /return subpage.

	hasOwnSubmitButton (AuthenticationRequest $req)
	Checks whether the given AuthenticationRequest has its own submit button.

	isActionAllowed ( $action)
	Checks whether AuthManager is ready to perform the action.

	isContinued ()
	Returns true if this is not the first step of the authentication.

	messageKey ( $defaultKey)
	Return custom message key.

	performAuthenticationStep ( $action, array $requests)

	setRequest (array $data, $wasPosted=null)
	Override the POST data, GET data from the real request is preserved.

	trySubmit ()
	Attempts to do an authentication step with the submitted data.

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	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 Stable to override.

	getCacheTTL ()
	Stable to override.

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	getRobotPolicy ()
	Return the robot policy.

	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 Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes! Stable to override.

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Static Protected Attributes
static	$allowedActions = [ AuthManager::ACTION_CHANGE ]

static	$loadUserData = true
	Change action needs user data; remove action does not.

static	$messagePrefix = 'changecredentials'

Static Protected Attributes inherited from AuthManagerSpecialPage
static string[]	$allowedActions
	The list of actions this special page deals with.

static array	$messages = []
	Customized messages.

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.

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 Protected Member Functions inherited from AuthManagerSpecialPage
static	getField (array $array, $fieldName, $default=null)
	Get an array value, or a default if it does not exist.

static	mapFieldInfoTypeToFormDescriptorType ( $type)
	Maps AuthenticationRequest::getFieldInfo() types to HTMLForm types.

static	mapSingleFieldInfo ( $singleFieldInfo, $fieldName)
	Maps an authentication field configuration for a single field (as returned by AuthenticationRequest::getFieldInfo()) to a HTMLForm field descriptor.

static	mergeDefaultFormDescriptor (array $fieldInfo, array $formDescriptor, array $defaultFormDescriptor)
	Apply defaults to a form descriptor, without creating non-existend fields.

static	sortFormDescriptorFields (array &$formDescriptor)
	Sort the fields of a form descriptor by their 'weight' property.

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

Protected Attributes inherited from AuthManagerSpecialPage
string	$authAction
	one of the AuthManager::ACTION_* constants.

AuthenticationRequest[]	$authRequests

bool	$isReturn
	True if the current request is a result of returning from a redirect flow.

WebRequest null	$savedRequest
	If set, will be used instead of the real request.

string	$subPage
	Subpage of the special page.

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

Special change to change credentials (such as the password).

Also does most of the work for SpecialRemoveCredentials.

Definition at line 14 of file SpecialChangeCredentials.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialChangeCredentials::__construct ( $name = 'ChangeCredentials' )

Definition at line 22 of file SpecialChangeCredentials.php.

Member Function Documentation

◆ doesWrites()

SpecialChangeCredentials::doesWrites ( )

Indicates whether this special page may perform database writes.

Stable to override

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 35 of file SpecialChangeCredentials.php.

◆ execute()

SpecialChangeCredentials::execute ( $subPage )

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stable to override

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 53 of file SpecialChangeCredentials.php.

References AuthManagerSpecialPage\$subPage, AuthManagerSpecialPage\displayForm(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), loadAuth(), SpecialPage\msg(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), showSubpageList(), success(), and AuthManagerSpecialPage\trySubmit().

◆ getAuthForm()

SpecialChangeCredentials::getAuthForm	(	array	$requests,
			$action )

protected

Stable to override.

Parameters

AuthenticationRequest[]	$requests
string	$action	AuthManager action name (one of the AuthManager::ACTION_* constants)

Returns: HTMLForm

Reimplemented from AuthManagerSpecialPage.

Definition at line 159 of file SpecialChangeCredentials.php.

References getReturnUrl(), and SpecialPage\msg().

◆ getAuthFormDescriptor()

SpecialChangeCredentials::getAuthFormDescriptor	(		$requests,
			$action )

protected

Generates a HTMLForm descriptor array from a set of authentication requests.

Stable to override

Parameters

AuthenticationRequest[]	$requests
string	$action	AuthManager action name (one of the AuthManager::ACTION_* constants)

Returns: array[]

Reimplemented from AuthManagerSpecialPage.

Definition at line 133 of file SpecialChangeCredentials.php.

References SpecialPage\getOutput().

◆ getDefaultAction()

SpecialChangeCredentials::getDefaultAction ( $subPage )

protected

Get the default action for this special page, if none is given via URL/POST data.

Subclasses should override this (or override loadAuth() so this is never called). Stable to override

Parameters

string $subPage Subpage of the special page.

Returns: string an AuthManager::ACTION_* constant.

Reimplemented from AuthManagerSpecialPage.

Reimplemented in SpecialRemoveCredentials.

Definition at line 39 of file SpecialChangeCredentials.php.

◆ getGroupName()

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

Stable to override

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 26 of file SpecialChangeCredentials.php.

◆ getPreservedParams()

SpecialChangeCredentials::getPreservedParams ( $withToken = false )

protected

Returns URL query parameters which can be used to reload the page (or leave and return) while preserving all information that is necessary for authentication to continue.

These parameters will be preserved in the action URL of the form and in the return URL for redirect flow. Stable to override

Parameters

bool $withToken Include CSRF token

Returns: array

Reimplemented from AuthManagerSpecialPage.

Definition at line 43 of file SpecialChangeCredentials.php.

References AuthManagerSpecialPage\getRequest().

◆ getRequestBlacklist()

SpecialChangeCredentials::getRequestBlacklist ( )

protected

Allows blacklisting certain request types.

Stable to override

Returns: array A list of AuthenticationRequest subclass names

Reimplemented from AuthManagerSpecialPage.

Reimplemented in SpecialRemoveCredentials.

Definition at line 270 of file SpecialChangeCredentials.php.

References SpecialPage\getConfig().

◆ getReturnUrl()

SpecialChangeCredentials::getReturnUrl ( )

protected

Returns: string|null

Definition at line 257 of file SpecialChangeCredentials.php.

References $title, and AuthManagerSpecialPage\getRequest().

Referenced by getAuthForm(), and success().

◆ handleFormSubmit()

SpecialChangeCredentials::handleFormSubmit ( $data )

Submit handler callback for HTMLForm.

Reimplemented from AuthManagerSpecialPage.

Definition at line 186 of file SpecialChangeCredentials.php.

References AuthManagerSpecialPage\$authRequests, and AuthManagerSpecialPage\performAuthenticationStep().

◆ isListed()

SpecialChangeCredentials::isListed ( )

Whether this special page is listed in Special:SpecialPages Stable to override.

Since: 1.3 (r3583)

Returns: bool

Reimplemented from SpecialPage.

Definition at line 30 of file SpecialChangeCredentials.php.

References AuthManagerSpecialPage\$authRequests, and loadAuth().

◆ loadAuth()

SpecialChangeCredentials::loadAuth	(	$subPage,
		$authAction = null,
		$reset = false )

protected

Load or initialize $authAction, $authRequests and $subPage.

Subclasses should call this from execute() or otherwise ensure the variables are initialized. Stable to override

Parameters

string	$subPage	Subpage of the special page.
string \| null	$authAction	Override auth action specified in request (this is useful when the form needs to be changed from <action> to <action>_CONTINUE after a successful authentication step)
bool	$reset	Regenerate the requests even if a cached version is available

Reimplemented from AuthManagerSpecialPage.

Definition at line 93 of file SpecialChangeCredentials.php.

References AuthManagerSpecialPage\$authAction, and AuthManagerSpecialPage\$subPage.

Referenced by execute(), and isListed().

◆ needsSubmitButton()

SpecialChangeCredentials::needsSubmitButton ( array $requests )

protected

Returns true if the form built from the given AuthenticationRequests needs a submit button.

Providers using redirect flow (e.g. Google login) need their own submit buttons; if using one of those custom buttons is the only way to proceed, there is no point in displaying the default button which won't do anything useful. Stable to override

Parameters

AuthenticationRequest[] $requests An array of AuthenticationRequests from which the form will be built

Returns: bool

Reimplemented from AuthManagerSpecialPage.

Definition at line 180 of file SpecialChangeCredentials.php.

◆ onAuthChangeFormFields()

SpecialChangeCredentials::onAuthChangeFormFields	(	array	$requests,
		array	$fieldInfo,
		array &	$formDescriptor,
			$action )

Change the form descriptor that determines how a field will look in the authentication form.Called from fieldInfoToFormDescriptor(). Stable to override

Parameters

AuthenticationRequest[]	$requests
array	$fieldInfo	Field information array (union of all AuthenticationRequest::getFieldInfo() responses).
array	&$formDescriptor	HTMLForm descriptor. The special key 'weight' can be set to change the order of the fields.
string	$action	Authentication type (one of the AuthManager::ACTION_* constants)