A DatabaseBlock (unlike a SystemBlock) is stored in the database, may give rise to autoblocks and may be tracked with cookies. More...

Inheritance diagram for MediaWiki\Block\DatabaseBlock:

[legend]

Collaboration diagram for MediaWiki\Block\DatabaseBlock:

[legend]

Public Member Functions

__construct (array $options=[])

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

appliesToNamespace ( $ns)

Checks if a block applies to a particular namespace.

Since: 1.33

Parameters

int $ns

Returns: bool

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

appliesToRight ( $right)

Determine whether the block prevents a given right.A right may be allowed or disallowed by default, 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)

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

delete ()

Delete the row from the IP blocks table.

doAutoblock ( $autoblockIP)

Autoblocks the given IP, referring to this block.

equals (DatabaseBlock $block)

Check if two blocks are effectively equal.

getBlocker ()

Get the user who implemented this block.

getBy ()

Get the user id of the blocking sysop.

Returns: int (0 for foreign users)

getByName ()

Get the username of the blocking sysop.

Returns: string

getId ()

Get the block ID.

Returns: int|null

getIdentifier ()

Get the information that identifies this block, such that a user could look up everything that can be found about this block.Typically a scalar ID (integer or string), but can also return a list of IDs, or an associative array encoding a composite ID. Must be safe to serialize as JSON.

Returns: mixed Identifying information

getParentBlockId ()

getRangeEnd ()

Get the IP address at the end of the range in Hex form.

getRangeStart ()

Get the IP address at the start of the range in Hex form.

getRawRestrictions ()

Get restrictions without loading from database if not yet loaded.

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

getRedactedName ()

Get the block name, but with autoblocked IPs hidden as per standard privacy policy.

getRestrictions ()

Getting the restrictions will perform a database query if the restrictions are not already loaded.

getType ()

Get the type of target for this particular block.

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

insert (IDatabase $dbw=null)

Insert a block into the block table.

isAutoblocking ( $x=null)

isExpired ()

Has the block expired?

isHardblock ( $x=null)

Get/set whether the block is a hardblock (affects logged-in users on a given IP/range)

setBlocker ( $user)

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

setId ( $blockId)

Set the block ID.

setRestrictions (array $restrictions)

update ()

Update a block in the DB with new parameters.

updateTimestamp ()

Update the timestamp on autoblocks.

Public Member Functions inherited from MediaWiki\Block\AbstractBlock

appliesToPasswordReset ()

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

appliesToUsertalk (Title $usertalk=null)

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

getExpiry ()

Get the block expiry time.

getHideName ()

Get whether the block hides the target's username.

getPermissionsError (IContextSource $context)

Get the key and parameters for the corresponding error message.

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.

getTargetName ()

getTargetUserIdentity ()

getTimestamp ()

Get the timestamp indicating when the block was created.

isBlocking ( $target)

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.

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.

Public Member Functions inherited from MediaWiki\Block\Block

isCreateAccountBlocked ()

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

isHardblock ()

Returns whether the block is a hardblock (affects logged-in users on a given IP/range)

isSitewide ()

Indicates that the block is a sitewide block.

Static Public Member Functions
static	getAutoblockExpiry ( $timestamp)
	Get a timestamp of the expiry for autoblocks.

static	getBlocksForIPList (array $ipChain, $isAnon, $fromPrimary=false)
	Get all blocks that match any IP from an array of IP addresses.

static	getQueryInfo ()
	Return the tables, fields, and join conditions to be selected to create a new block object.

static	getRangeCond ( $start, $end=null)
	Get a set of SQL conditions which will select rangeblocks encompassing a given range.

static	isExemptedFromAutoblocks ( $ip)
	Checks whether a given IP is on the autoblock exemption list.

static	isWhitelistedFromAutoblocks ( $ip)
	Checks whether a given IP is on the autoblock exemption list.

static	newFromID ( $id)
	Load a block from the block id.

static	newFromRow ( $row)
	Create a new DatabaseBlock object from a database row.

static	newFromTarget ( $specificTarget, $vagueTarget=null, $fromPrimary=false)
	Given a target and the target's type, get an existing block object if possible.

static	newListFromTarget ( $specificTarget, $vagueTarget=null, $fromPrimary=false)
	This is similar to DatabaseBlock::newFromTarget, but it returns all the relevant blocks.

static	purgeExpired ()
	Purge expired blocks from the ipblocks table.

Public Attributes
bool	$mAuto

int	$mParentBlockId

Public Attributes inherited from MediaWiki\Block\AbstractBlock
string	$mExpiry = ''

bool	$mHideName = false

string	$mTimestamp = ''

Public Attributes inherited from MediaWiki\Block\Block
const	TYPE_AUTO = 4

const	TYPE_ID = 5

const	TYPE_IP = 2

const	TYPE_RANGE = 3

const	TYPE_USER = 1

Protected Member Functions
	initFromRow ( $row)
	Given a database row from the ipblocks table, initialize member variables.

Static Protected Member Functions
static	chooseMostSpecificBlock (array $blocks)
	Choose the most specific block from some combination of user, IP and IP range blocks.

static	getIpFragment ( $hex)
	Get the component of an IP address which is certain to be the same between an IP address and a rangeblock containing that IP address.

static	newLoad ( $specificTarget, $specificType, $fromPrimary, $vagueTarget=null)
	Load blocks from the database which target the specific target exactly, or which cover the vague target.

Private Member Functions
	findRestriction ( $type, $value)
	Find Restriction by type and value.

	getBlockRestrictionStore ()
	Get a BlockRestrictionStore instance.

Private Attributes
UserIdentity null	$blocker

bool	$isAutoblocking

bool	$mFromPrimary

int	$mId

Restriction[]	$restrictions

Additional Inherited Members
Protected Attributes inherited from MediaWiki\Block\AbstractBlock
bool	$allowUsertalk = false

bool	$blockCreateAccount = false

bool	$isHardblock

bool	$isSitewide = true

bool	$mBlockEmail = false

CommentStoreComment	$reason

UserIdentity string null	$target

int null	$type
	AbstractBlock::TYPE_ constant.

Detailed Description

A DatabaseBlock (unlike a SystemBlock) is stored in the database, may give rise to autoblocks and may be tracked with cookies.

Such blocks are more customizable than system blocks: they may be hardblocks, and they may be sitewide or partial.

Since: 1.34 Renamed from Block.

Definition at line 52 of file DatabaseBlock.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

Parameters

array

$options

Parameters of the block, with options supported by AbstractBlock::__construct, and also:

user: (int) Override target user ID (for foreign users)
auto: (bool) Is this an automatic block?
expiry: (string) Timestamp of expiration of the block or 'infinity'
anonOnly: (bool) Only disallow anonymous actions
createAccount: (bool) Disallow creation of new accounts
enableAutoblock: (bool) Enable automatic blocking
blockEmail: (bool) Disallow sending emails
allowUsertalk: (bool) Allow the target to edit its own talk page
sitewide: (bool) Disallow editing all pages and all contribution actions, except those specifically allowed by other block flags
by: (int|UserIdentity) UserIdentity object or an ID of the blocker. Calling with ID is deprecated since 1.36, hard deprecated since 1.37.
byText: (string) Username of the blocker (for foreign users) Deprecated since 1.36, hard deprecated since 1.37. Use 'by' parameter instead.

Since: 1.26 $options array

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 102 of file DatabaseBlock.php.

References DB_REPLICA, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Block\DatabaseBlock\isAutoblocking(), MediaWiki\Block\Block\isCreateAccountBlocked(), MediaWiki\Block\AbstractBlock\isEmailBlocked(), MediaWiki\Block\Block\isSitewide(), MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed(), MediaWiki\Block\DatabaseBlock\setBlocker(), MediaWiki\Block\AbstractBlock\setExpiry(), wfDeprecatedMsg(), and wfGetDB().

Member Function Documentation

◆ appliesToNamespace()

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

Checks if a block applies to a particular namespace.

Since: 1.33

Parameters

int $ns

Returns: bool

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 1083 of file DatabaseBlock.php.

◆ appliesToPage()

MediaWiki\Block\DatabaseBlock::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 from MediaWiki\Block\AbstractBlock.

Definition at line 1101 of file DatabaseBlock.php.

◆ appliesToRight()

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

Determine whether the block prevents a given right.A right may be allowed or disallowed by default, 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 from MediaWiki\Block\AbstractBlock.

Definition at line 1119 of file DatabaseBlock.php.

References $res.

◆ appliesToTitle()

MediaWiki\Block\DatabaseBlock::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 from MediaWiki\Block\AbstractBlock.

Definition at line 1065 of file DatabaseBlock.php.

References $title.

◆ chooseMostSpecificBlock()

static MediaWiki\Block\DatabaseBlock::chooseMostSpecificBlock ( array $blocks )

staticprotected

Choose the most specific block from some combination of user, IP and IP range blocks.

Decreasing order of specificity: user > IP > narrower IP range > wider IP range. A range that encompasses one IP address is ranked equally to a singe IP.

This is refactored out from DatabaseBlock::newLoad.

Parameters

DatabaseBlock[] $blocks These should not include autoblocks or ID blocks

Returns: DatabaseBlock|null The block with the most specific target

Definition at line 372 of file DatabaseBlock.php.

References MediaWiki\Block\AbstractBlock\$target.

◆ delete()

MediaWiki\Block\DatabaseBlock::delete ( )

Delete the row from the IP blocks table.

Deprecated:: since 1.36 Use DatabaseBlockStore::deleteBlock instead.

Exceptions

MWException

Returns: bool

Definition at line 510 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ doAutoblock()

MediaWiki\Block\DatabaseBlock::doAutoblock ( $autoblockIP )

Autoblocks the given IP, referring to this block.

Parameters

string $autoblockIP The IP to autoblock.

Returns: int|bool ID if an autoblock was inserted, false if not.

Definition at line 615 of file DatabaseBlock.php.

References MediaWiki\Block\DatabaseBlock\$mId, MediaWiki\Block\DatabaseBlock\getBlocker(), MediaWiki\Block\AbstractBlock\getExpiry(), MediaWiki\Block\AbstractBlock\getHideName(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Block\AbstractBlock\getReasonComment(), MediaWiki\Block\DatabaseBlock\getRestrictions(), MediaWiki\Block\AbstractBlock\getTargetName(), MediaWiki\Block\DatabaseBlock\isAutoblocking(), MediaWiki\Block\Block\isCreateAccountBlocked(), MediaWiki\Block\Block\isSitewide(), MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed(), MediaWiki\Block\DatabaseBlock\newFromTarget(), Hooks\runner(), wfDebug(), wfMessage(), and wfTimestampNow().

◆ equals()

MediaWiki\Block\DatabaseBlock::equals ( DatabaseBlock $block )

Check if two blocks are effectively equal.

Doesn't check irrelevant things like the blocking user or the block timestamp, only things which affect the blocked user

Parameters

DatabaseBlock $block

Returns: bool

Definition at line 237 of file DatabaseBlock.php.

References MediaWiki\Block\AbstractBlock\getExpiry(), MediaWiki\Block\AbstractBlock\getHideName(), MediaWiki\Block\AbstractBlock\getReasonComment(), MediaWiki\Block\DatabaseBlock\getRestrictions(), MediaWiki\Block\DatabaseBlock\isAutoblocking(), MediaWiki\Block\AbstractBlock\isCreateAccountBlocked(), MediaWiki\Block\AbstractBlock\isEmailBlocked(), MediaWiki\Block\DatabaseBlock\isHardblock(), MediaWiki\Block\AbstractBlock\isSitewide(), and MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed().

◆ findRestriction()

MediaWiki\Block\DatabaseBlock::findRestriction	(	$type,
		$value
	)

private

Find Restriction by type and value.

Parameters

string	$type
int	$value

Returns: Restriction|null

Definition at line 1152 of file DatabaseBlock.php.

References $type.

◆ getAutoblockExpiry()

static MediaWiki\Block\DatabaseBlock::getAutoblockExpiry ( $timestamp )

static

Get a timestamp of the expiry for autoblocks.

Parameters

string | int $timestamp

Returns: string

Definition at line 856 of file DatabaseBlock.php.

References $wgAutoblockExpiry, and wfTimestamp().

◆ getBlocker()

MediaWiki\Block\DatabaseBlock::getBlocker ( )

Get the user who implemented this block.

Returns: UserIdentity|null user object or null. May be a foreign user.

Implements MediaWiki\Block\Block.

Definition at line 1195 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\DatabaseBlockStore\insertBlock(), and MediaWiki\Block\DatabaseBlockStore\updateBlock().

◆ getBlockRestrictionStore()

MediaWiki\Block\DatabaseBlock::getBlockRestrictionStore ( )

private

Get a BlockRestrictionStore instance.

Returns: BlockRestrictionStore

Definition at line 1172 of file DatabaseBlock.php.

◆ getBlocksForIPList()

static MediaWiki\Block\DatabaseBlock::getBlocksForIPList	(	array	$ipChain,
			$isAnon,
			$fromPrimary = `false`
	)

static

Get all blocks that match any IP from an array of IP addresses.

Parameters

array	$ipChain	List of IPs (strings), usually retrieved from the X-Forwarded-For header of the request
bool	$isAnon	Exclude anonymous-only blocks if false
bool	$fromPrimary	Whether to query the primary or replica DB

Returns: self[]

Since: 1.22

Definition at line 940 of file DatabaseBlock.php.

References DB_PRIMARY, DB_REPLICA, LIST_OR, and wfGetDB().

Referenced by MediaWiki\Block\BlockManager\getAdditionalIpBlocks().

◆ getBy()

MediaWiki\Block\DatabaseBlock::getBy ( )

Get the user id of the blocking sysop.

Returns: int (0 for foreign users)

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 1179 of file DatabaseBlock.php.

◆ getByName()

MediaWiki\Block\DatabaseBlock::getByName ( )

Get the username of the blocking sysop.

Returns: string

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 1186 of file DatabaseBlock.php.

◆ getId()

MediaWiki\Block\DatabaseBlock::getId ( )

Get the block ID.

Returns: int|null

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 775 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\BlockManager\getCookieValue(), MediaWiki\Block\DatabaseBlockStore\insertBlock(), MediaWiki\Block\BlockUser\log(), and MediaWiki\Block\DatabaseBlockStore\updateBlock().

◆ getIdentifier()

MediaWiki\Block\DatabaseBlock::getIdentifier ( )

Get the information that identifies this block, such that a user could look up everything that can be found about this block.Typically a scalar ID (integer or string), but can also return a list of IDs, or an associative array encoding a composite ID. Must be safe to serialize as JSON.

Returns: mixed Identifying information

Implements MediaWiki\Block\Block.

Definition at line 1015 of file DatabaseBlock.php.

◆ getIpFragment()

static MediaWiki\Block\DatabaseBlock::getIpFragment ( $hex )

staticprotected

Get the component of an IP address which is certain to be the same between an IP address and a rangeblock containing that IP address.

Parameters

string $hex Hexadecimal IP representation

Returns: string

Definition at line 447 of file DatabaseBlock.php.

References $wgBlockCIDRLimit.

Referenced by MediaWiki\Block\DatabaseBlock\getRangeCond().

◆ getParentBlockId()

MediaWiki\Block\DatabaseBlock::getParentBlockId ( )

Since: 1.34

Returns: int|null If this is an autoblock, ID of the parent block; otherwise null

Definition at line 802 of file DatabaseBlock.php.

◆ getQueryInfo()

static MediaWiki\Block\DatabaseBlock::getQueryInfo ( )

static

Return the tables, fields, and join conditions to be selected to create a new block object.

Since 1.34, ipb_by and ipb_by_text have not been present in the database, but they continue to be available in query results as aliases.

Since: 1.31

Returns

array With three keys:

tables: (string[]) to include in the $table to IDatabase->select()
fields: (string[]) to include in the $vars to IDatabase->select()
joins: (array) to include in the $join_conds to IDatabase->select()

Definition at line 199 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\newFromID(), and MediaWiki\Block\DatabaseBlock\newLoad().

◆ getRangeCond()

static MediaWiki\Block\DatabaseBlock::getRangeCond	(	$start,
		$end = `null`
	)

static

Get a set of SQL conditions which will select rangeblocks encompassing a given range.

Parameters

string	$start	Hexadecimal IP representation
string \| null	$end	Hexadecimal IP representation, or null to use $start = $end

Returns: string

Definition at line 414 of file DatabaseBlock.php.

References $dbr, DB_REPLICA, MediaWiki\Block\DatabaseBlock\getIpFragment(), LIST_AND, and wfGetDB().

Referenced by MediaWiki\Block\DatabaseBlock\newLoad().

◆ getRangeEnd()

MediaWiki\Block\DatabaseBlock::getRangeEnd ( )

Get the IP address at the end of the range in Hex form.

Exceptions

MWException

Returns: string IP in Hex form

Definition at line 747 of file DatabaseBlock.php.

References MediaWiki\Block\Block\TYPE_IP, MediaWiki\Block\Block\TYPE_RANGE, and MediaWiki\Block\Block\TYPE_USER.

◆ getRangeStart()

MediaWiki\Block\DatabaseBlock::getRangeStart ( )

Get the IP address at the start of the range in Hex form.

Exceptions

MWException

Returns: string IP in Hex form

Definition at line 728 of file DatabaseBlock.php.

References MediaWiki\Block\Block\TYPE_IP, MediaWiki\Block\Block\TYPE_RANGE, and MediaWiki\Block\Block\TYPE_USER.

◆ getRawRestrictions()

MediaWiki\Block\DatabaseBlock::getRawRestrictions ( )

Get restrictions without loading from database if not yet loaded.

Access: internal

Returns: ?Restriction[]

Definition at line 1045 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\DatabaseBlockStore\insertBlock(), and MediaWiki\Block\DatabaseBlockStore\updateBlock().

◆ getReason()

MediaWiki\Block\DatabaseBlock::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

Deprecated:: since 1.35. Use getReasonComment instead.

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 765 of file DatabaseBlock.php.

References MediaWiki\Block\DatabaseBlock\getType().

◆ getRedactedName()

MediaWiki\Block\DatabaseBlock::getRedactedName ( )

Get the block name, but with autoblocked IPs hidden as per standard privacy policy.

Returns: string Text is escaped

Definition at line 838 of file DatabaseBlock.php.

References wfMessage().

◆ getRestrictions()

MediaWiki\Block\DatabaseBlock::getRestrictions ( )

Getting the restrictions will perform a database query if the restrictions are not already loaded.

Since: 1.33

Returns: Restriction[]

Definition at line 1026 of file DatabaseBlock.php.

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

◆ getType()

MediaWiki\Block\DatabaseBlock::getType ( )

Get the type of target for this particular block.

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

Autoblocks have whichever type corresponds to their target, so to detect if a block is an autoblock, we have to check the mAuto property instead.

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 1006 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\getReason(), SpecialBlock\maybeAlterFormDefaults(), and MediaWiki\Block\BlockManager\shouldApplyCookieBlock().

◆ initFromRow()

MediaWiki\Block\DatabaseBlock::initFromRow ( $row )

protected

Given a database row from the ipblocks table, initialize member variables.

Parameters

stdClass $row A row from the ipblocks table

Definition at line 461 of file DatabaseBlock.php.

References DB_REPLICA, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Block\DatabaseBlock\isAutoblocking(), MediaWiki\Block\Block\isCreateAccountBlocked(), MediaWiki\Block\AbstractBlock\isEmailBlocked(), MediaWiki\Block\Block\isHardblock(), MediaWiki\Block\Block\isSitewide(), MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed(), MediaWiki\Block\DatabaseBlock\setBlocker(), MediaWiki\Block\AbstractBlock\setExpiry(), MediaWiki\Block\AbstractBlock\setHideName(), MediaWiki\Block\AbstractBlock\setReason(), MediaWiki\Block\AbstractBlock\setTarget(), MediaWiki\Block\AbstractBlock\setTimestamp(), wfGetDB(), and wfTimestamp().

Referenced by MediaWiki\Block\DatabaseBlock\newFromRow().

◆ insert()

MediaWiki\Block\DatabaseBlock::insert ( IDatabase $dbw = null )

Insert a block into the block table.

Will fail if there is a conflicting block (same name and options) already in the database.

Deprecated:: since 1.36 Use DatabaseBlockStore::insertBlock instead.

Parameters

IDatabase | null $dbw If you have one available

Returns: bool|array False on failure, assoc array on success: ('id' => block ID, 'autoIds' => array of autoblock IDs)

Definition at line 525 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ isAutoblocking()

MediaWiki\Block\DatabaseBlock::isAutoblocking ( $x = null )

Parameters

null | bool $x

Returns: bool

Definition at line 824 of file DatabaseBlock.php.

References wfSetVar().

Referenced by MediaWiki\Block\DatabaseBlock\__construct(), MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\DatabaseBlock\equals(), MediaWiki\Block\DatabaseBlock\initFromRow(), MediaWiki\Block\BlockManager\shouldApplyCookieBlock(), and MediaWiki\Block\DatabaseBlockStore\updateBlock().

◆ isExemptedFromAutoblocks()

static MediaWiki\Block\DatabaseBlock::isExemptedFromAutoblocks ( $ip )

static

Checks whether a given IP is on the autoblock exemption list.

TODO: this probably belongs somewhere else, but not sure where...

Since: 1.36

Parameters

string $ip The IP to check

Returns: bool

Definition at line 568 of file DatabaseBlock.php.

References $cache, $line, $lines, DB_REPLICA, MediaWiki\MediaWikiServices\getInstance(), wfDebug(), wfGetDB(), and wfMessage().

Referenced by MediaWiki\Block\DatabaseBlock\isWhitelistedFromAutoblocks().

◆ isExpired()

MediaWiki\Block\DatabaseBlock::isExpired ( )

Has the block expired?

Returns: bool

Definition at line 694 of file DatabaseBlock.php.

References MediaWiki\Block\AbstractBlock\getExpiry(), wfDebug(), and wfTimestampNow().

Referenced by MediaWiki\Block\BlockManager\shouldApplyCookieBlock().

◆ isHardblock()

MediaWiki\Block\DatabaseBlock::isHardblock ( $x = null )

Get/set whether the block is a hardblock (affects logged-in users on a given IP/range)

Parameters

bool | null $x

Returns: bool

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 811 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\equals().

◆ isWhitelistedFromAutoblocks()

static MediaWiki\Block\DatabaseBlock::isWhitelistedFromAutoblocks ( $ip )

static

Checks whether a given IP is on the autoblock exemption list.

Deprecated:: since 1.36; use DatabaseBlock::isExemptedFromAutoblocks()

Parameters

string $ip The IP to check

Returns: bool

Definition at line 553 of file DatabaseBlock.php.

References MediaWiki\Block\DatabaseBlock\isExemptedFromAutoblocks(), and wfDeprecated().

◆ newFromID()

static MediaWiki\Block\DatabaseBlock::newFromID ( $id )

static

Load a block from the block id.

Parameters

int $id id to search for

Returns: DatabaseBlock|null

Definition at line 167 of file DatabaseBlock.php.

References $dbr, $res, DB_REPLICA, MediaWiki\Block\DatabaseBlock\getQueryInfo(), MediaWiki\Block\DatabaseBlock\newFromRow(), and wfGetDB().

Referenced by MediaWiki\Block\BlockManager\getBlockFromCookieValue().

◆ newFromRow()

static MediaWiki\Block\DatabaseBlock::newFromRow ( $row )

static

Create a new DatabaseBlock object from a database row.

Parameters

stdClass $row Row from the ipblocks table

Returns: DatabaseBlock

Definition at line 497 of file DatabaseBlock.php.

References MediaWiki\Block\DatabaseBlock\initFromRow().

Referenced by MediaWiki\Block\DatabaseBlock\newFromID(), and MediaWiki\Block\DatabaseBlock\newLoad().

◆ newFromTarget()

static MediaWiki\Block\DatabaseBlock::newFromTarget	(	$specificTarget,
		$vagueTarget = `null`,
		$fromPrimary = `false`
	)

static

Given a target and the target's type, get an existing block object if possible.

Parameters

string \| UserIdentity \| int \| null	$specificTarget	A block target, which may be one of several types: A user to block, in which case $target will be a User An IP to block, in which case $target will be a User generated by using User::newFromName( $ip, false ) to turn off name validation An IP range, in which case $target will be a String "123.123.123.123/18" etc The ID of an existing block, in the format "#12345" (since pure numbers are valid usernames Calling this with a user, IP address or range will not select autoblocks, and will only select a block where the targets match exactly (so looking for blocks on 1.2.3.4 will not select 1.2.0.0/16 or even 1.2.3.4/32)
string \| UserIdentity \| int \| null	$vagueTarget	As above, but we will search for any block which affects that target (so for an IP address, get ranges containing that IP; and also get any relevant autoblocks). Leave empty or blank to skip IP-based lookups.
bool	$fromPrimary	Whether to use the DB_PRIMARY database

Returns: DatabaseBlock|null (null if no relevant block could be found). The target and type of the returned block will refer to the actual block which was found, which might not be the same as the target you gave if you used $vagueTarget!

Definition at line 891 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\UnblockUser\__construct(), and MediaWiki\Block\DatabaseBlock\doAutoblock().

◆ newListFromTarget()

static MediaWiki\Block\DatabaseBlock::newListFromTarget	(	$specificTarget,
		$vagueTarget = `null`,
		$fromPrimary = `false`
	)

static

This is similar to DatabaseBlock::newFromTarget, but it returns all the relevant blocks.

Since: 1.34

Parameters

string \| UserIdentity \| int \| null	$specificTarget
string \| UserIdentity \| int \| null	$vagueTarget
bool	$fromPrimary

Returns: DatabaseBlock[] Any relevant blocks

Definition at line 905 of file DatabaseBlock.php.

References $type.

Referenced by MediaWiki\Block\BlockManager\getUserBlock().

◆ newLoad()

static MediaWiki\Block\DatabaseBlock::newLoad	(	$specificTarget,
		$specificType,
		$fromPrimary,
		$vagueTarget = `null`
	)

staticprotected

Load blocks from the database which target the specific target exactly, or which cover the vague target.

Parameters

UserIdentity \| string \| null	$specificTarget
int \| null	$specificType
bool	$fromPrimary
UserIdentity \| string \| null	$vagueTarget	Also search for blocks affecting this target. Doesn't make any sense to use TYPE_AUTO / TYPE_ID here. Leave blank to skip IP lookups.

Exceptions

MWException

Returns: DatabaseBlock[] Any relevant blocks

Definition at line 271 of file DatabaseBlock.php.

References $res, MediaWiki\Block\AbstractBlock\$target, MediaWiki\Block\AbstractBlock\$type, DB_PRIMARY, DB_REPLICA, MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Block\DatabaseBlock\getQueryInfo(), MediaWiki\Block\DatabaseBlock\getRangeCond(), LIST_OR, MediaWiki\Block\DatabaseBlock\newFromRow(), MediaWiki\Block\Block\TYPE_IP, MediaWiki\Block\Block\TYPE_RANGE, MediaWiki\Block\Block\TYPE_USER, and wfGetDB().

◆ purgeExpired()

static MediaWiki\Block\DatabaseBlock::purgeExpired ( )

static

Purge expired blocks from the ipblocks table.

Deprecated:: since 1.36 Use DatabaseBlockStore::purgeExpiredBlocks instead.

Definition at line 867 of file DatabaseBlock.php.

◆ setBlocker()

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

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

Parameters

UserIdentity | string $user Local user object or username string. Calling with string is deprecated since 1.36

Definition at line 1205 of file DatabaseBlock.php.

References wfDeprecatedMsg().

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

◆ setId()

MediaWiki\Block\DatabaseBlock::setId ( $blockId )

Set the block ID.

Access: internal: Only for use in DatabaseBlockStore; private until 1.36

Parameters

int $blockId

Returns: self

Definition at line 786 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\DatabaseBlockStore\insertBlock().

◆ setRestrictions()

MediaWiki\Block\DatabaseBlock::setRestrictions ( array $restrictions )

Since: 1.33

Parameters

Restriction[] $restrictions

Returns: self

Definition at line 1054 of file DatabaseBlock.php.

◆ update()

MediaWiki\Block\DatabaseBlock::update ( )

Update a block in the DB with new parameters.

The ID field needs to be loaded first.

Deprecated:: since 1.36 Use DatabaseBlockStore::updateBlock instead.

Returns: bool|array False on failure, array on success: ('id' => block ID, 'autoIds' => array of autoblock IDs)

Definition at line 539 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ updateTimestamp()

MediaWiki\Block\DatabaseBlock::updateTimestamp ( )

Update the timestamp on autoblocks.

Definition at line 704 of file DatabaseBlock.php.

References DB_PRIMARY, MediaWiki\Block\AbstractBlock\getTimestamp(), MediaWiki\Block\AbstractBlock\setExpiry(), MediaWiki\Block\AbstractBlock\setTimestamp(), wfGetDB(), and wfTimestamp().

Member Data Documentation

◆ $blocker

UserIdentity null MediaWiki\Block\DatabaseBlock::$blocker

private

Definition at line 78 of file DatabaseBlock.php.

◆ $isAutoblocking

bool MediaWiki\Block\DatabaseBlock::$isAutoblocking

private

Definition at line 72 of file DatabaseBlock.php.

◆ $mAuto

bool MediaWiki\Block\DatabaseBlock::$mAuto

Deprecated:: since 1.34. Use getType to check whether a block is autoblocking.

Definition at line 57 of file DatabaseBlock.php.

◆ $mFromPrimary

bool MediaWiki\Block\DatabaseBlock::$mFromPrimary

private

Definition at line 69 of file DatabaseBlock.php.

◆ $mId

int MediaWiki\Block\DatabaseBlock::$mId

private

Definition at line 66 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\DatabaseBlock\doAutoblock().

◆ $mParentBlockId

int MediaWiki\Block\DatabaseBlock::$mParentBlockId

Deprecated:: since 1.34. Use getParentBlockId instead.

Definition at line 63 of file DatabaseBlock.php.

◆ $restrictions

Restriction [] MediaWiki\Block\DatabaseBlock::$restrictions

private

Definition at line 75 of file DatabaseBlock.php.

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

includes/block/DatabaseBlock.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appliesToNamespace()

◆ appliesToPage()

◆ appliesToRight()

◆ appliesToTitle()

◆ chooseMostSpecificBlock()

◆ delete()

◆ doAutoblock()

◆ equals()

◆ findRestriction()

◆ getAutoblockExpiry()

◆ getBlocker()

◆ getBlockRestrictionStore()

◆ getBlocksForIPList()

◆ getBy()

◆ getByName()

◆ getId()

◆ getIdentifier()

◆ getIpFragment()

◆ getParentBlockId()

◆ getQueryInfo()

◆ getRangeCond()

◆ getRangeEnd()

◆ getRangeStart()

◆ getRawRestrictions()

◆ getReason()

◆ getRedactedName()

◆ getRestrictions()

◆ getType()

◆ initFromRow()

◆ insert()

◆ isAutoblocking()

◆ isExemptedFromAutoblocks()

◆ isExpired()

◆ isHardblock()

◆ isWhitelistedFromAutoblocks()

◆ newFromID()

◆ newFromRow()

◆ newFromTarget()

◆ newListFromTarget()

◆ newLoad()

◆ purgeExpired()

◆ setBlocker()

◆ setId()

◆ setRestrictions()

◆ update()

◆ updateTimestamp()

Member Data Documentation

◆ $blocker

◆ $isAutoblocking

◆ $mAuto

◆ $mFromPrimary

◆ $mId

◆ $mParentBlockId

◆ $restrictions