Storage layer class for WatchedItems. More...

Inheritance diagram for WatchedItemStore:

Collaboration diagram for WatchedItemStore:

Public Member Functions
	__construct (LoadBalancer $loadBalancer, HashBagOStuff $cache)

	addWatch (User $user, LinkTarget $target)
	Must be called separately for Subject & Talk namespaces. More...

	addWatchBatchForUser (User $user, array $targets)

	countUnreadNotifications (User $user, $unreadLimit=null)

	countVisitingWatchers (LinkTarget $target, $threshold)
	Number of page watchers who also visited a "recent" edit. More...

	countVisitingWatchersMultiple (array $targetsWithVisitThresholds, $minimumWatchers=null)
	Number of watchers of each page who have visited recent edits to that page. More...

	countWatchedItems (User $user)
	Count the number of individual items that are watched by the user. More...

	countWatchers (LinkTarget $target)

	countWatchersMultiple (array $targets, array $options=[])

	duplicateAllAssociatedEntries (LinkTarget $oldTarget, LinkTarget $newTarget)
	Check if the given title already is watched by the user, and if so add a watch for the new title. More...

	duplicateEntry (LinkTarget $oldTarget, LinkTarget $newTarget)
	Check if the given title already is watched by the user, and if so add a watch for the new title. More...

	getNotificationTimestampsBatch (User $user, array $targets)

	getWatchedItem (User $user, LinkTarget $target)
	Get an item (may be cached) More...

	getWatchedItemsForUser (User $user, array $options=[])

	isWatched (User $user, LinkTarget $target)
	Must be called separately for Subject & Talk namespaces. More...

	loadWatchedItem (User $user, LinkTarget $target)
	Loads an item from the db. More...

	overrideDeferredUpdatesAddCallableUpdateCallback ($callback)
	Overrides the DeferredUpdates::addCallableUpdate callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined. More...

	overrideRevisionGetTimestampFromIdCallback ($callback)
	Overrides the Revision::getTimestampFromId callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined. More...

	removeWatch (User $user, LinkTarget $target)
	Removes the an entry for the User watching the LinkTarget Must be called separately for Subject & Talk namespaces. More...

	resetNotificationTimestamp (User $user, Title $title, $force= '', $oldid=0)
	Reset the notification timestamp of this entry. More...

	setStatsdDataFactory (StatsdDataFactoryInterface $stats)
	Sets a StatsdDataFactory instance on the object. More...

	updateNotificationTimestamp (User $editor, LinkTarget $target, $timestamp)

Static Public Member Functions
static	getDefaultInstance ()

static	overrideDefaultInstance (WatchedItemStore $store=null)
	Overrides the default instance of this class This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined. More...

Public Attributes
const	SORT_ASC = 'ASC'

const	SORT_DESC = 'DESC'

Private Member Functions
	cache (WatchedItem $item)

	dbCond (User $user, LinkTarget $target)
	Return an array of conditions to select or update the appropriate database row. More...

	getCached (User $user, LinkTarget $target)

	getCacheKey (User $user, LinkTarget $target)

	getConnection ($slaveOrMaster)

	getNotificationTimestamp (User $user, Title $title, $item, $force, $oldid)

	getVisitingWatchersCondition (IDatabase $db, array $targetsWithVisitThresholds)
	Generates condition for the query used in a batch count visiting watchers. More...

	reuseConnection ($connection)

	uncache (User $user, LinkTarget $target)

	uncacheLinkTarget (LinkTarget $target)

Private Attributes
HashBagOStuff	$cache

array[]	$cacheIndex = []
	Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => 'key' The index is needed so that on mass changes all relevant items can be un-cached. More...

callable null	$deferredUpdatesAddCallableUpdateCallback

LoadBalancer	$loadBalancer

callable null	$revisionGetTimestampFromIdCallback

StatsdDataFactoryInterface	$stats

Static Private Attributes
static self null	$instance

Detailed Description

Storage layer class for WatchedItems.

Database interaction.

Author: Addshore

Since: 1.27

Definition at line 15 of file WatchedItemStore.php.

Constructor & Destructor Documentation

WatchedItemStore::__construct	(	LoadBalancer	$loadBalancer,
		HashBagOStuff	$cache
	)

Parameters

LoadBalancer	$loadBalancer
HashBagOStuff	$cache

Definition at line 62 of file WatchedItemStore.php.

References $cache, $loadBalancer, and cache().

Member Function Documentation

WatchedItemStore::addWatch	(	User	$user,
		LinkTarget	$target
	)

Must be called separately for Subject & Talk namespaces.

Parameters

User	$user
LinkTarget	$target

Definition at line 636 of file WatchedItemStore.php.

References addWatchBatchForUser().

WatchedItemStore::addWatchBatchForUser	(	User	$user,
		array	$targets
	)

Parameters

User	$user
	LinkTarget[]	$targets

Returns: bool success

Definition at line 646 of file WatchedItemStore.php.

References as, DB_MASTER, false, getConnection(), User\getId(), User\isAnon(), reuseConnection(), and uncache().

Referenced by addWatch().

WatchedItemStore::cache ( WatchedItem $item )

private

Definition at line 176 of file WatchedItemStore.php.

References $key, $user, getCacheKey(), WatchedItem\getLinkTarget(), and WatchedItem\getUser().

Referenced by __construct(), getCached(), getCacheKey(), loadWatchedItem(), uncache(), and uncacheLinkTarget().

WatchedItemStore::countUnreadNotifications	(	User	$user,
			$unreadLimit = `null`
	)

Parameters

User	$user
int	$unreadLimit

Returns: int|bool The number of unread notifications true if greater than or equal to $unreadLimit

Definition at line 868 of file WatchedItemStore.php.

References $dbr, DB_SLAVE, getConnection(), User\getId(), and reuseConnection().

WatchedItemStore::countVisitingWatchers	(	LinkTarget	$target,
			$threshold
	)

Number of page watchers who also visited a "recent" edit.

Parameters

LinkTarget	$target
mixed	$threshold	timestamp accepted by wfTimestamp

Returns: int

Exceptions

DBUnexpectedError
MWException

Definition at line 302 of file WatchedItemStore.php.

References $dbr, DB_SLAVE, getConnection(), MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), and reuseConnection().

WatchedItemStore::countVisitingWatchersMultiple	(	array	$targetsWithVisitThresholds,
			$minimumWatchers = `null`
	)

Number of watchers of each page who have visited recent edits to that page.

Parameters

array	$targetsWithVisitThresholds	array of pairs (LinkTarget $target, mixed $threshold), $threshold is: a timestamp of the recent edit if $target exists (format accepted by wfTimestamp) null if $target doesn't exist
int \| null	$minimumWatchers

Returns

array multi-dimensional like $return[$namespaceId][$titleString] = $watchers, where $watchers is an int:

if the page exists, number of users watching who have visited the page recently
if the page doesn't exist, number of users that have the page on their watchlist
0 means there are no visiting watchers or their number is below the minimumWatchers option (if passed).

Definition at line 377 of file WatchedItemStore.php.

References $dbr, $res, as, DB_SLAVE, getConnection(), getVisitingWatchersCondition(), list, and reuseConnection().

WatchedItemStore::countWatchedItems ( User $user )

Count the number of individual items that are watched by the user.

If a subject and corresponding talk page are watched this will return 2.

Parameters

User $user

Returns: int

Definition at line 256 of file WatchedItemStore.php.

References $dbr, DB_SLAVE, getConnection(), User\getId(), and reuseConnection().

WatchedItemStore::countWatchers ( LinkTarget $target )

Parameters

LinkTarget $target

Returns: int

Definition at line 276 of file WatchedItemStore.php.

References $dbr, DB_SLAVE, getConnection(), MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), and reuseConnection().

WatchedItemStore::countWatchersMultiple	(	array	$targets,
		array	$options = `[]`
	)

Parameters

	LinkTarget[]	$targets
array	$options	Allowed keys: 'minimumWatchers' => int

Returns: array multi dimensional like $return[$namespaceId][$titleString] = int $watchers All targets will be present in the result. 0 either means no watchers or the number of watchers was below the minimumWatchers option if passed.

Definition at line 330 of file WatchedItemStore.php.

References $dbr, $options, $res, as, DB_SLAVE, getConnection(), and reuseConnection().

WatchedItemStore::dbCond	(	User	$user,
		LinkTarget	$target
	)

private

Return an array of conditions to select or update the appropriate database row.

Parameters

User	$user
LinkTarget	$target

Returns: array

Definition at line 221 of file WatchedItemStore.php.

References MediaWiki\Linker\LinkTarget\getDBkey(), User\getId(), and MediaWiki\Linker\LinkTarget\getNamespace().

Referenced by loadWatchedItem().

WatchedItemStore::duplicateAllAssociatedEntries	(	LinkTarget	$oldTarget,
		LinkTarget	$newTarget
	)

Check if the given title already is watched by the user, and if so add a watch for the new title.

To be used for page renames and such.

Parameters

LinkTarget	$oldTarget
LinkTarget	$newTarget

Definition at line 908 of file WatchedItemStore.php.

References duplicateEntry(), and Title\newFromLinkTarget().

WatchedItemStore::duplicateEntry	(	LinkTarget	$oldTarget,
		LinkTarget	$newTarget
	)

Check if the given title already is watched by the user, and if so add a watch for the new title.

To be used for page renames and such. This must be called separately for Subject and Talk pages

Parameters

LinkTarget	$oldTarget
LinkTarget	$newTarget

Definition at line 926 of file WatchedItemStore.php.

References as, DB_MASTER, getConnection(), MediaWiki\Linker\LinkTarget\getDBkey(), MediaWiki\Linker\LinkTarget\getNamespace(), and reuseConnection().

Referenced by duplicateAllAssociatedEntries().

WatchedItemStore::getCached	(	User	$user,
		LinkTarget	$target
	)

private

Parameters

User	$user
LinkTarget	$target

Returns: WatchedItem|null

Definition at line 208 of file WatchedItemStore.php.

References cache(), and getCacheKey().

Referenced by getNotificationTimestampsBatch(), and getWatchedItem().

WatchedItemStore::getCacheKey	(	User	$user,
		LinkTarget	$target
	)

private

Definition at line 168 of file WatchedItemStore.php.

References cache(), MediaWiki\Linker\LinkTarget\getDBkey(), User\getId(), MediaWiki\Linker\LinkTarget\getNamespace(), and string.

Referenced by cache(), getCached(), and uncache().

WatchedItemStore::getConnection ( $slaveOrMaster )

private

Parameters

int $slaveOrMaster DB_MASTER or DB_SLAVE

Returns: DatabaseBase

Exceptions

MWException

Definition at line 235 of file WatchedItemStore.php.

Referenced by addWatchBatchForUser(), countUnreadNotifications(), countVisitingWatchers(), countVisitingWatchersMultiple(), countWatchedItems(), countWatchers(), countWatchersMultiple(), duplicateEntry(), getNotificationTimestampsBatch(), getWatchedItemsForUser(), loadWatchedItem(), removeWatch(), and updateNotificationTimestamp().

static WatchedItemStore::getDefaultInstance ( )

static

Returns: self

Definition at line 157 of file WatchedItemStore.php.

References RequestContext\getMain(), and wfGetLB().

Referenced by User\addWatch(), WatchedItem\batchAddWatch(), SpecialEditWatchlist\cleanupWatchlist(), User\clearNotification(), SpecialWatchlist\countItems(), WatchedItem\duplicateEntries(), ApiQueryUserInfo\getCurrentUserInfo(), WatchedItem\getNotificationTimestamp(), Title\getNotificationTimestamp(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryInfo\getWatchedInfo(), ApiQueryInfo\getWatcherInfo(), SpecialEditWatchlist\getWatchlist(), SpecialEditWatchlist\getWatchlistInfo(), User\isWatched(), MovePage\move(), EmailNotification\notifyOnPageChange(), SpecialRecentChanges\outputChangesList(), SpecialWatchlist\outputChangesList(), InfoAction\pageCounts(), User\removeWatch(), WatchedItem\resetNotificationTimestamp(), WatchedItemStoreIntegrationTest\testDuplicateAllAssociatedEntries(), WatchedItemStoreUnitTest\testGetDefaultInstance(), WatchedItemStoreUnitTest\testOverrideDefaultInstance(), WatchedItemStoreIntegrationTest\testUpdateAndResetNotificationTimestamp(), WatchedItemStoreIntegrationTest\testWatchAndUnWatchItem(), SpecialEditWatchlist\unwatchTitles(), EmailNotification\updateWatchlistTimestamp(), and SpecialEditWatchlist\watchTitles().

WatchedItemStore::getNotificationTimestamp	(	User	$user,
		Title	$title,
			$item,
			$force,
			$oldid
	)

private

Definition at line 814 of file WatchedItemStore.php.

References Title\getNextRevisionID(), loadWatchedItem(), and TS_MW.

Referenced by resetNotificationTimestamp().

WatchedItemStore::getNotificationTimestampsBatch	(	User	$user,
		array	$targets
	)

Parameters

User	$user
	LinkTarget[]	$targets

Returns

array multi-dimensional like $return[$namespaceId][$titleString] = $timestamp, where $timestamp is:

string|null value of wl_notificationtimestamp,
false if $target is not watched by $user.

Definition at line 584 of file WatchedItemStore.php.

References $dbr, $res, as, DB_SLAVE, getCached(), getConnection(), User\getId(), User\isAnon(), and reuseConnection().

WatchedItemStore::getVisitingWatchersCondition	(	IDatabase	$db,
		array	$targetsWithVisitThresholds
	)

private

Generates condition for the query used in a batch count visiting watchers.

Parameters

IDatabase	$db
array	$targetsWithVisitThresholds	array of pairs (LinkTarget, last visit threshold)

Returns: string

Definition at line 419 of file WatchedItemStore.php.

References IDatabase\addQuotes(), as, list, LIST_AND, LIST_OR, IDatabase\makeList(), and IDatabase\timestamp().

Referenced by countVisitingWatchersMultiple().

WatchedItemStore::getWatchedItem	(	User	$user,
		LinkTarget	$target
	)

Get an item (may be cached)

Parameters

User	$user
LinkTarget	$target

Returns: WatchedItem|false

Definition at line 464 of file WatchedItemStore.php.

References getCached(), User\isAnon(), and loadWatchedItem().

Referenced by isWatched().

WatchedItemStore::getWatchedItemsForUser	(	User	$user,
		array	$options = `[]`
	)

Parameters

User	$user
array	$options	Allowed keys: 'forWrite' => bool defaults to false 'sort' => string optional sorting by namespace ID and title one of the self::SORT_* constants

Returns: WatchedItem[]

Definition at line 524 of file WatchedItemStore.php.

References $options, $res, as, DB_MASTER, DB_SLAVE, false, getConnection(), User\getId(), and reuseConnection().

WatchedItemStore::isWatched	(	User	$user,
		LinkTarget	$target
	)

Must be called separately for Subject & Talk namespaces.

Parameters

User	$user
LinkTarget	$target

Returns: bool

Definition at line 571 of file WatchedItemStore.php.

References getWatchedItem().

WatchedItemStore::loadWatchedItem	(	User	$user,
		LinkTarget	$target
	)

Loads an item from the db.

Parameters

User	$user
LinkTarget	$target

Returns: WatchedItem|false

Definition at line 486 of file WatchedItemStore.php.

References $dbr, cache(), DB_SLAVE, dbCond(), getConnection(), User\isAnon(), and reuseConnection().

Referenced by getNotificationTimestamp(), getWatchedItem(), and resetNotificationTimestamp().

static WatchedItemStore::overrideDefaultInstance ( WatchedItemStore $store = null )

static

Overrides the default instance of this class This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.

If this method is used it MUST also be called with null after a test to ensure a new default instance is created next time getDefaultInstance is called.

Parameters

WatchedItemStore | null $store

Returns: ScopedCallback to reset the overridden value

Exceptions

MWException

Definition at line 140 of file WatchedItemStore.php.

References use.

Referenced by WatchedItemUnitTest\testBatchAddWatch(), WatchedItemUnitTest\testDuplicateEntries(), WatchedItemUnitTest\testFromUserTitle(), and WatchedItemUnitTest\testResetNotificationTimestamp().

WatchedItemStore::overrideDeferredUpdatesAddCallableUpdateCallback ( $callback )

Overrides the DeferredUpdates::addCallableUpdate callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.

Parameters

callable $callback

See also: DeferredUpdates::addCallableUpdate for callback signiture

Returns: ScopedCallback to reset the overridden value

Exceptions

MWException

Definition at line 88 of file WatchedItemStore.php.

References $deferredUpdatesAddCallableUpdateCallback, and use.

WatchedItemStore::overrideRevisionGetTimestampFromIdCallback ( $callback )

Overrides the Revision::getTimestampFromId callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.

Parameters

callable $callback

See also: Revision::getTimestampFromId for callback signiture

Returns: ScopedCallback to reset the overridden value

Exceptions

MWException

Definition at line 113 of file WatchedItemStore.php.

References $revisionGetTimestampFromIdCallback, and use.

WatchedItemStore::removeWatch	(	User	$user,
		LinkTarget	$target
	)

Removes the an entry for the User watching the LinkTarget Must be called separately for Subject & Talk namespaces.

Parameters

User	$user
LinkTarget	$target

Returns: bool success

Exceptions

DBUnexpectedError
MWException

Definition at line 692 of file WatchedItemStore.php.

References $success, DB_MASTER, getConnection(), MediaWiki\Linker\LinkTarget\getDBkey(), User\getId(), MediaWiki\Linker\LinkTarget\getNamespace(), User\isAnon(), reuseConnection(), and uncache().

WatchedItemStore::resetNotificationTimestamp	(	User	$user,
		Title	$title,
			$force = `''`,
			$oldid = `0`
	)

Reset the notification timestamp of this entry.

Parameters

User	$user
Title	$title
string	$force	Whether to force the write query to be executed even if the page is not watched or the notification timestamp is already NULL. 'force' in order to force
int	$oldid	The revision id being viewed. If not given or 0, latest revision is assumed.

Returns: bool success

Definition at line 775 of file WatchedItemStore.php.

References $job, User\getId(), getNotificationTimestamp(), User\isAnon(), loadWatchedItem(), uncache(), and use.

WatchedItemStore::reuseConnection ( $connection )

private

Parameters

DatabaseBase $connection

Exceptions

MWException

Definition at line 244 of file WatchedItemStore.php.

Referenced by addWatchBatchForUser(), countUnreadNotifications(), countVisitingWatchers(), countVisitingWatchersMultiple(), countWatchedItems(), countWatchers(), countWatchersMultiple(), duplicateEntry(), getNotificationTimestampsBatch(), getWatchedItemsForUser(), loadWatchedItem(), removeWatch(), and updateNotificationTimestamp().

WatchedItemStore::setStatsdDataFactory ( StatsdDataFactoryInterface $statsFactory )

Sets a StatsdDataFactory instance on the object.

Parameters

StatsdDataFactoryInterface $statsFactory

Returns: null

Implements StatsdAwareInterface.

Definition at line 73 of file WatchedItemStore.php.

References $stats.

WatchedItemStore::uncache	(	User	$user,
		LinkTarget	$target
	)

private

Definition at line 185 of file WatchedItemStore.php.

References cache(), getCacheKey(), MediaWiki\Linker\LinkTarget\getDBkey(), User\getId(), and MediaWiki\Linker\LinkTarget\getNamespace().

Referenced by addWatchBatchForUser(), removeWatch(), and resetNotificationTimestamp().

WatchedItemStore::uncacheLinkTarget ( LinkTarget $target )

private

Definition at line 191 of file WatchedItemStore.php.

References $key, as, cache(), MediaWiki\Linker\LinkTarget\getDBkey(), and MediaWiki\Linker\LinkTarget\getNamespace().

Referenced by updateNotificationTimestamp().

WatchedItemStore::updateNotificationTimestamp	(	User	$editor,
		LinkTarget	$target,
			$timestamp
	)

Parameters

User	$editor	The editor that triggered the update. Their notification timestamp will not be updated(they have already seen it)
LinkTarget	$target	The target to update timestamps for
string	$timestamp	Set the update timestamp to this value

Returns: int[] Array of user IDs the timestamp has been updated for

Definition at line 722 of file WatchedItemStore.php.

References $fname, $res, $timestamp, as, DB_MASTER, getConnection(), MediaWiki\Linker\LinkTarget\getDBkey(), User\getId(), MediaWiki\Linker\LinkTarget\getNamespace(), reuseConnection(), uncacheLinkTarget(), and use.

Member Data Documentation

HashBagOStuff WatchedItemStore::$cache

private

Definition at line 28 of file WatchedItemStore.php.

Referenced by __construct().

array [] WatchedItemStore::$cacheIndex = []

private

Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => 'key' The index is needed so that on mass changes all relevant items can be un-cached.

For example: Clearing a users watchlist of all items or updating notification timestamps for all users watching a single target.

Definition at line 36 of file WatchedItemStore.php.

callable null WatchedItemStore::$deferredUpdatesAddCallableUpdateCallback

private

Definition at line 41 of file WatchedItemStore.php.

Referenced by overrideDeferredUpdatesAddCallableUpdateCallback().

self null WatchedItemStore::$instance

staticprivate

Definition at line 56 of file WatchedItemStore.php.

LoadBalancer WatchedItemStore::$loadBalancer

private

Definition at line 23 of file WatchedItemStore.php.

Referenced by __construct().

callable null WatchedItemStore::$revisionGetTimestampFromIdCallback

private

Definition at line 46 of file WatchedItemStore.php.

Referenced by overrideRevisionGetTimestampFromIdCallback().

StatsdDataFactoryInterface WatchedItemStore::$stats

private

Definition at line 51 of file WatchedItemStore.php.

Referenced by setStatsdDataFactory().

const WatchedItemStore::SORT_ASC = 'ASC'

Definition at line 18 of file WatchedItemStore.php.

Referenced by SpecialEditWatchlist\getWatchlistInfo(), and WatchedItemStoreUnitTest\testGetWatchedItemsForUser_optionsAndEmptyResult().

const WatchedItemStore::SORT_DESC = 'DESC'

Definition at line 17 of file WatchedItemStore.php.

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

includes/WatchedItemStore.php

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation