A block target for a registered user. More...

Inherits MediaWiki\Block\BlockTarget, and MediaWiki\Block\BlockTargetWithUserPage.

Collaboration diagram for MediaWiki\Block\UserBlockTarget:

[legend]

Public Member Functions
	__construct (UserIdentity $userIdentity)

	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.

	getUserIdentity ()
	Get a UserIdentity associated with this target.

	getUserPage ()
	Get the target's user page.

	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\Block\BlockTarget
	__toString ()

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

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

	getWikiId ()
	Get the ID of the wiki this page belongs to.

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

Protected Member Functions
	getLegacyUnion ()
	Get the first part of the legacy tuple.

Protected Member Functions inherited from MediaWiki\Block\BlockTarget
	__construct ( $wikiId)

Additional Inherited Members
Protected Attributes inherited from MediaWiki\Block\BlockTarget
string false	$wikiId

Detailed Description

A block target for a registered user.

Since: 1.44

Definition at line 15 of file UserBlockTarget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\UserBlockTarget::__construct ( UserIdentity $userIdentity )

Definition at line 18 of file UserBlockTarget.php.

References MediaWiki\DAO\WikiAwareEntity\getWikiId().

Member Function Documentation

◆ getLegacyUnion()

MediaWiki\Block\UserBlockTarget::getLegacyUnion ( )

protected

Get the first part of the legacy tuple.

Returns: UserIdentity|string

Reimplemented from MediaWiki\Block\BlockTarget.

Definition at line 57 of file UserBlockTarget.php.

◆ getLogPage()

MediaWiki\Block\UserBlockTarget::getLogPage ( )

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.