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

Inheritance diagram for SpecialBlock:

Collaboration diagram for SpecialBlock:

Public Member Functions
	__construct ()
	onSubmit (array $data)
	Process the form on POST submission.
	onSuccess ()
	Do something exciting on successful processing of the form, most likely to show a confirmation message.
Static Public Member Functions
static	canBlockEmail ($user)
	Can we do an email block?
static	checkUnblockSelf ($user, User $performer)
	bug 15810: blocked admins should not be able to block/unblock others, and probably shouldn't be able to unblock themselves either.
static	getSuggestedDurations ($lang=null)
	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 TODO: should be in Block.php?
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	processUIForm (array $data, HTMLForm $form)
	Submit callback for an HTMLForm object, will simply pass.
static	validateTarget ($value, User $user)
	Validate a block target.
static	validateTargetField ($value, $alldata, $form)
	HTMLForm field validation-callback for Target field.
Public Attributes
const	HIDEUSER_CONTRIBLIMIT = 1000
	The maximum number of edits a user can have and still be hidden TODO: config setting?
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.
	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.
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.
Protected Attributes
	$alreadyBlocked
	$preErrors = array()
	$previousTarget
	$requestedHideUser
	$target
	$type

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

SpecialBlock::__construct ( )

Definition at line 54 of file SpecialBlock.php.

Member Function Documentation

SpecialBlock::alterForm ( HTMLForm $ form ) [protected]

Customizes the HTMLForm a bit.

Parameters:

$form HTMLForm

Reimplemented from FormSpecialPage.

Definition at line 100 of file SpecialBlock.php.

References $s, HTMLForm\addHeaderText(), array(), HTMLForm\formatErrors(), SpecialPage\getRequest(), Html\rawElement(), HTMLForm\setHeaderText(), HTMLForm\setSubmitCallback(), HTMLForm\setSubmitTextMsg(), and HTMLForm\setWrapperLegendMsg().

static SpecialBlock::blockLogFlags	(	array $	data,
		$	type
	)		`[static, protected]`

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
	$type	Block::TYPE_ constant (USER, RANGE, or IP)

Returns:: string

Definition at line 896 of file SpecialBlock.php.

References $flags, array(), global, and Block\TYPE_USER.

static SpecialBlock::canBlockEmail ( $ user ) [static]

Can we do an email block?

Parameters:

$user User: the sysop wanting to make a block

Returns:: Boolean

Definition at line 848 of file SpecialBlock.php.

References $user, and global.

Referenced by ApiBlock\execute().

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

static SpecialBlock::checkUnblockSelf	(	$	user,
		User $	performer
	)		`[static]`

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

Parameters:

$user	User\|Int\|String
$performer	User user doing the request

Returns:: Bool|String true or error message key

Definition at line 862 of file SpecialBlock.php.

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

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

SpecialBlock::getFormFields ( ) [protected]

Get the HTMLForm descriptor array for the block form.

Returns:: Array

Reimplemented from FormSpecialPage.

Definition at line 125 of file SpecialBlock.php.

References $user, array(), getSuggestedDurations(), SpecialPage\getUser(), global, maybeAlterFormDefaults(), SpecialPage\msg(), and text.

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

static SpecialBlock::getSuggestedDurations ( $ lang = null ) [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:

$lang Language|null the language to get the durations in, or null to use the wiki's content language

Returns:: Array

Definition at line 794 of file SpecialBlock.php.

References $value, array(), as, list, and wfMessage().

Referenced by getFormFields().

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
	$request	WebRequest optionally try and get data from a request too

Returns:: array( User|string|null, Block::TYPE_ constant|null )

Definition at line 461 of file SpecialBlock.php.

References array(), list, and Block\parseTarget().

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

static SpecialBlock::getTargetUserTitle ( $ target ) [static, protected]

Get a user page target for things like logs.

This handles account and IP range targets.

Parameters:

$target User|string

Returns:: Title|null

Definition at line 443 of file SpecialBlock.php.

References IP\isIPAddress(), and Title\makeTitleSafe().

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

References array(), block, SpecialPage\exists(), SpecialPage\getRequest(), is, it, Block\newFromTarget(), t(), wfEscapeWikiText(), and wfTimestamp().

Referenced by getFormFields().

SpecialBlock::onSubmit ( array $ data )

Process the form on POST submission.

Parameters:

$data Array

Returns:: Bool|Array true for success, false for didn't-try, array of errors on failure

Reimplemented from FormSpecialPage.

Definition at line 941 of file SpecialBlock.php.

SpecialBlock::onSuccess ( )

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

Reimplemented from FormSpecialPage.

Definition at line 950 of file SpecialBlock.php.

References $out, and wfEscapeWikiText().

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.

Parameters:

string $expiry whatever was typed into the form

Returns:: String: timestamp or "infinity" string for the DB implementation

Definition at line 822 of file SpecialBlock.php.

References wfGetDB(), and wfTimestamp().

Referenced by ApiQueryLogEvents\addLogParams().

SpecialBlock::postText ( ) [protected]

Add footer elements to the form.

Returns:: string

Reimplemented from FormSpecialPage.

Definition at line 351 of file SpecialBlock.php.

References $out, $user, array(), SpecialPage\getTitleFor(), Linker\link(), Linker\linkKnown(), Title\makeTitle(), Html\rawElement(), LogEventsList\showLogExtract(), and wfEscapeWikiText().

SpecialBlock::preText ( ) [protected]

Add header elements like block log entries, etc.

Returns:: String

Reimplemented from FormSpecialPage.

Definition at line 311 of file SpecialBlock.php.

References $link, $s, array(), as, Html\rawElement(), and wfRunHooks().

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

Given the form data, actually implement a block.

Parameters:

$data	Array
$context	IContextSource

Returns:: Bool|String

Definition at line 601 of file SpecialBlock.php.

References $user, array(), WatchAction\doWatch(), IContextSource\getUser(), global, WatchedItem\IGNORE_USER_RIGHTS, list, Title\makeTitle(), Block\newFromTarget(), RevisionDeleteUser\suppressUserName(), Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, RevisionDeleteUser\unsuppressUserName(), and wfRunHooks().

Referenced by ApiBlock\execute().

static SpecialBlock::processUIForm	(	array $	data,
		HTMLForm $	form
	)		`[static]`

Submit callback for an HTMLForm object, will simply pass.

Parameters:

$data	array
$form	HTMLForm

Returns:: Bool|String

Definition at line 591 of file SpecialBlock.php.

References ContextSource\getContext().

SpecialBlock::setParameter ( $ par ) [protected]

Handle some magic here.

Parameters:

$par String

Reimplemented from FormSpecialPage.

Definition at line 79 of file SpecialBlock.php.

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

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

References $value, global, IP\isIPv4(), IP\isIPv6(), list, Status\newGood(), Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, and wfEscapeWikiText().

static SpecialBlock::validateTargetField	(	$	value,
		$	alldata,
		$	form
	)		`[static]`

HTMLForm field validation-callback for Target field.

Since:: 1.18

Parameters:

$value	String
$alldata	Array
$form	HTMLForm

Returns:: Message

Definition at line 512 of file SpecialBlock.php.

References $form, $value, and array().

Member Data Documentation

SpecialBlock::$alreadyBlocked [protected]

Definition at line 49 of file SpecialBlock.php.

SpecialBlock::$preErrors = array() [protected]

Definition at line 52 of file SpecialBlock.php.

SpecialBlock::$previousTarget [protected]

Definition at line 43 of file SpecialBlock.php.

SpecialBlock::$requestedHideUser [protected]

Definition at line 46 of file SpecialBlock.php.

SpecialBlock::$target [protected]

Definition at line 37 of file SpecialBlock.php.

SpecialBlock::$type [protected]

Definition at line 40 of file SpecialBlock.php.

const SpecialBlock::HIDEUSER_CONTRIBLIMIT = 1000

The maximum number of edits a user can have and still be hidden TODO: config setting?

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

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation