A special page that allows users to modify their notification preferences. More...

Inherits MediaWiki\SpecialPage\FormSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialMute:

[legend]

Public Member Functions
	__construct (CentralIdLookup $centralIdLookup, UserOptionsManager $userOptionsManager, UserIdentityLookup $userIdentityLookup, UserIdentityUtils $userIdentityUtils)

	execute ( $par)
	Entry point for special pages.

	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.Derived classes can override this, but usually it is easier to keep the default behavior.Returning a string from this method has been deprecated since 1.41. Stability: stable to override Returns string\|Message

	isTargetMuted ( $userOption)

	onSubmit (array $data, HTMLForm $form=null)

	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

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

Public Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage
	onSubmit (array $data)
	Process the form on submission.

	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.

	doesWrites ()
	Indicates whether this special page may perform database writes.

	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.

	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 sub pages 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}}.

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	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')
	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
	getDisplayFormat ()
	Get display format for the form.See HTMLForm documentation for available values. Since 1.25 Returns string

	getForm ()
	Get the HTMLForm to control behavior. Returns HTMLForm\|null

	getFormFields ()
	Get an HTMLForm descriptor array. Returns array

Protected Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage
	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.

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

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

	getHookContainer ()

	getHookRunner ()

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

	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 Per 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 sub-page 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

A special page that allows users to modify their notification preferences.

Definition at line 42 of file SpecialMute.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialMute::__construct	(	CentralIdLookup	$centralIdLookup,
		UserOptionsManager	$userOptionsManager,
		UserIdentityLookup	$userIdentityLookup,
		UserIdentityUtils	$userIdentityUtils )

Parameters

CentralIdLookup	$centralIdLookup
UserOptionsManager	$userOptionsManager
UserIdentityLookup	$userIdentityLookup
UserIdentityUtils	$userIdentityUtils

Definition at line 63 of file SpecialMute.php.

Member Function Documentation

◆ execute()

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

Entry point for special pages.

Parameters

string | null $par

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 81 of file SpecialMute.php.

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

◆ getDescription()

MediaWiki\Specials\SpecialMute::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.Derived classes can override this, but usually it is easier to keep the default behavior.Returning a string from this method has been deprecated since 1.41.

Stability: stable: to override

Returns: string|Message

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 137 of file SpecialMute.php.

References MediaWiki\SpecialPage\SpecialPage\msg().

◆ getDisplayFormat()

MediaWiki\Specials\SpecialMute::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 105 of file SpecialMute.php.

◆ getForm()

MediaWiki\Specials\SpecialMute::getForm ( )

protected

Get the HTMLForm to control behavior.

Returns: HTMLForm|null

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 188 of file SpecialMute.php.

◆ getFormFields()

MediaWiki\Specials\SpecialMute::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 202 of file SpecialMute.php.

References MediaWiki\MainConfigNames\EnableUserEmail, MediaWiki\MainConfigNames\EnableUserEmailMuteList, and getUser().

◆ isTargetMuted()

MediaWiki\Specials\SpecialMute::isTargetMuted ( $userOption )

Parameters

string $userOption

Returns: bool

Definition at line 261 of file SpecialMute.php.

◆ onSubmit()

MediaWiki\Specials\SpecialMute::onSubmit	(	array	$data,
		HTMLForm	$form = null )

Parameters

array	$data
HTMLForm \| null	$form

Returns: bool

Definition at line 122 of file SpecialMute.php.

◆ onSuccess()

MediaWiki\Specials\SpecialMute::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 112 of file SpecialMute.php.

References MediaWiki\SpecialPage\SpecialPage\getOutput().

◆ requiresUnblock()

MediaWiki\Specials\SpecialMute::requiresUnblock ( )

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

Returns: bool

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 98 of file SpecialMute.php.

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

includes/specials/SpecialMute.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getDescription()

◆ getDisplayFormat()

◆ getForm()

◆ getFormFields()

◆ isTargetMuted()

◆ onSubmit()

◆ onSuccess()

◆ requiresUnblock()