A special page that allows users with 'block' right to block users from editing pages and other actions. More...

Inheritance diagram for SpecialBlock:

[legend]

Collaboration diagram for SpecialBlock:

[legend]

Public Member Functions
	__construct (BlockUtils $blockUtils, BlockPermissionCheckerFactory $blockPermissionCheckerFactory, BlockUserFactory $blockUserFactory, UserNameUtils $userNameUtils, UserNamePrefixSearch $userNamePrefixSearch, BlockActionInfo $blockActionInfo, TitleFormatter $titleFormatter, NamespaceInfo $namespaceInfo)

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

	onSubmit (array $data, HTMLForm $form=null)
	Process the form on POST submission.

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

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requiresUnblock ()
	We allow certain special cases where user is blocked.

Public Member Functions inherited from FormSpecialPage
	execute ( $par)
	Basic SpecialPage workflow: get a form, send it to the user; get some data back,.

	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.

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

	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.

	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.

	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)

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

Static Public Member Functions
static	canBlockEmail (UserIdentity $user)
	Can we do an email block?

static	checkUnblockSelf ( $target, Authority $performer)
	T17810: Sitewide blocked admins should not be able to block/unblock others with one exception; they can block the user who blocked them, to reduce advantage of a malicious account blocking all admins (T150826).

static	getSuggestedDurations (Language $lang=null, $includeOther=true)
	Get an array of suggested block durations from MediaWiki:Ipboptions.

static	getTargetAndType (?string $par, WebRequest $request=null)
	Get the target and type, given the request and the subpage parameter.

static	parseExpiryInput ( $expiry)
	Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034", etc), into an absolute timestamp we can put into the database.

static	processForm (array $data, IContextSource $context)
	Given the form data, actually implement a block.

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	newSearchPage (User $user)
	Get the users preferred search page.

Protected Member Functions
	alterForm (HTMLForm $form)
	Customizes the HTMLForm a bit.

	checkExecutePermissions (User $user)
	Checks that the user can unblock themselves if they are trying to do so.

	getDisplayFormat ()
	Get display format for the form.

	getFormFields ()
	Get the HTMLForm descriptor array for the block form.

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

	maybeAlterFormDefaults (&$fields)
	If the user has already been blocked with similar settings, load that block and change the defaults for the form fields to match the existing settings.

	postHtml ()
	Add footer elements to the form.

	preHtml ()
	Add header elements like block log entries, etc.

	setParameter ( $par)
	Handle some magic here.

Protected Member Functions inherited from FormSpecialPage
	getForm ()
	Get the HTMLForm to control behavior.

	getMessagePrefix ()
	Get message prefix for HTMLForm.

	postText ()
	Add post-text to the form.

	preText ()
	Add pre-text to the form.

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

	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.

Static Protected Member Functions
static	getTargetUserTitle ( $target)
	Get a user page target for things like logs.

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
bool	$alreadyBlocked

array[]	$preErrors = []

User string	$previousTarget
	The previous block target.

bool	$requestedHideUser
	Whether the previous submission of the form asked for HideUser.

UserIdentity string null	$target
	User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo)

int	$type
	DatabaseBlock::TYPE_ constant.

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 with 'block' right to block users from editing pages and other actions.

Definition at line 49 of file SpecialBlock.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialBlock::__construct	(	BlockUtils	$blockUtils,
		BlockPermissionCheckerFactory	$blockPermissionCheckerFactory,
		BlockUserFactory	$blockUserFactory,
		UserNameUtils	$userNameUtils,
		UserNamePrefixSearch	$userNamePrefixSearch,
		BlockActionInfo	$blockActionInfo,
		TitleFormatter	$titleFormatter,
		NamespaceInfo	$namespaceInfo )

Parameters

BlockUtils	$blockUtils
BlockPermissionCheckerFactory	$blockPermissionCheckerFactory
BlockUserFactory	$blockUserFactory
UserNameUtils	$userNameUtils
UserNamePrefixSearch	$userNamePrefixSearch
BlockActionInfo	$blockActionInfo
TitleFormatter	$titleFormatter
NamespaceInfo	$namespaceInfo

Definition at line 108 of file SpecialBlock.php.

Member Function Documentation

◆ alterForm()

SpecialBlock::alterForm ( HTMLForm $form )

protected

Customizes the HTMLForm a bit.

Parameters

HTMLForm $form

Reimplemented from FormSpecialPage.

Definition at line 187 of file SpecialBlock.php.

References HTMLForm\addHeaderText(), SpecialPage\addHelpLink(), SpecialPage\getRequest(), SpecialPage\msg(), HTMLForm\setHeaderText(), HTMLForm\setSubmitDestructive(), and HTMLForm\setSubmitTextMsg().

◆ canBlockEmail()

static SpecialBlock::canBlockEmail ( UserIdentity $user )

static

Can we do an email block?

Deprecated: since 1.36, use BlockPermissionChecker service instead

Parameters

UserIdentity $user The sysop wanting to make a block

Returns: bool

Definition at line 998 of file SpecialBlock.php.

References User\newFromIdentity().

◆ checkExecutePermissions()

SpecialBlock::checkExecutePermissions ( User $user )

protected

Checks that the user can unblock themselves if they are trying to do so.

Parameters

User $user

Exceptions

ErrorPageError

Reimplemented from FormSpecialPage.

Definition at line 140 of file SpecialBlock.php.

◆ checkUnblockSelf()

static SpecialBlock::checkUnblockSelf	(		$target,
		Authority	$performer )

static

T17810: Sitewide blocked admins should not be able to block/unblock others with one exception; they can block the user who blocked them, to reduce advantage of a malicious account blocking all admins (T150826).

T208965: Partially blocked admins can block and unblock others as normal.

Deprecated: since 1.36, hard deprecated since 1.37, use BlockPermissionChecker instead

Parameters

UserIdentity \| string \| null	$target	Target to block or unblock; could be a UserIdentity object, or username/IP address, or null when the target is not known yet (e.g. when displaying Special:Block)
Authority	$performer	User doing the request

Returns: bool|string True or error message key

Definition at line 1019 of file SpecialBlock.php.

References wfDeprecated().

◆ doesWrites()

SpecialBlock::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 130 of file SpecialBlock.php.

◆ getDisplayFormat()

SpecialBlock::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 212 of file SpecialBlock.php.

◆ getFormFields()

SpecialBlock::getFormFields ( )

protected

Get the HTMLForm descriptor array for the block form.

Returns: array

Reimplemented from FormSpecialPage.

Definition at line 220 of file SpecialBlock.php.

References Message\durationParam(), getAuthority(), SpecialPage\getConfig(), SpecialPage\getHookRunner(), SpecialPage\getOutput(), getUser(), maybeAlterFormDefaults(), and SpecialPage\msg().

◆ getGroupName()

SpecialBlock::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 SpecialPage.

Definition at line 1071 of file SpecialBlock.php.

◆ getSuggestedDurations()

static SpecialBlock::getSuggestedDurations	(	Language	$lang = null,
			$includeOther = true )

static

Get an array of suggested block durations from MediaWiki:Ipboptions.

Todo: FIXME: This uses a rather odd syntax for the options, should it be converted to the standard "**<duration>|<displayname>" format?

Parameters

Language \| null	$lang	The language to get the durations in, or null to use the wiki's content language
bool	$includeOther	Whether to include the 'other' option in the list of suggestions

Returns: string[]

Definition at line 958 of file SpecialBlock.php.

References $lang, XmlSelect\parseOptionsMessage(), and wfMessage().

◆ getTargetAndType()

static SpecialBlock::getTargetAndType	(	?string	$par,
		WebRequest	$request = null )

static

Get the target and type, given the request and the subpage parameter.

Several parameters are handled for backwards compatability. 'wpTarget' is prioritized, since it matches the HTML form.

Deprecated: since 1.36. Use BlockUtils::parseBlockTarget directly instead.

Parameters

string \| null	$par	Subpage parameter passed to setup, or data value from the HTMLForm
WebRequest \| null	$request	Optionally try and get data from a request too

Returns: array [ UserIdentity|string|null, DatabaseBlock::TYPE_ constant|null ]

Definition at line 744 of file SpecialBlock.php.

◆ getTargetUserTitle()

static SpecialBlock::getTargetUserTitle ( $target )

staticprotected

Get a user page target for things like logs.

This handles account and IP range targets.

Parameters

UserIdentity | string | null $target

Returns: PageReference|null

Definition at line 719 of file SpecialBlock.php.

References $target, MediaWiki\User\UserIdentity\getName(), and NS_USER.

◆ maybeAlterFormDefaults()

SpecialBlock::maybeAlterFormDefaults ( & $fields )

protected

If the user has already been blocked with similar settings, load that block and change the defaults for the form fields to match the existing settings.

Parameters

array &$fields HTMLForm descriptor array

Definition at line 439 of file SpecialBlock.php.

References SpecialPage\getConfig(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getRequest(), MediaWiki\Block\Restriction\PageRestriction\getTitle(), MediaWiki\Block\DatabaseBlock\getType(), getUser(), wfEscapeWikiText(), and wfTimestamp().

Referenced by getFormFields().

◆ onSubmit()

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

Process the form on POST submission.

Parameters

array	$data
HTMLForm \| null	$form

Returns: bool|string|array|Status As documented for HTMLForm::trySubmit.

Definition at line 1033 of file SpecialBlock.php.

References getAuthority().

◆ onSuccess()

SpecialBlock::onSuccess ( )

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

Reimplemented from FormSpecialPage.

Definition at line 1046 of file SpecialBlock.php.

References wfEscapeWikiText().

◆ parseExpiryInput()

static SpecialBlock::parseExpiryInput ( $expiry )

static

Convert a submitted expiry time, which may be relative ("2 weeks", etc) or absolute ("24 May 2034", etc), into an absolute timestamp we can put into the database.

Deprecated: since 1.36, use BlockUser::parseExpiryInput instead

Parameters

string $expiry Whatever was typed into the form

Returns: string|bool Timestamp or 'infinity' or false on error.

Definition at line 987 of file SpecialBlock.php.

◆ postHtml()

SpecialBlock::postHtml ( )

protected

Add footer elements to the form.

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 614 of file SpecialBlock.php.

References getAuthority(), SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), getTitle(), SpecialPage\getTitleFor(), SpecialPage\msg(), and wfEscapeWikiText().

◆ prefixSearchSubpages()

SpecialBlock::prefixSearchSubpages	(	$search,
		$limit,
		$offset )

Return an array of subpages beginning with $search that this special page will accept.

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 1060 of file SpecialBlock.php.

◆ preHtml()

SpecialBlock::preHtml ( )

protected

Add header elements like block log entries, etc.

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 564 of file SpecialBlock.php.

References $s, SpecialPage\getConfig(), SpecialPage\getHookRunner(), SpecialPage\getOutput(), and SpecialPage\msg().

◆ processForm()

static SpecialBlock::processForm	(	array	$data,
		IContextSource	$context )

static

Given the form data, actually implement a block.

Deprecated: since 1.36, use BlockUserFactory service instead

Parameters

array	$data
IContextSource	$context

Returns: bool|string|array|Status

Definition at line 776 of file SpecialBlock.php.

References IContextSource\getAuthority().

◆ requiresUnblock()

SpecialBlock::requiresUnblock ( )

We allow certain special cases where user is blocked.

Returns: bool

Reimplemented from FormSpecialPage.

Definition at line 156 of file SpecialBlock.php.

◆ setParameter()

SpecialBlock::setParameter ( $par )

protected

Handle some magic here.

Parameters

string $par

Reimplemented from FormSpecialPage.

Definition at line 165 of file SpecialBlock.php.

References FormSpecialPage\$par, SpecialPage\getRequest(), and SpecialPage\getSkin().

Member Data Documentation

◆ $alreadyBlocked

bool SpecialBlock::$alreadyBlocked

protected

Definition at line 87 of file SpecialBlock.php.

◆ $preErrors

array [] SpecialBlock::$preErrors = []

protected

Definition at line 93 of file SpecialBlock.php.

◆ $previousTarget

User string SpecialBlock::$previousTarget

protected

The previous block target.

Definition at line 81 of file SpecialBlock.php.

◆ $requestedHideUser

bool SpecialBlock::$requestedHideUser

protected

Whether the previous submission of the form asked for HideUser.

Definition at line 84 of file SpecialBlock.php.

◆ $target

UserIdentity string null SpecialBlock::$target

protected

User to be blocked, as passed either by parameter (url?wpTarget=Foo) or as subpage (Special:Block/Foo)

Definition at line 75 of file SpecialBlock.php.

Referenced by getTargetUserTitle().

◆ $type

int SpecialBlock::$type

protected

DatabaseBlock::TYPE_ constant.

Definition at line 78 of file SpecialBlock.php.

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

includes/specials/SpecialBlock.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ canBlockEmail()

◆ checkExecutePermissions()

◆ checkUnblockSelf()

◆ doesWrites()

◆ getDisplayFormat()

◆ getFormFields()

◆ getGroupName()

◆ getSuggestedDurations()

◆ getTargetAndType()

◆ getTargetUserTitle()

◆ maybeAlterFormDefaults()

◆ onSubmit()

◆ onSuccess()

◆ parseExpiryInput()

◆ postHtml()

◆ prefixSearchSubpages()

◆ preHtml()

◆ processForm()

◆ requiresUnblock()

◆ setParameter()

Member Data Documentation

◆ $alreadyBlocked

◆ $preErrors

◆ $previousTarget

◆ $requestedHideUser

◆ $target

◆ $type