Inherits MediaWiki\Watchlist\WatchedItemStoreInterface.

Collaboration diagram for MediaWiki\Watchlist\NoWriteWatchedItemStore:

[legend]

Public Member Functions

__construct (WatchedItemStoreInterface $actualStore)

Initially set WatchedItemStore that will be used in cases where writing is not needed.

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.

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

clearUserWatchedItems (UserIdentity $user)

Synchronously clear the users watchlist.

Since: 1.31

Parameters

UserIdentity $user

Returns: bool True on success, false if {

See also: clearUserWatchedItemsUsingJobQueue} must be used instead

clearUserWatchedItemsUsingJobQueue (UserIdentity $user)

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

Since: 1.31

Parameters

UserIdentity $user

countExpired ()

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

Since: 1.35

Returns: int

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

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

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).

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

countWatchers ( $target)

Since: 1.31

Parameters

LinkTarget | PageIdentity $target deprecated passing LinkTarget since 1.36

Returns: int

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.

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

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

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 usersUsage 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

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.

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

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[]

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

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

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

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

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

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

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.

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

removeWatchBatchForUser (UserIdentity $user, array $targets)

Since: 1.32

Parameters

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

Returns: bool success

resetAllNotificationTimestampsForUser (UserIdentity $user, $timestamp=null)

Reset all watchlist notification 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

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

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

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

Additional Inherited Members
Public Attributes inherited from MediaWiki\Watchlist\WatchedItemStoreInterface
const	SORT_ASC = 'ASC'

const	SORT_DESC = 'DESC'

Detailed Description

Access: internal

Since: 1.31

Definition at line 32 of file NoWriteWatchedItemStore.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Watchlist\NoWriteWatchedItemStore::__construct ( WatchedItemStoreInterface $actualStore )

Initially set WatchedItemStore that will be used in cases where writing is not needed.

Parameters

WatchedItemStoreInterface $actualStore

Definition at line 42 of file NoWriteWatchedItemStore.php.

Member Function Documentation

◆ addWatch()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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.

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 131 of file NoWriteWatchedItemStore.php.

◆ addWatchBatchForUser()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 136 of file NoWriteWatchedItemStore.php.

◆ clearUserWatchedItems()

MediaWiki\Watchlist\NoWriteWatchedItemStore::clearUserWatchedItems ( UserIdentity $user )

Synchronously clear the users watchlist.

Since: 1.31

Parameters

UserIdentity $user

Returns: bool True on success, false if {

See also: clearUserWatchedItemsUsingJobQueue} must be used instead

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 181 of file NoWriteWatchedItemStore.php.

◆ clearUserWatchedItemsUsingJobQueue()

MediaWiki\Watchlist\NoWriteWatchedItemStore::clearUserWatchedItemsUsingJobQueue ( UserIdentity $user )

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

Since: 1.31

Parameters

UserIdentity $user

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 191 of file NoWriteWatchedItemStore.php.

◆ countExpired()

MediaWiki\Watchlist\NoWriteWatchedItemStore::countExpired ( )

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

Since: 1.35

Returns: int

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 213 of file NoWriteWatchedItemStore.php.

◆ countUnreadNotifications()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 116 of file NoWriteWatchedItemStore.php.

◆ countVisitingWatchers()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 57 of file NoWriteWatchedItemStore.php.

◆ countVisitingWatchersMultiple()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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).

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 70 of file NoWriteWatchedItemStore.php.

◆ countWatchedItems()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 47 of file NoWriteWatchedItemStore.php.

◆ countWatchers()

MediaWiki\Watchlist\NoWriteWatchedItemStore::countWatchers ( $target )

Since: 1.31

Parameters

LinkTarget | PageIdentity $target deprecated passing LinkTarget since 1.36

Returns: int

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 52 of file NoWriteWatchedItemStore.php.

◆ countWatchersMultiple()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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.

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 62 of file NoWriteWatchedItemStore.php.

◆ duplicateAllAssociatedEntries()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 121 of file NoWriteWatchedItemStore.php.

◆ duplicateEntry()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 126 of file NoWriteWatchedItemStore.php.

◆ getLatestNotificationTimestamp()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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 usersUsage 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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 206 of file NoWriteWatchedItemStore.php.

References wfTimestampOrNull().

◆ getNotificationTimestampsBatch()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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.

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 111 of file NoWriteWatchedItemStore.php.

◆ getWatchedItem()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 81 of file NoWriteWatchedItemStore.php.

◆ getWatchedItemsForUser()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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[]

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 96 of file NoWriteWatchedItemStore.php.

◆ isTempWatched()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 106 of file NoWriteWatchedItemStore.php.

◆ isWatched()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 101 of file NoWriteWatchedItemStore.php.

◆ loadWatchedItem()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 86 of file NoWriteWatchedItemStore.php.

◆ loadWatchedItemsBatch()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 91 of file NoWriteWatchedItemStore.php.

◆ maybeEnqueueWatchlistExpiryJob()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 196 of file NoWriteWatchedItemStore.php.

◆ mustClearWatchedItemsUsingJobQueue()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 186 of file NoWriteWatchedItemStore.php.

◆ removeExpired()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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.

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 218 of file NoWriteWatchedItemStore.php.

◆ removeWatch()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 145 of file NoWriteWatchedItemStore.php.

◆ removeWatchBatchForUser()

MediaWiki\Watchlist\NoWriteWatchedItemStore::removeWatchBatchForUser	(	UserIdentity	$user,
		array	$targets )

Since: 1.32

Parameters

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

Returns: bool success

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 201 of file NoWriteWatchedItemStore.php.

◆ resetAllNotificationTimestampsForUser()

MediaWiki\Watchlist\NoWriteWatchedItemStore::resetAllNotificationTimestampsForUser	(	UserIdentity	$user,
			$timestamp = null )

Reset all watchlist notification 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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 166 of file NoWriteWatchedItemStore.php.

◆ resetNotificationTimestamp()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 171 of file NoWriteWatchedItemStore.php.

◆ setNotificationTimestampsForUser()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 150 of file NoWriteWatchedItemStore.php.

◆ updateNotificationTimestamp()

MediaWiki\Watchlist\NoWriteWatchedItemStore::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

Implements MediaWiki\Watchlist\WatchedItemStoreInterface.

Definition at line 159 of file NoWriteWatchedItemStore.php.

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

includes/watchlist/NoWriteWatchedItemStore.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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()