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	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.
	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.
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 HTMLForm\addHeaderText(), HTMLForm\formatErrors(), SpecialPage\getRequest(), Html\rawElement(), HTMLForm\setHeaderText(), HTMLForm\setSubmitCallback(), HTMLForm\setSubmitTextMsg(), and HTMLForm\setWrapperLegendMsg().

Here is the call graph for this function:

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:

$data	Array from HTMLForm data
$type	Block::TYPE_ constant (USER, RANGE, or IP)

Returns:: array

Definition at line 841 of file SpecialBlock.php.

References $wgBlockAllowsUTEdit, 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 793 of file SpecialBlock.php.

References $user, $wgEnableUserEmail, and $wgSysopEmailBans.

Referenced by ApiBlock\execute().

Here is the caller graph for this function:

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

Here is the call graph for this function:

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

Here is the call graph for this function:

Here is the caller graph for this function:

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, $wgBlockAllowsUTEdit, SpecialPage\getUser(), maybeAlterFormDefaults(), and SpecialPage\msg().

Here is the call graph for this function:

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

References wfMessage().

Referenced by Language\translateBlockExpiry().

Here is the call graph for this function:

Here is the caller graph for this function:

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:

$par	String 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 437 of file SpecialBlock.php.

References Block\parseTarget().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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:

$fields Array HTMLForm descriptor array

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

Definition at line 230 of file SpecialBlock.php.

References SpecialPage\exists(), SpecialPage\getRequest(), Block\newFromTarget(), and wfTimestamp().

Referenced by getFormFields().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References $out.

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:

$expiry String: whatever was typed into the form