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

Inherits MediaWiki\Block\AbstractBlock.

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 hard blocks, 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 hard blocks, 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 ( $wikiId=self::LOCAL)

Get the user id of the blocking sysop.

Parameters

string | false $wikiId (since 1.38)

Returns: int (0 for foreign users)

getByName ()

Get the username of the blocking sysop.

Returns: string

getId ( $wikiId=self::LOCAL)

Get the block ID.

Parameters

string | false $wikiId (since 1.38)

Returns: ?int

getIdentifier ( $wikiId=self::LOCAL)

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.

Parameters

string | false $wikiId (since 1.38)

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.

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

Insert a block into the block table.

isAutoblocking ( $x=null)

Does the block cause autoblocks to be created?

isExpired ()

Has the block expired?

isHardblock ( $x=null)

Get/set whether the block is a hard block (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.

getReasonComment ()

Get the reason for creating the block.

getTargetName ()

getTargetUserIdentity ()

getTimestamp ()

Get the timestamp indicating when the block was created.

getWikiId ()

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

toArray ()

Public Member Functions inherited from MediaWiki\Block\Block

isCreateAccountBlocked ()

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

isHardblock ()

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

isSitewide ()

Get whether the block is a sitewide block.

Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity

assertWiki ( $wikiId)

Throws if $wikiId is different from the return value of getWikiId().

Static Public Member Functions
static	getAutoblockExpiry ( $timestamp)
	Get the expiry timestamp for an autoblock created at the given time.

static	getBlocksForIPList (array $ipChain, $applySoftBlocks, $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 range blocks encompassing a given range.

static	isExemptedFromAutoblocks ( $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.

Additional Inherited Members
Public Attributes inherited from MediaWiki\Block\Block
const	BLOCK_TYPES
	Map block types to strings, to allow convenient logging.

const	TYPE_AUTO = 4

const	TYPE_ID = 5

const	TYPE_IP = 2

const	TYPE_RANGE = 3

const	TYPE_USER = 1

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

bool	$blockCreateAccount = false

bool	$blockEmail = false

string	$expiry = ''

bool	$hideName = false

bool	$isHardblock

bool	$isSitewide = true

CommentStoreComment	$reason

UserIdentity string null	$target

string	$timestamp = ''

int null	$type
	AbstractBlock::TYPE_ constant.

string false	$wikiId

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 hard blocks, and they may be sitewide or partial.

Since: 1.34 Renamed from Block.

Definition at line 48 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:

auto: (bool) Is this an automatic block?
expiry: (string) Database timestamp of expiration of the block or 'infinity'
decodedExpiry: (string) The decoded expiry in MW 14-char format 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: (UserIdentity) UserIdentity object of the blocker.
restrictions: (Restriction[]) Array of partial block restrictions

Since: 1.26 $options array

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 87 of file DatabaseBlock.php.

References DB_REPLICA, 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(), and MediaWiki\Block\DatabaseBlock\setRestrictions().

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 600 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 hard blocks, range blocks, and auto-blocks).

Since: 1.33

Parameters

int $pageId

Returns: bool

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 618 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 636 of file DatabaseBlock.php.

◆ 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 hard blocks, range blocks, and auto-blocks).

Parameters

Title $title

Returns: bool

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 582 of file DatabaseBlock.php.

◆ delete()

MediaWiki\Block\DatabaseBlock::delete ( )

Delete the row from the IP blocks table.

Deprecated: since 1.36 Use DatabaseBlockStore::deleteBlock instead.

Returns: bool

Definition at line 232 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Block\AbstractBlock\getWikiId().

◆ doAutoblock()

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

Autoblocks the given IP, referring to this block.

Deprecated: since 1.42, use DatabaseBlockStore::doAutoblock instead

Parameters

string $autoblockIP The IP to autoblock.

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

Definition at line 292 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Block\AbstractBlock\getWikiId().

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

◆ getAutoblockExpiry()

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

static

Get the expiry timestamp for an autoblock created at the given time.

Deprecated: since 1.42 No replacement, no known callers.

Parameters

string | int $timestamp

Returns: string

Definition at line 450 of file DatabaseBlock.php.

References wfDeprecated().

◆ 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 716 of file DatabaseBlock.php.

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

◆ getBlocksForIPList()

static MediaWiki\Block\DatabaseBlock::getBlocksForIPList	(	array	$ipChain,
			$applySoftBlocks,
			$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	$applySoftBlocks	Include soft blocks (anonymous-only blocks). These should only block anonymous and temporary users.
bool	$fromPrimary	Whether to query the primary or replica DB

Returns: self[]

Since: 1.22

Definition at line 515 of file DatabaseBlock.php.

◆ getBy()

MediaWiki\Block\DatabaseBlock::getBy ( $wikiId = self::LOCAL )

Get the user id of the blocking sysop.

Parameters

string | false $wikiId (since 1.38)

Returns: int (0 for foreign users)

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 699 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 707 of file DatabaseBlock.php.

◆ getId()

MediaWiki\Block\DatabaseBlock::getId ( $wikiId = self::LOCAL )

Get the block ID.

Parameters

string | false $wikiId (since 1.38)

Returns: ?int

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 361 of file DatabaseBlock.php.

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

◆ getIdentifier()

MediaWiki\Block\DatabaseBlock::getIdentifier ( $wikiId = self::LOCAL )

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.

Parameters

string | false $wikiId (since 1.38)

Returns: mixed Identifying information

Implements MediaWiki\Block\Block.

Definition at line 535 of file DatabaseBlock.php.

◆ 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 389 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.

Deprecated: since 1.43, use DatabaseBlockStore::getQueryInfo()

Since: 1.31

Returns

array[] With three keys:

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

Definition at line 165 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Block\DatabaseBlockStore\SCHEMA_IPBLOCKS, and wfDeprecated().

◆ getRangeCond()

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

static

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

Deprecated: since 1.43 use DatabaseBlockStore::getRangeCond

Parameters

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

Returns: string

Definition at line 209 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Block\DatabaseBlockStore\SCHEMA_IPBLOCKS, and wfDeprecated().

◆ getRangeEnd()

MediaWiki\Block\DatabaseBlock::getRangeEnd ( )

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

Returns: string IP in Hex form

Definition at line 344 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.

Returns: string IP in Hex form

Definition at line 326 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 565 of file DatabaseBlock.php.

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

◆ 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 430 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 546 of file DatabaseBlock.php.

Referenced by MediaWiki\Block\DatabaseBlockStore\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 526 of file DatabaseBlock.php.

Referenced by MediaWiki\Specials\SpecialBlock\maybeAlterFormDefaults(), and MediaWiki\Block\DatabaseBlockStore\updateTimestamp().

◆ insert()

MediaWiki\Block\DatabaseBlock::insert ( )

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. Passing a custom db connection is no longer supported since 1.42.

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

Definition at line 249 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Block\AbstractBlock\getWikiId().

◆ isAutoblocking()

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

Does the block cause autoblocks to be created?

Parameters

null | bool $x

Returns: bool

Definition at line 416 of file DatabaseBlock.php.

References wfSetVar().

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

◆ isExemptedFromAutoblocks()

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

static

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

Since: 1.36

Parameters

string $ip The IP to check

Returns: bool

Definition at line 279 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ isExpired()

MediaWiki\Block\DatabaseBlock::isExpired ( )

Has the block expired?

Returns: bool

Definition at line 303 of file DatabaseBlock.php.

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

◆ isHardblock()

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

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

Parameters

bool | null $x

Returns: bool

Reimplemented from MediaWiki\Block\AbstractBlock.

Definition at line 401 of file DatabaseBlock.php.

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

◆ newFromID()

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

static

Load a block from the block ID.

Deprecated: since 1.42 use DatabaseBlockStore::newFromID()

Parameters

int $id ID to search for

Returns: DatabaseBlock|null

Definition at line 139 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), and wfDeprecated().

◆ 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 220 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ 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 477 of file DatabaseBlock.php.

◆ 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 495 of file DatabaseBlock.php.

◆ setBlocker()

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

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

Parameters

UserIdentity $user

Definition at line 725 of file DatabaseBlock.php.

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

◆ 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 373 of file DatabaseBlock.php.

◆ setRestrictions()

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

Since: 1.33

Parameters

Restriction[] $restrictions

Returns: self

Definition at line 574 of file DatabaseBlock.php.

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

◆ 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 264 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Block\AbstractBlock\getWikiId().

◆ updateTimestamp()

MediaWiki\Block\DatabaseBlock::updateTimestamp ( )

Update the timestamp on autoblocks.

Deprecated: since 1.42, use DatabaseBlockStore::updateTimestamp instead

Definition at line 315 of file DatabaseBlock.php.

References MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\Block\AbstractBlock\getWikiId().

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

includes/block/DatabaseBlock.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appliesToNamespace()

◆ appliesToPage()

◆ appliesToRight()

◆ appliesToTitle()

◆ delete()

◆ doAutoblock()

◆ equals()

◆ getAutoblockExpiry()

◆ getBlocker()

◆ getBlocksForIPList()

◆ getBy()

◆ getByName()

◆ getId()

◆ getIdentifier()

◆ getParentBlockId()

◆ getQueryInfo()

◆ getRangeCond()

◆ getRangeEnd()

◆ getRangeStart()

◆ getRawRestrictions()

◆ getRedactedName()

◆ getRestrictions()

◆ getType()

◆ insert()

◆ isAutoblocking()

◆ isExemptedFromAutoblocks()

◆ isExpired()

◆ isHardblock()

◆ newFromID()

◆ newFromRow()

◆ newFromTarget()

◆ newListFromTarget()

◆ setBlocker()

◆ setId()

◆ setRestrictions()

◆ update()

◆ updateTimestamp()