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

	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.

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.

	requiresUnblock ()
	Whether this action cannot be executed by a blocked user.

	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.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	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.

	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.

	getTitle ( $subpage=false)
	Get a self-referential title object.

	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)
	Wrapper around wfMessage that sets the current context.

	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.

	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.

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

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

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

static	checkUnblockSelf ( $user, User $performer)
	T17810: blocked admins should not be able to block/unblock others, and probably shouldn't be able to unblock themselves either.

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

static	getTargetAndType ( $par, WebRequest $request=null)
	Determine the target of the block, and the type of target.

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	validateTarget ( $value, User $user)
	Validate a block target.

static	validateTargetField ( $value, $alldata, $form)
	HTMLForm field validation-callback for Target field.

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.

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.

	postText ()
	Add footer elements to the form.

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

	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.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	getCacheTTL ()

	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.

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

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

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

Static Protected Member Functions
static	blockLogFlags (array $data, $type)
	Return a comma-delimited list of "flags" to be passed to the log reader for this block, to provide more information in the logs.

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.

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

int	$type
	Block::TYPE_ constant.

Protected Attributes inherited from FormSpecialPage
string	$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.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

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

Definition at line 30 of file SpecialBlock.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialBlock::__construct ( )

Definition at line 50 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 101 of file SpecialBlock.php.

References $s, SpecialPage\addHelpLink(), and SpecialPage\getRequest().

◆ blockLogFlags()

static SpecialBlock::blockLogFlags	(	array	$data,
			$type )

staticprotected

Return a comma-delimited list of "flags" to be passed to the log reader for this block, to provide more information in the logs.

Parameters

array	$data	From HTMLForm data
int	$type	Block::TYPE_ constant (USER, RANGE, or IP)

Returns: string

Definition at line 967 of file SpecialBlock.php.

References $type, $wgBlockAllowsUTEdit, and Block\TYPE_USER.

◆ canBlockEmail()

static SpecialBlock::canBlockEmail ( $user )

static

Can we do an email block?

Parameters

User $user The sysop wanting to make a block

Returns: bool

Definition at line 919 of file SpecialBlock.php.

References $wgEnableUserEmail, and $wgSysopEmailBans.

Referenced by ApiBlock\execute().

◆ 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 64 of file SpecialBlock.php.

References checkUnblockSelf().

◆ checkUnblockSelf()

static SpecialBlock::checkUnblockSelf	(		$user,
		User	$performer )

static

T17810: blocked admins should not be able to block/unblock others, and probably shouldn't be able to unblock themselves either.

Parameters

User \| int \| string	$user
User	$performer	User doing the request

Returns: bool|string True or error message key

Definition at line 933 of file SpecialBlock.php.

References User\blockedBy(), User\getId(), User\getName(), User\isAllowed(), User\isBlocked(), User\newFromId(), and User\newFromName().

Referenced by checkExecutePermissions(), ApiBlock\execute(), and ApiUnblock\execute().

◆ doesWrites()

SpecialBlock::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 54 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 123 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 131 of file SpecialBlock.php.

References $wgBlockAllowsUTEdit, SpecialPage\getConfig(), getSuggestedDurations(), SpecialPage\getUser(), maybeAlterFormDefaults(), MIGRATION_OLD, 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'.

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 1045 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: array

Definition at line 861 of file SpecialBlock.php.

References $lang, $value, list, and wfMessage().

Referenced by getFormFields(), and Language\translateBlockExpiry().

◆ getTargetAndType()

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

static

Determine the target of the block, and the type of target.

Todo: Should be in Block.php?

Parameters

string	$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 [ User|string|null, Block::TYPE_ constant|null ]

Definition at line 500 of file SpecialBlock.php.

References $request, $type, list, and Block\parseTarget().

Referenced by SpecialUnblock\execute(), ApiBlock\execute(), and setParameter().

◆ getTargetUserTitle()

static SpecialBlock::getTargetUserTitle ( $target )

staticprotected

Get a user page target for things like logs.

This handles account and IP range targets.

Parameters

User | string $target

Returns: Title|null

Definition at line 482 of file SpecialBlock.php.

◆ 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

Returns: bool Whether fields were altered (that is, whether the target is already blocked)

Definition at line 251 of file SpecialBlock.php.

References block, SpecialPage\getRequest(), SpecialPage\getUser(), is, Block\newFromTarget(), string, validateTarget(), 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|array True for success, false for didn't-try, array of errors on failure

Definition at line 1013 of file SpecialBlock.php.

◆ 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 1021 of file SpecialBlock.php.

References $out, and 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.

Todo: strtotime() only accepts English strings. This means the expiry input can only be specified in English.

See also: https://secure.php.net/manual/en/function.strtotime.php

Parameters

string $expiry Whatever was typed into the form

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

Definition at line 900 of file SpecialBlock.php.

References wfIsInfinity(), and wfTimestamp().

◆ postText()

SpecialBlock::postText ( )

protected

Add footer elements to the form.

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 381 of file SpecialBlock.php.

References $linkRenderer, $out, SpecialPage\getTitleFor(), LogEventsList\showLogExtract(), text, 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 1035 of file SpecialBlock.php.

References User\newFromName(), and UserNamePrefixSearch\search().

◆ preText()

SpecialBlock::preText ( )

protected

Add header elements like block log entries, etc.

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 336 of file SpecialBlock.php.

References $link, and $s.

◆ processForm()

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

static

Given the form data, actually implement a block.

This is also called from ApiBlock.

Parameters

array	$data
IContextSource	$context

Returns: bool|string

Definition at line 631 of file SpecialBlock.php.

References $context, $expiryTime, $type, $wgBlockAllowsUTEdit, $wgHideUserContribLimit, WatchAction\doWatch(), User\IGNORE_USER_RIGHTS, list, Block\newFromTarget(), RevisionDeleteUser\suppressUserName(), Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, RevisionDeleteUser\unsuppressUserName(), wfIsInfinity(), and wfTimestampNow().

Referenced by ApiBlock\execute().

◆ setParameter()

SpecialBlock::setParameter ( $par )

protected

Handle some magic here.

Parameters

string $par

Reimplemented from FormSpecialPage.

Definition at line 79 of file SpecialBlock.php.

References FormSpecialPage\$par, $request, SpecialPage\getRequest(), SpecialPage\getSkin(), getTargetAndType(), list, Block\parseTarget(), and type.

◆ validateTarget()

static SpecialBlock::validateTarget	(		$value,
		User	$user )

static

Validate a block target.

Since: 1.21

Parameters

string	$value	Block target to check
User	$user	Performer of the block

Returns: Status

Definition at line 570 of file SpecialBlock.php.

References $type, $value, $wgBlockCIDRLimit, list, Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, and wfEscapeWikiText().

Referenced by ApiBlock\execute(), and maybeAlterFormDefaults().

◆ validateTargetField()

static SpecialBlock::validateTargetField	(	$value,
		$alldata,
		$form )

static

HTMLForm field validation-callback for Target field.

Since: 1.18

Parameters

string	$value
array	$alldata
HTMLForm	$form

Returns: Message

Definition at line 551 of file SpecialBlock.php.

References $value.

Member Data Documentation

◆ $alreadyBlocked

bool SpecialBlock::$alreadyBlocked

protected

Definition at line 45 of file SpecialBlock.php.

◆ $preErrors

array SpecialBlock::$preErrors = []

protected

Definition at line 48 of file SpecialBlock.php.

◆ $previousTarget

User string SpecialBlock::$previousTarget

protected

The previous block target.

Definition at line 39 of file SpecialBlock.php.

◆ $requestedHideUser

bool SpecialBlock::$requestedHideUser

protected

Whether the previous submission of the form asked for HideUser.

Definition at line 42 of file SpecialBlock.php.

◆ $target

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

◆ $type

int SpecialBlock::$type

protected

Block::TYPE_ constant.

Definition at line 36 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()

◆ blockLogFlags()

◆ canBlockEmail()

◆ checkExecutePermissions()

◆ checkUnblockSelf()

◆ doesWrites()

◆ getDisplayFormat()

◆ getFormFields()

◆ getGroupName()

◆ getSuggestedDurations()

◆ getTargetAndType()

◆ getTargetUserTitle()

◆ maybeAlterFormDefaults()

◆ onSubmit()

◆ onSuccess()

◆ parseExpiryInput()

◆ postText()

◆ prefixSearchSubpages()

◆ preText()

◆ processForm()

◆ setParameter()

◆ validateTarget()

◆ validateTargetField()

Member Data Documentation

◆ $alreadyBlocked

◆ $preErrors

◆ $previousTarget

◆ $requestedHideUser

◆ $target

◆ $type