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

Inheritance diagram for SpecialMute:

[legend]

Collaboration diagram for SpecialMute:

[legend]

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

	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. Stability: stable to override Returns string

	isTargetBlacklisted ( $userOption)

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

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

	requiresWrite ()
	Whether this action requires the wiki not to be locked.

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.

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

	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 name of this Special Page.

	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.

	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.

	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.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	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.

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

	postText ()
	Add post-text 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 SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

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

	getLanguageConverter ()
	Shortcut to get language's converter.

	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.

Private Member Functions
	getMuteList ( $userOption)

	getTarget ()

	loadTarget ( $username)

	muteTarget ( $userOption)
	Mute target.

	unmuteTarget ( $userOption)
	Un-mute target.

Private Attributes
CentralIdLookup	$centralIdLookup

UserIdentity null	$target

int	$targetCentralId

UserIdentityLookup	$userIdentityLookup

UserOptionsManager	$userOptionsManager

const	PAGE_NAME = 'Mute'

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 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 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 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 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 33 of file SpecialMute.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialMute::__construct	(	CentralIdLookup	$centralIdLookup,
		UserOptionsManager	$userOptionsManager,
		UserIdentityLookup	$userIdentityLookup
	)

Parameters

CentralIdLookup	$centralIdLookup
UserOptionsManager	$userOptionsManager
UserIdentityLookup	$userIdentityLookup

Definition at line 57 of file SpecialMute.php.

References $centralIdLookup, $userIdentityLookup, and $userOptionsManager.

Member Function Documentation

◆ execute()

SpecialMute::execute ( $par )

Entry point for special pages.

Parameters

string | null $par

Reimplemented from FormSpecialPage.

Definition at line 73 of file SpecialMute.php.

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

◆ getDescription()

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.

Stability: stable: to override

Returns: string

Reimplemented from SpecialPage.

Definition at line 135 of file SpecialMute.php.

References SpecialPage\msg().

◆ getDisplayFormat()

SpecialMute::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 97 of file SpecialMute.php.

◆ getForm()

SpecialMute::getForm ( )

protected

Get the HTMLForm to control behavior.

Returns: HTMLForm|null

Reimplemented from FormSpecialPage.

Definition at line 186 of file SpecialMute.php.

◆ getFormFields()

SpecialMute::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from FormSpecialPage.

Definition at line 200 of file SpecialMute.php.

References User\newFromIdentity().

◆ getMuteList()

SpecialMute::getMuteList ( $userOption )

private

Parameters

string $userOption

Returns: array

Definition at line 268 of file SpecialMute.php.

◆ getTarget()

SpecialMute::getTarget ( )

private

Returns: UserIdentity|null

Definition at line 142 of file SpecialMute.php.

◆ isTargetBlacklisted()

SpecialMute::isTargetBlacklisted ( $userOption )

Deprecated:: since 1.35, use isTargetMuted

Parameters

string $userOption

Returns: bool

Definition at line 259 of file SpecialMute.php.

References wfDeprecated().

◆ isTargetMuted()

SpecialMute::isTargetMuted ( $userOption )

Parameters

string $userOption

Returns: bool

Definition at line 248 of file SpecialMute.php.

Referenced by onSubmit().

◆ loadTarget()

SpecialMute::loadTarget ( $username )

private

Parameters

string | null $username

Definition at line 231 of file SpecialMute.php.

Referenced by execute().

◆ muteTarget()

SpecialMute::muteTarget ( $userOption )

private

Mute target.

Parameters

string $userOption up_property key that holds the blacklist

Definition at line 169 of file SpecialMute.php.

Referenced by onSubmit().

◆ onSubmit()

SpecialMute::onSubmit	(	array	$data,
		HTMLForm	$form = `null`
	)

Parameters

array	$data
HTMLForm \| null	$form

Returns: bool

Definition at line 114 of file SpecialMute.php.

References SpecialPage\getHookRunner(), isTargetMuted(), muteTarget(), and unmuteTarget().

◆ onSuccess()

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

Definition at line 104 of file SpecialMute.php.

References SpecialPage\getOutput().

◆ requiresUnblock()

SpecialMute::requiresUnblock ( )

Whether this action cannot be executed by a blocked user.

Returns: bool

Reimplemented from FormSpecialPage.

Definition at line 90 of file SpecialMute.php.

◆ unmuteTarget()

SpecialMute::unmuteTarget ( $userOption )

private

Un-mute target.

Parameters

string $userOption up_property key that holds the list of muted users

Definition at line 151 of file SpecialMute.php.

Referenced by onSubmit().

Member Data Documentation

◆ $centralIdLookup

CentralIdLookup SpecialMute::$centralIdLookup

private

Definition at line 44 of file SpecialMute.php.

Referenced by __construct().

◆ $target

UserIdentity null SpecialMute::$target

private

Definition at line 38 of file SpecialMute.php.

◆ $targetCentralId

int SpecialMute::$targetCentralId

private

Definition at line 41 of file SpecialMute.php.

◆ $userIdentityLookup

UserIdentityLookup SpecialMute::$userIdentityLookup

private

Definition at line 50 of file SpecialMute.php.

Referenced by __construct().

◆ $userOptionsManager

UserOptionsManager SpecialMute::$userOptionsManager

private

Definition at line 47 of file SpecialMute.php.

Referenced by __construct().

◆ PAGE_NAME

const SpecialMute::PAGE_NAME = 'Mute'

private

Definition at line 35 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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getDescription()

◆ getDisplayFormat()

◆ getForm()

◆ getFormFields()

◆ getMuteList()

◆ getTarget()

◆ isTargetBlacklisted()

◆ isTargetMuted()

◆ loadTarget()

◆ muteTarget()

◆ onSubmit()

◆ onSuccess()

◆ requiresUnblock()

◆ unmuteTarget()

Member Data Documentation

◆ $centralIdLookup

◆ $target

◆ $targetCentralId

◆ $userIdentityLookup

◆ $userOptionsManager

◆ PAGE_NAME