Base class for block targets. More...

Inherits MediaWiki\DAO\WikiAwareEntity, and Stringable.

Inherited by MediaWiki\Block\AnonIpBlockTarget, MediaWiki\Block\AutoBlockTarget, MediaWiki\Block\RangeBlockTarget, and MediaWiki\Block\UserBlockTarget.

Collaboration diagram for MediaWiki\Block\BlockTarget:

[legend]

Public Member Functions
	__toString ()

	equals (?BlockTarget $other)
	Compare this object with another one.

	getLegacyTuple ()
	Get the target and type tuple conventionally returned by BlockUtils::parseBlockTarget()

	getLogPage ()
	Get the title to be used when logging an action on this block.

	getSpecificity ()
	Get the score of this block for purposes of choosing a more specific block, where lower is more specific.

	getType ()
	Get one of the Block::TYPE_xxx constants associated with this target.

	getWikiId ()
	Get the ID of the wiki this page belongs to. Returns string\|false The wiki's logical name, or self::LOCAL to indicate the local wiki.

	toString ()
	Get the username, the IP address, range, or autoblock ID prefixed with a "#".

	validateForCreation ()
	Check the target data against more stringent requirements imposed when a block is created from user input.

Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity
	assertWiki ( $wikiId)
	Throws if $wikiId is different from the return value of getWikiId().

Protected Member Functions
	__construct (string\|false $wikiId)

	getLegacyUnion ()
	Get the first part of the legacy tuple.

Protected Attributes
string false	$wikiId

Additional Inherited Members
Public Attributes inherited from MediaWiki\DAO\WikiAwareEntity
const	LOCAL = false
	Wiki ID value to use with instances that are defined relative to the local wiki.

Detailed Description

Base class for block targets.

Since: 1.44

Definition at line 17 of file BlockTarget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\BlockTarget::__construct ( string|false $wikiId )

protected

Parameters

string | false $wikiId UserIdentity and Block extend WikiAwareEntity and so we must ask for a wiki ID as well, to forward it through, even though we don't use it.

Definition at line 27 of file BlockTarget.php.

References MediaWiki\Block\BlockTarget\$wikiId.

Member Function Documentation

◆ __toString()

MediaWiki\Block\BlockTarget::__toString ( )

Definition at line 36 of file BlockTarget.php.

References MediaWiki\Block\BlockTarget\toString().

◆ equals()

MediaWiki\Block\BlockTarget::equals ( ?BlockTarget $other )

Compare this object with another one.

Parameters

BlockTarget | null $other

Returns: bool

Definition at line 46 of file BlockTarget.php.

References MediaWiki\Block\BlockTarget\toString().

Referenced by MediaWiki\Block\BlockPermissionChecker\checkBlockPermissions().

◆ getLegacyTuple()

MediaWiki\Block\BlockTarget::getLegacyTuple ( )

Get the target and type tuple conventionally returned by BlockUtils::parseBlockTarget()

Returns: array

Definition at line 98 of file BlockTarget.php.

◆ getLegacyUnion()

MediaWiki\Block\BlockTarget::getLegacyUnion ( )

abstractprotected

Get the first part of the legacy tuple.

Returns: UserIdentity|string

Reimplemented in MediaWiki\Block\AnonIpBlockTarget, MediaWiki\Block\AutoBlockTarget, MediaWiki\Block\RangeBlockTarget, and MediaWiki\Block\UserBlockTarget.

◆ getLogPage()

MediaWiki\Block\BlockTarget::getLogPage ( )

abstract

Get the title to be used when logging an action on this block.

For an autoblock, the title is technically invalid, with a hash character in the DB key. For a range block, the title is valid but is not a user page for a specific user.

See also getUserPage(), which exists only for subclasses which relate to a specific user with a talk page.