A special page for unblocking users. More...

Inheritance diagram for SpecialUnblock:

Collaboration diagram for SpecialUnblock:

[legend]

Public Member Functions
	__construct ()

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

	execute ( $par)
	Default execute method Checks user permissions. More...

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

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

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators. More...

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError. More...

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError. More...

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

	getConfig ()
	Shortcut to get main config object. More...

	getContext ()
	Gets the context this SpecialPage is executed in. More...

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

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

	getFullTitle ()
	Return the full title, including $par. More...

	getLanguage ()
	Shortcut to get user's language. More...

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page. More...

	getName ()
	Get the name of this Special Page. More...

	getOutput ()
	Get the OutputPage being used for this instance. More...

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

	getRequest ()
	Get the WebRequest being used for this instance. More...

	getRestriction ()
	Get the permission that a user must have to execute this page. More...

	getSkin ()
	Shortcut to get the skin being used for this instance. More...

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

	getUser ()
	Shortcut to get the User executing this instance. More...

	including ( $x=null)
	Whether the special page is being evaluated via transclusion. More...

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode. More...

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...

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

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes. More...

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages. More...

	maxIncludeCacheTime ()
	How long to cache page when it is being included. More...

	msg ( $key)
	Wrapper around wfMessage that sets the current context. More...

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

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error. More...

	run ( $subPage)
	Entry point. More...

	setContext ( $context)
	Sets the context this SpecialPage is executed in. More...

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

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time. More...

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

Static Public Member Functions
static	processUIUnblock (array $data, HTMLForm $form)
	Submit callback for an HTMLForm object. More...

static	processUnblock (array $data, IContextSource $context)
	Process the form. More...

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

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

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name. More...

Protected Member Functions
	getFields ()

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

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

	afterExecute ( $subPage)
	Gets called after. More...

	beforeExecute ( $subPage)
	Gets called before. More...

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

	getCacheTTL ()

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

	getRobotPolicy ()
	Return the robot policy. More...

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

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

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

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

Protected Attributes
	$block

	$target

	$type

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Additional Inherited Members
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). More...

Detailed Description

A special page for unblocking users.

Definition at line 29 of file SpecialUnblock.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialUnblock::__construct ( )

Definition at line 35 of file SpecialUnblock.php.

Member Function Documentation

◆ doesWrites()

SpecialUnblock::doesWrites ( )

Indicates whether this special page may perform database writes.

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 39 of file SpecialUnblock.php.

◆ execute()

SpecialUnblock::execute ( $subPage )

Default execute method Checks user permissions.

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

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 43 of file SpecialUnblock.php.

References $out, block, SpecialPage\checkPermissions(), SpecialPage\checkReadOnly(), HTMLForm\factory(), SpecialPage\getContext(), getFields(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getSkin(), SpecialBlock\getTargetAndType(), list, SpecialPage\msg(), Block\newFromTarget(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), type, Block\TYPE_AUTO, Block\TYPE_ID, Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, and wfEscapeWikiText().

◆ getFields()

SpecialUnblock::getFields ( )

protected

Definition at line 87 of file SpecialUnblock.php.

References $target, $type, block, SpecialPage\getLinkRenderer(), SpecialPage\getTitleFor(), list, type, Block\TYPE_AUTO, Block\TYPE_IP, Block\TYPE_RANGE, and Block\TYPE_USER.

Referenced by execute().

◆ getGroupName()

SpecialUnblock::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 275 of file SpecialUnblock.php.

◆ prefixSearchSubpages()

SpecialUnblock::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 265 of file SpecialUnblock.php.

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

◆ processUIUnblock()

static SpecialUnblock::processUIUnblock	(	array	$data,
		HTMLForm	$form
	)

static

Submit callback for an HTMLForm object.

Parameters

array	$data
HTMLForm	$form

Returns: array|bool Array(message key, parameters)

Definition at line 165 of file SpecialUnblock.php.

References ContextSource\getContext(), and processUnblock().

◆ processUnblock()

static SpecialUnblock::processUnblock	(	array	$data,
		IContextSource	$context
	)

static

Process the form.

Change tags can be provided via $data['Tags'], but the calling function must check if the tags can be added by the user prior to this function.

Parameters

array	$data
IContextSource	$context

Exceptions

ErrorPageError

Returns: array|bool Array( Array( message key, parameters ) ) on failure, True on success

Definition at line 180 of file SpecialUnblock.php.

References $block, $context, $target, $type, SpecialBlock\checkUnblockSelf(), SpecialBlock\getTargetAndType(), User\idFromName(), list, Title\makeTitle(), Block\newFromTarget(), NS_USER, Hooks\run(), Block\TYPE_AUTO, Block\TYPE_IP, Block\TYPE_RANGE, and RevisionDeleteUser\unsuppressUserName().

Referenced by ApiUnblock\execute(), and processUIUnblock().

Member Data Documentation

◆ $block

SpecialUnblock::$block

protected

Definition at line 33 of file SpecialUnblock.php.

Referenced by processUnblock().

◆ $target

SpecialUnblock::$target

protected

Definition at line 31 of file SpecialUnblock.php.

Referenced by getFields(), and processUnblock().

◆ $type

SpecialUnblock::$type

protected

Definition at line 32 of file SpecialUnblock.php.

Referenced by getFields(), and processUnblock().

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

includes/specials/SpecialUnblock.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doesWrites()

◆ execute()

◆ getFields()

◆ getGroupName()

◆ prefixSearchSubpages()

◆ processUIUnblock()

◆ processUnblock()

Member Data Documentation

◆ $block

◆ $target

◆ $type