Inheritance diagram for MediaWiki\Block\AbstractBlock:

[legend]

Collaboration diagram for MediaWiki\Block\AbstractBlock:

[legend]

Public Member Functions
	__construct (array $options=[])
	Create a new block with specified parameters on a user, IP or IP range.

	appliesToNamespace ( $ns)
	Checks if a block applies to a particular namespace.

	appliesToPage ( $pageId)
	Checks if a block applies to a particular page.

	appliesToPasswordReset ()
	Check if the block prevents a user from resetting their password.

	appliesToRight ( $right)
	Determine whether the block prevents a given right.

	appliesToTitle (Title $title)
	Checks if a block applies to a particular title.

	appliesToUsertalk (Title $usertalk=null)
	Determine whether the block allows the user to edit their own user talk page.

	getBlocker ()
	Get the user who implemented this block.

	getBlockErrorParams (IContextSource $context)
	Get block information used in different block error messages.

	getBy ()
	Get the user id of the blocking sysop.

	getByName ()
	Get the username of the blocking sysop.

	getExpiry ()
	Get the block expiry time.

	getHideName ()
	Get whether the block hides the target's username.

	getId ()
	Get the block ID.

	getIdentifier ()
	Get the information that identifies this block, such that a user could look up everything that can be found about this block.

	getPermissionsError (IContextSource $context)
	Get the key and parameters for the corresponding error message.

	getReason ()
	Get the reason given for creating the block, as a string.

	getReasonComment ()
	Get the reason for creating the block.

	getTarget ()
	Get the target for this particular block.

	getTargetAndType ()
	Get the target and target type for this particular block.

	getTimestamp ()
	Get the timestamp indicating when the block was created.

	getType ()
	Get the type of target for this particular block.

	isCreateAccountBlocked ( $x=null)
	Get or set the flag indicating whether this block blocks the target from creating an account.

	isEmailBlocked ( $x=null)
	Get or set the flag indicating whether this block blocks the target from sending emails.

	isSitewide ( $x=null)
	Indicates that the block is a sitewide block.

	isUsertalkEditAllowed ( $x=null)
	Get or set the flag indicating whether this block blocks the target from editing their own user talk page.

	prevents ( $action, $x=null)
	Get/set whether the block prevents a given action.

	setBlocker ( $user)
	Set the user who implemented (or will implement) this block.

	setExpiry ( $expiry)
	Set the block expiry time.

	setHideName ( $hideName)
	Set whether ths block hides the target's username.

	setReason ( $reason)
	Set the reason for creating the block.

	setTarget ( $target)
	Set the target for this block, and update $this->type accordingly.

	setTimestamp ( $timestamp)
	Set the timestamp indicating when the block was created.

	shouldTrackWithCookie ( $isAnon)
	Check if the block should be tracked with a cookie.

Static Public Member Functions
static	parseTarget ( $target)
	From an existing block, get the target and the type of target.

Public Attributes
string	$mExpiry = ''

bool	$mHideName = false

string	$mTimestamp

const	TYPE_AUTO = 4

const	TYPE_ID = 5

const	TYPE_IP = 2

const	TYPE_RANGE = 3

const	TYPE_USER = 1

Protected Attributes
bool	$allowUsertalk = false

bool	$blockCreateAccount = false

bool	$isSitewide = true

bool	$mBlockEmail = false

	$mReason

CommentStoreComment	$reason

User string null	$target

int null	$type
	AbstractBlock::TYPE_ constant.

Detailed Description

Note: Extensions should not subclass this, as MediaWiki currently does not support custom block types.

Since: 1.34 Factored out from DatabaseBlock (previously Block).

Definition at line 38 of file AbstractBlock.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\AbstractBlock::__construct ( array $options = [] )

Create a new block with specified parameters on a user, IP or IP range.

Parameters

array

$options

Parameters of the block, with supported options:

address: (string|User) Target user name, User object, IP address or IP range
reason: (string|Message|CommentStoreComment) Reason for the block
timestamp: (string) The time at which the block comes into effect
hideName: (bool) Hide the target user name

Reimplemented in MediaWiki\Block\CompositeBlock, MediaWiki\Block\DatabaseBlock, and MediaWiki\Block\SystemBlock.

Definition at line 103 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\setHideName(), MediaWiki\Block\AbstractBlock\setReason(), MediaWiki\Block\AbstractBlock\setTarget(), MediaWiki\Block\AbstractBlock\setTimestamp(), and wfTimestamp().

Member Function Documentation

◆ appliesToNamespace()

MediaWiki\Block\AbstractBlock::appliesToNamespace ( $ns )

Checks if a block applies to a particular namespace.

Since: 1.33

Parameters

int $ns

Returns: bool

Reimplemented in MediaWiki\Block\CompositeBlock, and MediaWiki\Block\DatabaseBlock.

Definition at line 655 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\isSitewide().

Referenced by MediaWiki\Block\AbstractBlock\appliesToUsertalk().

◆ appliesToPage()

MediaWiki\Block\AbstractBlock::appliesToPage ( $pageId )

Checks if a block applies to a particular page.

This check does not consider whether $this->isUsertalkEditAllowed returns false, as the identity of the user making the hypothetical edit isn't known here (particularly in the case of IP hardblocks, range blocks, and auto-blocks).

Since: 1.33

Parameters

int $pageId

Returns: bool

Reimplemented in MediaWiki\Block\CompositeBlock, and MediaWiki\Block\DatabaseBlock.

Definition at line 672 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\isSitewide().

Referenced by MediaWiki\Block\AbstractBlock\appliesToUsertalk().

◆ appliesToPasswordReset()

MediaWiki\Block\AbstractBlock::appliesToPasswordReset ( )

Check if the block prevents a user from resetting their password.

Since: 1.33

Returns: bool The block blocks password reset

Reimplemented in MediaWiki\Block\CompositeBlock, and MediaWiki\Block\SystemBlock.

Definition at line 696 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\isCreateAccountBlocked().

◆ appliesToRight()

MediaWiki\Block\AbstractBlock::appliesToRight ( $right )

Determine whether the block prevents a given right.

A right may be blacklisted or whitelisted, or determined from a property on the block object. For certain rights, the property may be overridden according to global configs.

Since: 1.33

Parameters

string $right

Returns: bool|null The block applies to the right, or null if unsure (e.g. unrecognized right or unset property)

Reimplemented in MediaWiki\Block\CompositeBlock.

Definition at line 269 of file AbstractBlock.php.

References $res, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Block\AbstractBlock\isCreateAccountBlocked(), MediaWiki\Block\AbstractBlock\isEmailBlocked(), and MediaWiki\Block\AbstractBlock\isSitewide().

Referenced by MediaWiki\Block\DatabaseBlock\chooseBlock(), and User\isBlockedFromCreateAccount().

◆ appliesToTitle()

MediaWiki\Block\AbstractBlock::appliesToTitle ( Title $title )

Checks if a block applies to a particular title.

This check does not consider whether $this->isUsertalkEditAllowed returns false, as the identity of the user making the hypothetical edit isn't known here (particularly in the case of IP hardblocks, range blocks, and auto-blocks).

Parameters

Title $title

Returns: bool

Reimplemented in MediaWiki\Block\CompositeBlock, and MediaWiki\Block\DatabaseBlock.

Definition at line 643 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\isSitewide().

◆ appliesToUsertalk()

MediaWiki\Block\AbstractBlock::appliesToUsertalk ( Title $usertalk = null )

Determine whether the block allows the user to edit their own user talk page.

This is done separately from AbstractBlock::appliesToRight because there is no right for editing one's own user talk page and because the user's talk page needs to be passed into the block object, which is unaware of the user.

The ipb_allow_usertalk flag (which corresponds to the property allowUsertalk) is used on sitewide blocks and partial blocks that contain a namespace restriction on the user talk namespace, but do not contain a page restriction on the user's talk page. For all other (i.e. most) partial blocks, the flag is ignored, and the user can always edit their user talk page unless there is a page restriction on their user talk page, in which case they can never edit it. (Ideally the flag would be stored as null in these cases, but the database field isn't nullable.)

This method does not validate that the passed in talk page belongs to the block target since the target (an IP) might not be the same as the user's talk page (if they are logged in).

Since: 1.33

Parameters

Title | null $usertalk The user's user talk page. If null, and if the target is a User, the target's userpage is used

Returns: bool The user can edit their talk page

Reimplemented in MediaWiki\Block\CompositeBlock.

Definition at line 597 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\appliesToNamespace(), MediaWiki\Block\AbstractBlock\appliesToPage(), MediaWiki\Block\AbstractBlock\isSitewide(), MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed(), and NS_USER_TALK.

◆ getBlocker()

MediaWiki\Block\AbstractBlock::getBlocker ( )

Get the user who implemented this block.

Deprecated:: since 1.35. Use getBy/getByName instead

Returns: null User object or null. May name a foreign user.

Reimplemented in MediaWiki\Block\DatabaseBlock.

Definition at line 516 of file AbstractBlock.php.

References wfDeprecated().

◆ getBlockErrorParams()

MediaWiki\Block\AbstractBlock::getBlockErrorParams ( IContextSource $context )

Get block information used in different block error messages.

Deprecated:: since 1.35 Use BlockErrorFormatter::getMessage instead, and extract the params from the Message object using Message::getParams.

Since: 1.33

Parameters

IContextSource $context

Returns: array

Definition at line 559 of file AbstractBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), IContextSource\getLanguage(), IContextSource\getRequest(), IContextSource\getUser(), and wfDeprecated().

◆ getBy()

MediaWiki\Block\AbstractBlock::getBy ( )

abstract

Get the user id of the blocking sysop.

Returns: int (0 for foreign users)

Reimplemented in MediaWiki\Block\CompositeBlock, MediaWiki\Block\DatabaseBlock, and MediaWiki\Block\SystemBlock.

Referenced by MediaWiki\Block\BlockErrorFormatter\getBlockErrorInfo().

◆ getByName()

MediaWiki\Block\AbstractBlock::getByName ( )

abstract

Get the username of the blocking sysop.

Returns: string

Reimplemented in MediaWiki\Block\CompositeBlock, MediaWiki\Block\DatabaseBlock, and MediaWiki\Block\SystemBlock.

Referenced by MediaWiki\Block\BlockErrorFormatter\getBlockErrorInfo().

◆ getExpiry()

MediaWiki\Block\AbstractBlock::getExpiry ( )

Get the block expiry time.

Since: 1.19

Returns: string

Reimplemented in MediaWiki\Block\CompositeBlock.

Definition at line 469 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$mExpiry.

Referenced by MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\DatabaseBlock\equals(), MediaWiki\Block\BlockErrorFormatter\getBlockErrorInfo(), MediaWiki\Block\DatabaseBlock\getDatabaseArray(), MediaWiki\Block\DatabaseBlock\isExpired(), and MediaWiki\Block\BlockManager\setBlockCookie().

◆ getHideName()

MediaWiki\Block\AbstractBlock::getHideName ( )

Get whether the block hides the target's username.

Since: 1.33

Returns: bool The block hides the username

Definition at line 192 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$mHideName.

Referenced by MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\DatabaseBlock\equals(), MediaWiki\Block\DatabaseBlock\getAutoblockUpdateArray(), and MediaWiki\Block\DatabaseBlock\getDatabaseArray().

◆ getId()

MediaWiki\Block\AbstractBlock::getId ( )

Get the block ID.

Returns: int|null

Reimplemented in MediaWiki\Block\DatabaseBlock.

Definition at line 138 of file AbstractBlock.php.

◆ getIdentifier()

MediaWiki\Block\AbstractBlock::getIdentifier ( )

abstract

Get the information that identifies this block, such that a user could look up everything that can be found about this block.

May be an ID, array of IDs, type, etc.

Returns: mixed Identifying information

Reimplemented in MediaWiki\Block\CompositeBlock, MediaWiki\Block\DatabaseBlock, and MediaWiki\Block\SystemBlock.

Referenced by MediaWiki\Block\BlockErrorFormatter\getBlockErrorInfo().

◆ getPermissionsError()

MediaWiki\Block\AbstractBlock::getPermissionsError ( IContextSource $context )

Get the key and parameters for the corresponding error message.

Deprecated:: since 1.35 Use BlockErrorFormatter::getMessage instead, and build the array using Message::getKey and Message::getParams.

Since: 1.22

Parameters

IContextSource $context

Returns: array

Definition at line 539 of file AbstractBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), IContextSource\getLanguage(), IContextSource\getRequest(), and IContextSource\getUser().

◆ getReason()

MediaWiki\Block\AbstractBlock::getReason ( )

Get the reason given for creating the block, as a string.

Deprecated, since this gives the caller no control over the language or format, and no access to the comment's data.

Deprecated:: since 1.35. Use getReasonComment instead.

Since: 1.33

Returns: string

Reimplemented in MediaWiki\Block\DatabaseBlock.

Definition at line 161 of file AbstractBlock.php.

◆ getReasonComment()

MediaWiki\Block\AbstractBlock::getReasonComment ( )

Get the reason for creating the block.

Since: 1.35

Returns: CommentStoreComment

Definition at line 172 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$reason.

Referenced by MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\DatabaseBlock\equals(), MediaWiki\Block\DatabaseBlock\getAutoblockUpdateArray(), MediaWiki\Block\BlockErrorFormatter\getBlockErrorInfo(), and MediaWiki\Block\DatabaseBlock\getDatabaseArray().

◆ getTarget()

MediaWiki\Block\AbstractBlock::getTarget ( )

Get the target for this particular block.

Note that for autoblocks, this returns the unredacted name; frontend functions need to call $block->getRedactedName() in this situation.

Returns: User|string|null

Definition at line 459 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$target.

Referenced by MediaWiki\Block\DatabaseBlock\defaultRetroactiveAutoblock(), MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\DatabaseBlock\doRetroactiveAutoblock(), MediaWiki\Block\BlockErrorFormatter\getBlockErrorInfo(), MediaWiki\Block\DatabaseBlock\getRedactedName(), and MediaWiki\Block\AbstractBlock\getTargetAndType().

◆ getTargetAndType()

MediaWiki\Block\AbstractBlock::getTargetAndType ( )

Get the target and target type for this particular block.

Note that for autoblocks, this returns the unredacted name; frontend functions need to call $block->getRedactedName() in this situation.

If the type is not null, it will be an AbstractBlock::TYPE_ constant.

Returns: array [ User|String|null, int|null ]

Todo:: FIXME: This should be an integral part of the block member variables

Definition at line 449 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\getTarget(), and MediaWiki\Block\AbstractBlock\getType().

◆ getTimestamp()

MediaWiki\Block\AbstractBlock::getTimestamp ( )

Get the timestamp indicating when the block was created.

Since: 1.33

Returns: string

Definition at line 489 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$mTimestamp.

Referenced by MediaWiki\Block\BlockErrorFormatter\getBlockErrorInfo(), and MediaWiki\Block\DatabaseBlock\updateTimestamp().

◆ getType()

MediaWiki\Block\AbstractBlock::getType ( )

Get the type of target for this particular block.

Returns: int|null AbstractBlock::TYPE_ constant, will never be TYPE_ID

Reimplemented in MediaWiki\Block\DatabaseBlock.

Definition at line 435 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$type.

Referenced by ApiBase\dieBlocked(), MediaWiki\Block\BlockErrorFormatter\getBlockErrorMessageKey(), MediaWiki\Block\AbstractBlock\getTargetAndType(), and MediaWiki\Block\BlockManager\shouldTrackBlockWithCookie().

◆ isCreateAccountBlocked()

MediaWiki\Block\AbstractBlock::isCreateAccountBlocked ( $x = null )

Get or set the flag indicating whether this block blocks the target from creating an account.

(Note that the flag may be overridden depending on global configs.)

Since: 1.33

Parameters

null | bool $x Value to set (if null, just get the property value)

Returns: bool Value of the property

Definition at line 228 of file AbstractBlock.php.

References wfSetVar().

Referenced by MediaWiki\Block\CompositeBlock\__construct(), MediaWiki\Block\DatabaseBlock\__construct(), MediaWiki\Block\AbstractBlock\appliesToPasswordReset(), MediaWiki\Block\SystemBlock\appliesToPasswordReset(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\DatabaseBlock\equals(), MediaWiki\Block\DatabaseBlock\getAutoblockUpdateArray(), MediaWiki\Block\DatabaseBlock\getDatabaseArray(), and MediaWiki\Block\DatabaseBlock\initFromRow().

◆ isEmailBlocked()

MediaWiki\Block\AbstractBlock::isEmailBlocked ( $x = null )

Get or set the flag indicating whether this block blocks the target from sending emails.

(Note that the flag may be overridden depending on global configs.)

Since: 1.33

Parameters

null | bool $x Value to set (if null, just get the property value)

Returns: bool Value of the property

Definition at line 241 of file AbstractBlock.php.

References wfSetVar().

Referenced by MediaWiki\Block\CompositeBlock\__construct(), MediaWiki\Block\DatabaseBlock\__construct(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Block\DatabaseBlock\equals(), MediaWiki\Block\DatabaseBlock\getDatabaseArray(), and MediaWiki\Block\DatabaseBlock\initFromRow().

◆ isSitewide()

MediaWiki\Block\AbstractBlock::isSitewide ( $x = null )

Indicates that the block is a sitewide block.

This means the user is prohibited from editing any page on the site (other than their own talk page).

Since: 1.33

Parameters

null | bool $x

Returns: bool

Definition at line 215 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\isSitewide(), and wfSetVar().

◆ isUsertalkEditAllowed()

MediaWiki\Block\AbstractBlock::isUsertalkEditAllowed ( $x = null )

Get or set the flag indicating whether this block blocks the target from editing their own user talk page.

(Note that the flag may be overridden depending on global configs.)

Since: 1.33

Parameters

null | bool $x Value to set (if null, just get the property value)

Returns: bool Value of the property

Definition at line 254 of file AbstractBlock.php.

References wfSetVar().

Referenced by MediaWiki\Block\CompositeBlock\__construct(), MediaWiki\Block\DatabaseBlock\__construct(), MediaWiki\Block\AbstractBlock\appliesToUsertalk(), MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\DatabaseBlock\equals(), MediaWiki\Block\DatabaseBlock\getAutoblockUpdateArray(), MediaWiki\Block\DatabaseBlock\getDatabaseArray(), MediaWiki\Block\DatabaseBlock\initFromRow(), and MediaWiki\Block\AbstractBlock\prevents().

◆ parseTarget()

static MediaWiki\Block\AbstractBlock::parseTarget ( $target )

static

From an existing block, get the target and the type of target.

Note that, except for null, it is always safe to treat the target as a string; for User objects this will return User::__toString() which in turn gives User::getName().

If the type is not null, it will be an AbstractBlock::TYPE_ constant.

Parameters

string | UserIdentity | null $target

Returns: array [ User|String|null, int|null ]

Definition at line 380 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$target, User\getName(), User\newFromIdentity(), User\newFromName(), MediaWiki\Block\AbstractBlock\TYPE_AUTO, MediaWiki\Block\AbstractBlock\TYPE_IP, MediaWiki\Block\AbstractBlock\TYPE_RANGE, and MediaWiki\Block\AbstractBlock\TYPE_USER.

Referenced by MediaWiki\Block\BlockPermissionChecker\__construct(), MediaWiki\Block\DatabaseBlock\newListFromTarget(), and MediaWiki\Block\DatabaseBlock\newLoad().

◆ prevents()

MediaWiki\Block\AbstractBlock::prevents	(	$action,
		$x = `null`
	)

Get/set whether the block prevents a given action.

Deprecated:: since 1.33, use appliesToRight to determine block behaviour, and specific methods to get/set properties

Parameters

string	$action	Action to check
bool \| null	$x	Value for set, or null to just get value

Returns: bool|null Null for unrecognized rights.

Definition at line 316 of file AbstractBlock.php.

References $res, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Block\AbstractBlock\isSitewide(), MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed(), wfDeprecated(), and wfSetVar().

◆ setBlocker()

MediaWiki\Block\AbstractBlock::setBlocker ( $user )

Set the user who implemented (or will implement) this block.

Deprecated:: since 1.35. Moved to DatabaseBlock

Parameters

User | string $user Local User object or username string

Reimplemented in MediaWiki\Block\DatabaseBlock.

Definition at line 526 of file AbstractBlock.php.

References wfDeprecated().

◆ setExpiry()

MediaWiki\Block\AbstractBlock::setExpiry ( $expiry )

Set the block expiry time.

Since: 1.33

Parameters

string $expiry

Definition at line 479 of file AbstractBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\__construct(), MediaWiki\Block\DatabaseBlock\initFromRow(), and MediaWiki\Block\DatabaseBlock\updateTimestamp().

◆ setHideName()

MediaWiki\Block\AbstractBlock::setHideName ( $hideName )

Set whether ths block hides the target's username.

Since: 1.33

Parameters

bool $hideName The block hides the username

Definition at line 202 of file AbstractBlock.php.

Referenced by MediaWiki\Block\AbstractBlock\__construct(), MediaWiki\Block\CompositeBlock\__construct(), and MediaWiki\Block\DatabaseBlock\initFromRow().

◆ setReason()

MediaWiki\Block\AbstractBlock::setReason ( $reason )

Set the reason for creating the block.

Since: 1.33

Parameters

string | Message | CommentStoreComment $reason

Definition at line 182 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$reason.

Referenced by MediaWiki\Block\AbstractBlock\__construct(), and MediaWiki\Block\DatabaseBlock\initFromRow().

◆ setTarget()

MediaWiki\Block\AbstractBlock::setTarget ( $target )

Set the target for this block, and update $this->type accordingly.

Parameters

mixed $target

Definition at line 507 of file AbstractBlock.php.

References MediaWiki\Block\AbstractBlock\$target.

Referenced by MediaWiki\Block\AbstractBlock\__construct(), and MediaWiki\Block\DatabaseBlock\initFromRow().

◆ setTimestamp()

MediaWiki\Block\AbstractBlock::setTimestamp ( $timestamp )

Set the timestamp indicating when the block was created.

Since: 1.33

Parameters

string $timestamp

Definition at line 499 of file AbstractBlock.php.

Referenced by MediaWiki\Block\AbstractBlock\__construct(), MediaWiki\Block\DatabaseBlock\initFromRow(), and MediaWiki\Block\DatabaseBlock\updateTimestamp().

◆ shouldTrackWithCookie()

MediaWiki\Block\AbstractBlock::shouldTrackWithCookie ( $isAnon )

Check if the block should be tracked with a cookie.

Since: 1.33

Deprecated:: since 1.34 Use BlockManager::trackBlockWithCookie instead of calling this directly.

Parameters

bool $isAnon The user is logged out

Returns: bool The block should be tracked with a cookie

Reimplemented in MediaWiki\Block\DatabaseBlock.

Definition at line 685 of file AbstractBlock.php.

References wfDeprecated().

Member Data Documentation

◆ $allowUsertalk

bool MediaWiki\Block\AbstractBlock::$allowUsertalk = false

protected

Definition at line 64 of file AbstractBlock.php.

◆ $blockCreateAccount

bool MediaWiki\Block\AbstractBlock::$blockCreateAccount = false

protected

Definition at line 67 of file AbstractBlock.php.

◆ $isSitewide

bool MediaWiki\Block\AbstractBlock::$isSitewide = true

protected

Definition at line 85 of file AbstractBlock.php.

◆ $mBlockEmail

bool MediaWiki\Block\AbstractBlock::$mBlockEmail = false

protected

Definition at line 61 of file AbstractBlock.php.

◆ $mExpiry

string MediaWiki\Block\AbstractBlock::$mExpiry = ''

Deprecated:: since 1.34. Use getExpiry and setExpiry instead.

Definition at line 58 of file AbstractBlock.php.

Referenced by MediaWiki\Block\AbstractBlock\getExpiry().

◆ $mHideName

bool MediaWiki\Block\AbstractBlock::$mHideName = false

Deprecated:: since 1.34. Use getHideName and setHideName instead.

Definition at line 73 of file AbstractBlock.php.

Referenced by MediaWiki\Block\AbstractBlock\getHideName().

◆ $mReason

MediaWiki\Block\AbstractBlock::$mReason

protected

Deprecated:: since 1.34. Use getReasonComment and setReason instead. Internally, use $reason.

Definition at line 43 of file AbstractBlock.php.

◆ $mTimestamp

string MediaWiki\Block\AbstractBlock::$mTimestamp

Deprecated:: since 1.34. Use getTimestamp and setTimestamp instead.

Definition at line 52 of file AbstractBlock.php.

Referenced by MediaWiki\Block\AbstractBlock\getTimestamp().

◆ $reason

CommentStoreComment MediaWiki\Block\AbstractBlock::$reason

protected

Definition at line 46 of file AbstractBlock.php.

Referenced by MediaWiki\Block\AbstractBlock\getReasonComment(), and MediaWiki\Block\AbstractBlock\setReason().

◆ $target

User string null MediaWiki\Block\AbstractBlock::$target

protected

Definition at line 76 of file AbstractBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\chooseMostSpecificBlock(), MediaWiki\Block\DatabaseBlock\defaultRetroactiveAutoblock(), MediaWiki\Block\AbstractBlock\getTarget(), MediaWiki\Block\DatabaseBlock\newListFromTarget(), MediaWiki\Block\DatabaseBlock\newLoad(), MediaWiki\Block\AbstractBlock\parseTarget(), and MediaWiki\Block\AbstractBlock\setTarget().

◆ $type

int null MediaWiki\Block\AbstractBlock::$type

protected

AbstractBlock::TYPE_ constant.

After the block has been loaded from the database, this can only be USER, IP or RANGE.

Definition at line 82 of file AbstractBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\findRestriction(), MediaWiki\Block\AbstractBlock\getType(), MediaWiki\Block\DatabaseBlock\newListFromTarget(), and MediaWiki\Block\DatabaseBlock\newLoad().

◆ TYPE_AUTO

const MediaWiki\Block\AbstractBlock::TYPE_AUTO = 4

Definition at line 91 of file AbstractBlock.php.

Referenced by MediaWiki\Block\BlockManager\getAdditionalIpBlocks(), MediaWiki\Block\BlockErrorFormatter\getBlockErrorMessageKey(), MediaWiki\Block\DatabaseBlock\getType(), MediaWiki\Block\BlockManager\getUniqueBlocks(), and MediaWiki\Block\AbstractBlock\parseTarget().

◆ TYPE_ID

const MediaWiki\Block\AbstractBlock::TYPE_ID = 5

Definition at line 92 of file AbstractBlock.php.

◆ TYPE_IP

const MediaWiki\Block\AbstractBlock::TYPE_IP = 2

Definition at line 89 of file AbstractBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\getRangeEnd(), MediaWiki\Block\DatabaseBlock\getRangeStart(), MediaWiki\Block\DatabaseBlock\newLoad(), MediaWiki\Block\AbstractBlock\parseTarget(), MediaWiki\Block\BlockManager\shouldApplyCookieBlock(), MediaWiki\Block\BlockManager\shouldTrackBlockWithCookie(), and MediaWiki\Block\DatabaseBlock\shouldTrackWithCookie().

◆ TYPE_RANGE

const MediaWiki\Block\AbstractBlock::TYPE_RANGE = 3

Definition at line 90 of file AbstractBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\getRangeEnd(), MediaWiki\Block\DatabaseBlock\getRangeStart(), MediaWiki\Block\DatabaseBlock\newLoad(), MediaWiki\Block\AbstractBlock\parseTarget(), MediaWiki\Block\BlockManager\shouldApplyCookieBlock(), MediaWiki\Block\BlockManager\shouldTrackBlockWithCookie(), and MediaWiki\Block\DatabaseBlock\shouldTrackWithCookie().

◆ TYPE_USER

const MediaWiki\Block\AbstractBlock::TYPE_USER = 1

Definition at line 88 of file AbstractBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\getRangeEnd(), MediaWiki\Block\DatabaseBlock\getRangeStart(), MediaWiki\Block\DatabaseBlock\newLoad(), MediaWiki\Block\AbstractBlock\parseTarget(), MediaWiki\Block\BlockManager\shouldApplyCookieBlock(), MediaWiki\Block\BlockManager\shouldTrackBlockWithCookie(), and MediaWiki\Block\DatabaseBlock\shouldTrackWithCookie().

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

includes/block/AbstractBlock.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appliesToNamespace()

◆ appliesToPage()

◆ appliesToPasswordReset()

◆ appliesToRight()

◆ appliesToTitle()

◆ appliesToUsertalk()

◆ getBlocker()

◆ getBlockErrorParams()

◆ getBy()

◆ getByName()

◆ getExpiry()

◆ getHideName()

◆ getId()

◆ getIdentifier()

◆ getPermissionsError()

◆ getReason()

◆ getReasonComment()

◆ getTarget()

◆ getTargetAndType()

◆ getTimestamp()

◆ getType()

◆ isCreateAccountBlocked()

◆ isEmailBlocked()

◆ isSitewide()

◆ isUsertalkEditAllowed()

◆ parseTarget()

◆ prevents()

◆ setBlocker()

◆ setExpiry()

◆ setHideName()

◆ setReason()

◆ setTarget()

◆ setTimestamp()

◆ shouldTrackWithCookie()

Member Data Documentation

◆ $allowUsertalk

◆ $blockCreateAccount

◆ $isSitewide

◆ $mBlockEmail

◆ $mExpiry

◆ $mHideName

◆ $mReason

◆ $mTimestamp

◆ $reason

◆ $target

◆ $type

◆ TYPE_AUTO

◆ TYPE_ID

◆ TYPE_IP

◆ TYPE_RANGE

◆ TYPE_USER