Collaboration diagram for MediaWiki\Block\DatabaseBlockStore:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, LoggerInterface $logger, ActorStoreFactory $actorStoreFactory, BlockRestrictionStore $blockRestrictionStore, CommentStore $commentStore, HookContainer $hookContainer, ILoadBalancer $loadBalancer, ReadOnlyMode $readOnlyMode, UserFactory $userFactory)

	deleteBlock (DatabaseBlock $block)
	Delete a DatabaseBlock from the database. More...

	insertBlock (DatabaseBlock $block, IDatabase $database=null)
	Insert a block into the block table. More...

	purgeExpiredBlocks ()
	Delete expired blocks from the ipblocks table. More...

	updateBlock (DatabaseBlock $block)
	Update a block in the DB with new parameters. More...

Public Attributes
const	CONSTRUCTOR_OPTIONS

Private Member Functions
	checkDatabaseDomain (?IDatabase $db, $expectedWiki)
	Throws an exception if the given database connection does not match the given wiki ID. More...

	doRetroactiveAutoblock (DatabaseBlock $block)
	Handles retroactively autoblocking the last IP used by the user (if it is a user) blocked by an auto block. More...

	getArrayForAutoblockUpdate (DatabaseBlock $block)
	Get an array suitable for autoblock updates. More...

	getArrayForDatabaseBlock (DatabaseBlock $block, IDatabase $dbw)
	Get an array suitable for passing to $dbw->insert() or $dbw->update() More...

	performRetroactiveAutoblock (DatabaseBlock $block)
	Actually retroactively autoblocks the last IP used by the user (if it is a user) blocked by this block. More...

Private Attributes
ActorStoreFactory	$actorStoreFactory

BlockRestrictionStore	$blockRestrictionStore

CommentStore	$commentStore

HookRunner	$hookRunner

ILoadBalancer	$loadBalancer

LoggerInterface	$logger

ServiceOptions	$options

ReadOnlyMode	$readOnlyMode

UserFactory	$userFactory

Detailed Description

Since: 1.36

Author: DannyS712

Definition at line 47 of file DatabaseBlockStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Block\DatabaseBlockStore::__construct	(	ServiceOptions	$options,
		LoggerInterface	$logger,
		ActorStoreFactory	$actorStoreFactory,
		BlockRestrictionStore	$blockRestrictionStore,
		CommentStore	$commentStore,
		HookContainer	$hookContainer,
		ILoadBalancer	$loadBalancer,
		ReadOnlyMode	$readOnlyMode,
		UserFactory	$userFactory
	)

Parameters

ServiceOptions	$options
LoggerInterface	$logger
ActorStoreFactory	$actorStoreFactory
BlockRestrictionStore	$blockRestrictionStore
CommentStore	$commentStore
HookContainer	$hookContainer
ILoadBalancer	$loadBalancer
ReadOnlyMode	$readOnlyMode
UserFactory	$userFactory

Definition at line 95 of file DatabaseBlockStore.php.

References MediaWiki\Block\DatabaseBlockStore\$actorStoreFactory, MediaWiki\Block\DatabaseBlockStore\$blockRestrictionStore, MediaWiki\Block\DatabaseBlockStore\$commentStore, MediaWiki\Block\DatabaseBlockStore\$loadBalancer, MediaWiki\Block\DatabaseBlockStore\$logger, MediaWiki\Block\DatabaseBlockStore\$options, MediaWiki\Block\DatabaseBlockStore\$readOnlyMode, MediaWiki\Block\DatabaseBlockStore\$userFactory, and MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ checkDatabaseDomain()

MediaWiki\Block\DatabaseBlockStore::checkDatabaseDomain	(	?IDatabase	$db,
			$expectedWiki
	)

private

Throws an exception if the given database connection does not match the given wiki ID.

Parameters

	?IDatabase	$db
string \| false	$expectedWiki

Definition at line 157 of file DatabaseBlockStore.php.

References Wikimedia\Rdbms\IDatabase\getDomainID().

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

◆ deleteBlock()

MediaWiki\Block\DatabaseBlockStore::deleteBlock ( DatabaseBlock $block )

Delete a DatabaseBlock from the database.

Parameters

DatabaseBlock $block

Returns: bool whether it was deleted

Exceptions

MWException

Definition at line 345 of file DatabaseBlockStore.php.

References DB_PRIMARY, and MediaWiki\Block\DatabaseBlock\getId().

◆ doRetroactiveAutoblock()

MediaWiki\Block\DatabaseBlockStore::doRetroactiveAutoblock ( DatabaseBlock $block )

private

Handles retroactively autoblocking the last IP used by the user (if it is a user) blocked by an auto block.

Parameters

DatabaseBlock $block

Returns: array IDs of retroactive autoblocks made

Definition at line 470 of file DatabaseBlockStore.php.

References MediaWiki\Block\AbstractBlock\getTargetName(), MediaWiki\Block\DatabaseBlock\getType(), MediaWiki\Block\DatabaseBlock\isAutoblocking(), MediaWiki\Block\DatabaseBlockStore\performRetroactiveAutoblock(), and MediaWiki\Block\Block\TYPE_USER.

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

◆ getArrayForAutoblockUpdate()

MediaWiki\Block\DatabaseBlockStore::getArrayForAutoblockUpdate ( DatabaseBlock $block )

private

Get an array suitable for autoblock updates.

Parameters

DatabaseBlock $block

Returns: array

Definition at line 437 of file DatabaseBlockStore.php.

References DB_PRIMARY, MediaWiki\Block\DatabaseBlock\getBlocker(), MediaWiki\Block\AbstractBlock\getHideName(), MediaWiki\Block\AbstractBlock\getReasonComment(), MediaWiki\Block\AbstractBlock\isCreateAccountBlocked(), MediaWiki\Block\AbstractBlock\isSitewide(), and MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed().

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

◆ getArrayForDatabaseBlock()

MediaWiki\Block\DatabaseBlockStore::getArrayForDatabaseBlock	(	DatabaseBlock	$block,
		IDatabase	$dbw
	)

private

Get an array suitable for passing to $dbw->insert() or $dbw->update()

Parameters

DatabaseBlock	$block
IDatabase	$dbw	Database to use if not the same as the one in the load balancer. Must connect to the wiki identified by $block->getBlocker->getWikiId().

Returns: array

Definition at line 384 of file DatabaseBlockStore.php.

References Wikimedia\Rdbms\IDatabase\encodeExpiry(), MediaWiki\Block\DatabaseBlock\getBlocker(), Wikimedia\Rdbms\IDatabase\getDomainID(), MediaWiki\Block\AbstractBlock\getExpiry(), MediaWiki\Block\AbstractBlock\getHideName(), MediaWiki\Block\DatabaseBlock\getParentBlockId(), MediaWiki\Block\DatabaseBlock\getRangeEnd(), MediaWiki\Block\DatabaseBlock\getRangeStart(), MediaWiki\Block\AbstractBlock\getReasonComment(), MediaWiki\Block\AbstractBlock\getTargetName(), MediaWiki\Block\AbstractBlock\getTargetUserIdentity(), MediaWiki\Block\AbstractBlock\getTimestamp(), MediaWiki\Block\DatabaseBlock\getType(), MediaWiki\Block\DatabaseBlock\isAutoblocking(), MediaWiki\Block\AbstractBlock\isCreateAccountBlocked(), MediaWiki\Block\AbstractBlock\isEmailBlocked(), MediaWiki\Block\DatabaseBlock\isHardblock(), MediaWiki\Block\AbstractBlock\isSitewide(), MediaWiki\Block\AbstractBlock\isUsertalkEditAllowed(), Wikimedia\Rdbms\IDatabase\timestamp(), and MediaWiki\Block\Block\TYPE_AUTO.

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

◆ insertBlock()

MediaWiki\Block\DatabaseBlockStore::insertBlock	(	DatabaseBlock	$block,
		IDatabase	$database = `null`
	)

Insert a block into the block table.

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

Parameters

DatabaseBlock	$block
IDatabase \| null	$database	Database to use if not the same as the one in the load balancer. Must connect to the wiki identified by $block->getBlocker->getWikiId().

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

Exceptions

MWException

Definition at line 186 of file DatabaseBlockStore.php.

◆ performRetroactiveAutoblock()

MediaWiki\Block\DatabaseBlockStore::performRetroactiveAutoblock ( DatabaseBlock $block )

private

Actually retroactively autoblocks the last IP used by the user (if it is a user) blocked by this block.

This will use the recentchanges table.

Parameters

DatabaseBlock $block

Returns: array

Definition at line 501 of file DatabaseBlockStore.php.

References $dbr, $type, DB_REPLICA, MediaWiki\Block\DatabaseBlock\doAutoblock(), MediaWiki\Block\AbstractBlock\getTargetUserIdentity(), MediaWiki\Block\DatabaseBlock\getType(), and MediaWiki\Block\Block\TYPE_USER.

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

◆ purgeExpiredBlocks()

MediaWiki\Block\DatabaseBlockStore::purgeExpiredBlocks ( )

Delete expired blocks from the ipblocks table.

Access: internal: only public for use in DatabaseBlock

Definition at line 124 of file DatabaseBlockStore.php.

References MediaWiki\Block\DatabaseBlockStore\$blockRestrictionStore, Wikimedia\Rdbms\IDatabase\addQuotes(), DeferredUpdates\addUpdate(), DB_PRIMARY, Wikimedia\Rdbms\IDatabase\delete(), MediaWiki\Block\BlockRestrictionStore\deleteByBlockId(), if, Wikimedia\Rdbms\IDatabase\selectFieldValues(), and Wikimedia\Rdbms\IDatabase\timestamp().

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

◆ updateBlock()

MediaWiki\Block\DatabaseBlockStore::updateBlock ( DatabaseBlock $block )

Update a block in the DB with new parameters.

The ID field needs to be loaded first.

Parameters

DatabaseBlock $block

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

Definition at line 268 of file DatabaseBlockStore.php.

References $success, DB_PRIMARY, MediaWiki\Block\DatabaseBlockStore\doRetroactiveAutoblock(), MediaWiki\Block\DatabaseBlockStore\getArrayForAutoblockUpdate(), MediaWiki\Block\DatabaseBlockStore\getArrayForDatabaseBlock(), MediaWiki\Block\DatabaseBlock\getBlocker(), MediaWiki\Block\DatabaseBlock\getId(), MediaWiki\Block\DatabaseBlock\getRawRestrictions(), MediaWiki\Block\AbstractBlock\getTimestamp(), and MediaWiki\Block\DatabaseBlock\isAutoblocking().

Member Data Documentation

◆ $actorStoreFactory

ActorStoreFactory MediaWiki\Block\DatabaseBlockStore::$actorStoreFactory

private

Definition at line 64 of file DatabaseBlockStore.php.

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

◆ $blockRestrictionStore

BlockRestrictionStore MediaWiki\Block\DatabaseBlockStore::$blockRestrictionStore

private

Definition at line 67 of file DatabaseBlockStore.php.

Referenced by MediaWiki\Block\DatabaseBlockStore\__construct(), and MediaWiki\Block\DatabaseBlockStore\purgeExpiredBlocks().

◆ $commentStore

CommentStore MediaWiki\Block\DatabaseBlockStore::$commentStore

private

Definition at line 70 of file DatabaseBlockStore.php.

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

◆ $hookRunner

HookRunner MediaWiki\Block\DatabaseBlockStore::$hookRunner

private

Definition at line 73 of file DatabaseBlockStore.php.

◆ $loadBalancer

ILoadBalancer MediaWiki\Block\DatabaseBlockStore::$loadBalancer

private

Definition at line 76 of file DatabaseBlockStore.php.

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

◆ $logger

LoggerInterface MediaWiki\Block\DatabaseBlockStore::$logger

private

Definition at line 61 of file DatabaseBlockStore.php.

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

◆ $options

ServiceOptions MediaWiki\Block\DatabaseBlockStore::$options

private

Definition at line 50 of file DatabaseBlockStore.php.

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

◆ $readOnlyMode

ReadOnlyMode MediaWiki\Block\DatabaseBlockStore::$readOnlyMode

private

Definition at line 79 of file DatabaseBlockStore.php.

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

◆ $userFactory

UserFactory MediaWiki\Block\DatabaseBlockStore::$userFactory

private

Definition at line 82 of file DatabaseBlockStore.php.

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

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Block\DatabaseBlockStore::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'PutIPinRC',
        'BlockDisablesLogin',
    ]

Access: internal: For use by ServiceWiring

Definition at line 55 of file DatabaseBlockStore.php.

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

includes/block/DatabaseBlockStore.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDatabaseDomain()

◆ deleteBlock()

◆ doRetroactiveAutoblock()

◆ getArrayForAutoblockUpdate()

◆ getArrayForDatabaseBlock()

◆ insertBlock()

◆ performRetroactiveAutoblock()

◆ purgeExpiredBlocks()

◆ updateBlock()

Member Data Documentation

◆ $actorStoreFactory

◆ $blockRestrictionStore

◆ $commentStore

◆ $hookRunner

◆ $loadBalancer

◆ $logger

◆ $options

◆ $readOnlyMode

◆ $userFactory

◆ CONSTRUCTOR_OPTIONS