Storage layer class for WatchedItems. More...

Inheritance diagram for WatchedItemStore:

Collaboration diagram for WatchedItemStore:

Public Member Functions

__construct (ServiceOptions $options, ILBFactory $lbFactory, JobQueueGroup $queueGroup, BagOStuff $stash, HashBagOStuff $cache, ReadOnlyMode $readOnlyMode, NamespaceInfo $nsInfo, RevisionLookup $revisionLookup, LinkBatchFactory $linkBatchFactory)

addWatch (UserIdentity $user, $target, ?string $expiry=null)

addWatchBatchForUser (UserIdentity $user, array $targets, ?string $expiry=null)

Add multiple items to the user's watchlist. More...

clearUserWatchedItems (UserIdentity $user)

Deletes ALL watched items for the given user when under $updateRowsPerQuery entries exist. More...

clearUserWatchedItemsUsingJobQueue (UserIdentity $user)

Queues a job that will clear the users watchlist using the Job Queue. More...

countExpired ()

Get the number of watchlist items that expire before the current time.

Since: 1.35

Returns: int

More...

countUnreadNotifications (UserIdentity $user, $unreadLimit=null)

countVisitingWatchers ( $target, $threshold)

countVisitingWatchersMultiple (array $targetsWithVisitThresholds, $minimumWatchers=null)

countWatchedItems (UserIdentity $user)

countWatchers ( $target)

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

duplicateAllAssociatedEntries ( $oldTarget, $newTarget)

duplicateEntry ( $oldTarget, $newTarget)

getLatestNotificationTimestamp ( $timestamp, UserIdentity $user, $target)

getMaxId ()

getNotificationTimestampsBatch (UserIdentity $user, array $targets)

getWatchedItem (UserIdentity $user, $target)

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

isTempWatched (UserIdentity $user, $target)

Check if the user is temporarily watching the page. More...

isWatched (UserIdentity $user, $target)

loadWatchedItem (UserIdentity $user, $target)

loadWatchedItemsBatch (UserIdentity $user, array $targets)

maybeEnqueueWatchlistExpiryJob ()

Probabilistically add a job to purge the expired watchlist items, if watchlist expiration is enabled, based on the value of $wgWatchlistPurgeRate.

Since: 1.36

More...

mustClearWatchedItemsUsingJobQueue (UserIdentity $user)

overrideDeferredUpdatesAddCallableUpdateCallback (callable $callback)

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

removeExpired (int $limit, bool $deleteOrphans=false)

Remove some number of expired watchlist items.

Since: 1.35

Parameters

int	$limit	The number of items to remove.
bool	$deleteOrphans	Whether to also delete `watchlist_expiry` rows that have no related `watchlist` rows (because not all code knows about the expiry table yet). This runs two extra queries, so is only done from the purgeExpiredWatchlistItems.php maintenance script.

More...

removeWatch (UserIdentity $user, $target)

removeWatchBatchForUser (UserIdentity $user, array $titles)

resetAllNotificationTimestampsForUser (UserIdentity $user, $timestamp=null)

Schedule a DeferredUpdate that sets all of the "last viewed" timestamps for a given user to the same value. More...

resetNotificationTimestamp (UserIdentity $user, $title, $force='', $oldid=0)

setNotificationTimestampsForUser (UserIdentity $user, $timestamp, array $targets=[])

Set the "last viewed" timestamps for certain titles on a user's watchlist. More...

setStatsdDataFactory (StatsdDataFactoryInterface $stats)

updateNotificationTimestamp (UserIdentity $editor, $target, $timestamp)

Update wl_notificationtimestamp for all watching users except the editor. More...

Public Attributes
const	CONSTRUCTOR_OPTIONS

Public Attributes inherited from WatchedItemStoreInterface
const	SORT_ASC = 'ASC'

const	SORT_DESC = 'DESC'

Detailed Description

Storage layer class for WatchedItems.

Database interaction & caching TODO caching should be factored out into a CachingWatchedItemStore class

Author: Addshore

Since: 1.27

Definition at line 28 of file WatchedItemStore.php.

Constructor & Destructor Documentation

◆ __construct()

WatchedItemStore::__construct	(	ServiceOptions	$options,
		ILBFactory	$lbFactory,
		JobQueueGroup	$queueGroup,
		BagOStuff	$stash,
		HashBagOStuff	$cache,
		ReadOnlyMode	$readOnlyMode,
		NamespaceInfo	$nsInfo,
		RevisionLookup	$revisionLookup,
		LinkBatchFactory	$linkBatchFactory
	)

Parameters

ServiceOptions	$options
ILBFactory	$lbFactory
JobQueueGroup	$queueGroup
BagOStuff	$stash
HashBagOStuff	$cache
ReadOnlyMode	$readOnlyMode
NamespaceInfo	$nsInfo
RevisionLookup	$revisionLookup
LinkBatchFactory	$linkBatchFactory

Definition at line 133 of file WatchedItemStore.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and MediaWiki\Config\ServiceOptions\get().

Member Function Documentation

◆ addWatch()

WatchedItemStore::addWatch	(	UserIdentity	$user,
			$target,
		?string	$expiry = `null`
	)

Since: 1.27 Method added.; 1.35 Accepts $expiry parameter.

Parameters

UserIdentity	$user
LinkTarget \| PageIdentity	$target	deprecated passing LinkTarget since 1.36
string \| null	$expiry	Optional expiry in any format acceptable to wfTimestamp(). null will not create an expiry, or leave it unchanged should one already exist.

WatchedItemStore::addWatchBatchForUser	(	UserIdentity	$user,
		array	$targets,
		?string	$expiry = `null`
	)

UserIdentity	$user
LinkTarget[]	$targets
string \| null	$expiry	Optional expiry in a format acceptable to wfTimestamp(), null will not create expiries, or leave them unchanged should they already exist.

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

WatchedItemStore::countVisitingWatchers	(	$target,
		$threshold
	)

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

array	$targetsWithVisitThresholds	array of LinkTarget[]\|PageIdentity[] (not type hinted since it annoys phan) - deprecated passing LinkTarget[] since 1.36
int \| null	$minimumWatchers

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

LinkTarget[] \| PageIdentity[]	$targets	deprecated passing LinkTarget[] since 1.36
array	$options	Supported options are: 'minimumWatchers': filter for pages that have at least a minimum number of watchers

WatchedItemStore::duplicateAllAssociatedEntries	(	$oldTarget,
		$newTarget
	)

LinkTarget \| PageIdentity	$oldTarget	deprecated passing LinkTarget since 1.36
LinkTarget \| PageIdentity	$newTarget	deprecated passing LinkTarget since 1.36

WatchedItemStore::getLatestNotificationTimestamp	(		$timestamp,
		UserIdentity	$user,
			$target
	)

WatchedItemStore::getWatchedItem	(	UserIdentity	$user,
			$target
	)

UserIdentity	$user
array	$options	Supported options are: 'forWrite': whether to use the primary database instead of a replica 'sort': how to sort the titles, either SORT_ASC or SORT_DESC 'sortByExpiry': whether to also sort results by expiration, with temporarily watched titles above titles watched indefinitely and titles expiring soonest at the top

string \| null	$timestamp
UserIdentity	$user
LinkTarget \| PageIdentity	$target	deprecated passing LinkTarget since 1.36

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

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

WatchedItemStore::isTempWatched	(	UserIdentity	$user,
			$target
	)

WatchedItemStore::loadWatchedItem	(	UserIdentity	$user,
			$target
	)

WatchedItemStore::loadWatchedItemsBatch	(	UserIdentity	$user,
		array	$targets
	)

WatchedItemStore::removeExpired	(	int	$limit,
		bool	$deleteOrphans = `false`
	)

WatchedItemStore::removeWatch	(	UserIdentity	$user,
			$target
	)

WatchedItemStore::removeWatchBatchForUser	(	UserIdentity	$user,
		array	$titles
	)

WatchedItemStore::resetAllNotificationTimestampsForUser	(	UserIdentity	$user,
			$timestamp = `null`
	)

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addWatch()

◆ addWatchBatchForUser()

◆ clearUserWatchedItems()

◆ clearUserWatchedItemsUsingJobQueue()

◆ countExpired()

◆ countUnreadNotifications()

◆ countVisitingWatchers()

◆ countVisitingWatchersMultiple()

◆ countWatchedItems()

◆ countWatchers()

◆ countWatchersMultiple()

◆ duplicateAllAssociatedEntries()

◆ duplicateEntry()

◆ getLatestNotificationTimestamp()

◆ getMaxId()

◆ getNotificationTimestampsBatch()

◆ getWatchedItem()

◆ getWatchedItemsForUser()

◆ isTempWatched()

◆ isWatched()

◆ loadWatchedItem()

◆ loadWatchedItemsBatch()

◆ maybeEnqueueWatchlistExpiryJob()

◆ mustClearWatchedItemsUsingJobQueue()

◆ overrideDeferredUpdatesAddCallableUpdateCallback()

◆ removeExpired()

◆ removeWatch()

◆ removeWatchBatchForUser()

◆ resetAllNotificationTimestampsForUser()

◆ resetNotificationTimestamp()

◆ setNotificationTimestampsForUser()

◆ setStatsdDataFactory()

◆ updateNotificationTimestamp()

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

UserIdentity	$user
string \| int \| null	$timestamp	Value to set all timestamps to, null to clear them

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

WatchedItemStore::setNotificationTimestampsForUser	(	UserIdentity	$user,
			$timestamp,
		array	$targets = `[]`
	)

UserIdentity	$user
string \| int	$timestamp	Value to set the "last viewed" timestamp to (null to clear)
LinkTarget[]	$targets	Titles to set the timestamp for; [] means the entire watchlist

WatchedItemStore::updateNotificationTimestamp	(	UserIdentity	$editor,
			$target,
			$timestamp
	)

UserIdentity	$editor
LinkTarget \| PageIdentity	$target	deprecated passing LinkTarget since 1.36
string \| int	$timestamp