Inheritance diagram for WatchedItemStoreInterface:

[legend]

Public Member Functions
	addWatch (UserIdentity $user, $target, ?string $expiry=null)
	Must be called separately for Subject & Talk namespaces.

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

	clearUserWatchedItems (UserIdentity $user)
	Synchronously clear the users watchlist.

	clearUserWatchedItemsUsingJobQueue (UserIdentity $user)
	Queues a job that will clear the users watchlist using the Job Queue.

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

	countUnreadNotifications (UserIdentity $user, $unreadLimit=null)

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

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

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

	countWatchers ( $target)

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

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

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

	getLatestNotificationTimestamp ( $timestamp, UserIdentity $user, $target)
	Convert $timestamp to TS_MW or return null if the page was visited since then by $user.

	getNotificationTimestampsBatch (UserIdentity $user, array $targets)

	getWatchedItem (UserIdentity $user, $target)
	Get an item (may be cached)

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

	isTempWatched (UserIdentity $user, $target)
	Whether the page is only being watched temporarily (has expiry).

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

	loadWatchedItem (UserIdentity $user, $target)
	Loads an item from the db.

	loadWatchedItemsBatch (UserIdentity $user, array $targets)
	Loads a set of WatchedItems from the db.

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

	mustClearWatchedItemsUsingJobQueue (UserIdentity $user)
	Does the size of the users watchlist require clearUserWatchedItemsUsingJobQueue() to be used instead of clearUserWatchedItems()

	removeExpired (int $limit, bool $deleteOrphans=false)
	Remove some number of expired watchlist items.

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

	removeWatchBatchForUser (UserIdentity $user, array $targets)

	resetAllNotificationTimestampsForUser (UserIdentity $user, $timestamp=null)
	Reset all watchlist notificaton timestamps for a user using the job queue.

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

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

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

Public Attributes
const	SORT_ASC = 'ASC'

const	SORT_DESC = 'DESC'

Detailed Description

Author: Addshore

Since: 1.31 interface created. WatchedItemStore implementation available since 1.27

Definition at line 31 of file WatchedItemStoreInterface.php.

Member Function Documentation

◆ addWatch()

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

Must be called separately for Subject & Talk namespaces.

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

Parameters

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

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ addWatchBatchForUser()

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

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

Parameters

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

Returns: bool success

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ clearUserWatchedItems()

WatchedItemStoreInterface::clearUserWatchedItems ( UserIdentity $user )

Synchronously clear the users watchlist.

Since: 1.31

Parameters

UserIdentity $user

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ clearUserWatchedItemsUsingJobQueue()

WatchedItemStoreInterface::clearUserWatchedItemsUsingJobQueue ( UserIdentity $user )

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

Since: 1.31

Parameters

UserIdentity $user

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ countExpired()

WatchedItemStoreInterface::countExpired ( )

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

Since: 1.35

Returns: int

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ countUnreadNotifications()

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

Since: 1.31

Parameters

UserIdentity	$user
int \| null	$unreadLimit

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

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ countVisitingWatchers()

WatchedItemStoreInterface::countVisitingWatchers	(	$target,
		$threshold
	)

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

Since: 1.31

Parameters

LinkTarget \| PageIdentity	$target	deprecated passing LinkTarget since 1.36
mixed	$threshold	timestamp accepted by wfTimestamp

Returns: int

Exceptions

DBUnexpectedError
MWException

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

Referenced by InfoAction\pageCounts().

◆ countVisitingWatchersMultiple()

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

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

Since: 1.31

Parameters

array	$targetsWithVisitThresholds	array of pairs (LinkTarget\|PageIdentity $target, mixed $threshold), $threshold is: a timestamp of the recent edit if $target exists (format accepted by wfTimestamp) null if $target doesn't exist deprecated passing LinkTarget since 1.36
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).

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ countWatchedItems()

WatchedItemStoreInterface::countWatchedItems ( UserIdentity $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.

Since: 1.31

Parameters

UserIdentity $user

Returns: int

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ countWatchers()

WatchedItemStoreInterface::countWatchers ( $target )

Since: 1.31

Parameters

LinkTarget | PageIdentity $target deprecated passing LinkTarget since 1.36

Returns: int

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

Referenced by InfoAction\pageCounts().

◆ countWatchersMultiple()

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

Since: 1.31

Parameters

LinkTarget[] \| PageIdentity[]	$targets	deprecated passing LinkTarget[] since 1.36
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.

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ duplicateAllAssociatedEntries()

WatchedItemStoreInterface::duplicateAllAssociatedEntries	(	$oldTarget,
		$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.

Since: 1.31

Parameters

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

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ duplicateEntry()

WatchedItemStoreInterface::duplicateEntry	(	$oldTarget,
		$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

Since: 1.31

Parameters

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

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ getLatestNotificationTimestamp()

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

Convert $timestamp to TS_MW or return null if the page was visited since then by $user.

Use this only on single-user methods (having higher read-after-write expectations) and not in places involving arbitrary batches of different users

Usage of this method should be limited to WatchedItem* classes

Parameters

string \| null	$timestamp	Value of wl_notificationtimestamp from the DB
UserIdentity	$user
LinkTarget \| PageIdentity	$target	deprecated passing LinkTarget since 1.36

Returns: string|null TS_MW timestamp of first unseen revision or null if there isn't one

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ getNotificationTimestampsBatch()

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

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget[] \| PageIdentity[]	$targets	deprecated passing LinkTarget[] since 1.36

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.

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ getWatchedItem()

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

Get an item (may be cached)

Since: 1.31

Parameters

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

Returns: WatchedItem|false

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ getWatchedItemsForUser()

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

Since: 1.31 Method Added; 1.35 Allows 'sortByExpiry' as a key in $options

Parameters

UserIdentity	$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 'sortByExpiry' => bool optional sorts by expiration date, with the titles that will expire soonest at the top.

Returns: WatchedItem[]

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ isTempWatched()

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

Whether the page is only being watched temporarily (has expiry).

Must be called separately for Subject & Talk namespaces.

Since: 1.35

Parameters

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

Returns: bool

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ isWatched()

WatchedItemStoreInterface::isWatched	(	UserIdentity	$user,
			$target
	)

Must be called separately for Subject & Talk namespaces.

Since: 1.31

Parameters

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

Returns: bool

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ loadWatchedItem()

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

Loads an item from the db.

Since: 1.31

Parameters

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

Returns: WatchedItem|false

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ loadWatchedItemsBatch()

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

Loads a set of WatchedItems from the db.

Since: 1.36

Parameters

UserIdentity	$user
LinkTarget[] \| PageIdentity[]	$targets	deprecated passing LinkTarget[] since 1.36

Returns: WatchedItem[]|false

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ maybeEnqueueWatchlistExpiryJob()

WatchedItemStoreInterface::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

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ mustClearWatchedItemsUsingJobQueue()

WatchedItemStoreInterface::mustClearWatchedItemsUsingJobQueue ( UserIdentity $user )

Does the size of the users watchlist require clearUserWatchedItemsUsingJobQueue() to be used instead of clearUserWatchedItems()

Since: 1.35

Parameters

UserIdentity $user

Returns: bool

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ removeExpired()

WatchedItemStoreInterface::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.

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ removeWatch()

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

Removes an entry for the UserIdentity watching the target (LinkTarget or PageIdentity) Must be called separately for Subject & Talk namespaces.

Since: 1.31

Parameters

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

Returns: bool success

Exceptions

DBUnexpectedError
MWException

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ removeWatchBatchForUser()

WatchedItemStoreInterface::removeWatchBatchForUser	(	UserIdentity	$user,
		array	$targets
	)

Since: 1.32

Parameters

UserIdentity	$user
LinkTarget[] \| PageIdentity[]	$targets	deprecated passing LinkTarget[] since 1.36

Returns: bool success

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ resetAllNotificationTimestampsForUser()

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

Reset all watchlist notificaton timestamps for a user using the job queue.

Since: 1.31

Parameters

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

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ resetNotificationTimestamp()

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

Reset the notification timestamp of this entry.

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget \| PageIdentity	$title	deprecated passing LinkTarget since 1.36
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 Whether a job was enqueued

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ setNotificationTimestampsForUser()

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

Since: 1.31

Parameters

UserIdentity	$user	The user to set the timestamps for
string \| null	$timestamp	Set the update timestamp to this value
LinkTarget[] \| PageIdentity[]	$targets	List of targets to update. Default to all targets. deprecated passing LinkTarget[] since 1.36

Returns: bool success

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

◆ updateNotificationTimestamp()

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

Since: 1.31

Parameters

UserIdentity	$editor	The editor that triggered the update. Their notification timestamp will not be updated(they have already seen it)
LinkTarget \| PageIdentity	$target	The target to update timestamps for deprecated passing LinkTarget since 1.36
string	$timestamp	Set the update (first unseen revision) timestamp to this value

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

Implemented in NoWriteWatchedItemStore, and WatchedItemStore.

Member Data Documentation

◆ SORT_ASC

const WatchedItemStoreInterface::SORT_ASC = 'ASC'

Since: 1.31

Definition at line 36 of file WatchedItemStoreInterface.php.

Referenced by SpecialEditWatchlist\getWatchlistInfo(), and ApiQueryWatchlistRaw\run().

◆ SORT_DESC

const WatchedItemStoreInterface::SORT_DESC = 'DESC'

Since: 1.31

Definition at line 41 of file WatchedItemStoreInterface.php.

Referenced by ApiQueryWatchlistRaw\run().

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

includes/watcheditem/WatchedItemStoreInterface.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addWatch()

◆ addWatchBatchForUser()

◆ clearUserWatchedItems()

◆ clearUserWatchedItemsUsingJobQueue()

◆ countExpired()

◆ countUnreadNotifications()

◆ countVisitingWatchers()

◆ countVisitingWatchersMultiple()

◆ countWatchedItems()

◆ countWatchers()

◆ countWatchersMultiple()

◆ duplicateAllAssociatedEntries()

◆ duplicateEntry()

◆ getLatestNotificationTimestamp()

◆ getNotificationTimestampsBatch()

◆ getWatchedItem()

◆ getWatchedItemsForUser()

◆ isTempWatched()

◆ isWatched()

◆ loadWatchedItem()

◆ loadWatchedItemsBatch()

◆ maybeEnqueueWatchlistExpiryJob()

◆ mustClearWatchedItemsUsingJobQueue()

◆ removeExpired()

◆ removeWatch()

◆ removeWatchBatchForUser()

◆ resetAllNotificationTimestampsForUser()

◆ resetNotificationTimestamp()

◆ setNotificationTimestampsForUser()

◆ updateNotificationTimestamp()

Member Data Documentation

◆ SORT_ASC

◆ SORT_DESC