Inheritance diagram for NoWriteWatchedItemStore:

Collaboration diagram for NoWriteWatchedItemStore:

[legend]

Public Member Functions
	__construct (WatchedItemStoreInterface $actualStore)
	Initialy set WatchedItemStore that will be used in cases where writing is not needed.

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

	addWatchBatchForUser (UserIdentity $user, array $targets)

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

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

	countUnreadNotifications (UserIdentity $user, $unreadLimit=null)

	countVisitingWatchers (LinkTarget $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 (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.

	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.

	getLatestNotificationTimestamp ( $timestamp, UserIdentity $user, LinkTarget $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, LinkTarget $target)
	Get an item (may be cached)

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

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

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

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

	removeWatchBatchForUser (UserIdentity $user, array $titles)

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

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

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

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

Public Attributes
const	DB_READONLY_ERROR = 'The watchlist is currently readonly.'

Public Attributes inherited from WatchedItemStoreInterface
const	SORT_ASC = 'ASC'

const	SORT_DESC = 'DESC'

Private Attributes
WatchedItemStoreInterface	$actualStore

Detailed Description

Definition at line 30 of file NoWriteWatchedItemStore.php.

Constructor & Destructor Documentation

◆ __construct()

NoWriteWatchedItemStore::__construct ( WatchedItemStoreInterface $actualStore )

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

Parameters

WatchedItemStoreInterface $actualStore

Definition at line 43 of file NoWriteWatchedItemStore.php.

References $actualStore.

Member Function Documentation

◆ addWatch()

NoWriteWatchedItemStore::addWatch	(	UserIdentity	$user,
		LinkTarget	$target )

Must be called separately for Subject & Talk namespaces.

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget	$target

Implements WatchedItemStoreInterface.

Definition at line 108 of file NoWriteWatchedItemStore.php.

◆ addWatchBatchForUser()

NoWriteWatchedItemStore::addWatchBatchForUser	(	UserIdentity	$user,
		array	$targets )

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget[]	$targets

Returns: bool success

Implements WatchedItemStoreInterface.

Definition at line 112 of file NoWriteWatchedItemStore.php.

◆ clearUserWatchedItems()

NoWriteWatchedItemStore::clearUserWatchedItems ( UserIdentity $user )

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

Since: 1.31

Parameters

UserIdentity $user

Implements WatchedItemStoreInterface.

Definition at line 147 of file NoWriteWatchedItemStore.php.

◆ clearUserWatchedItemsUsingJobQueue()

NoWriteWatchedItemStore::clearUserWatchedItemsUsingJobQueue ( UserIdentity $user )

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

Since: 1.31

Parameters

UserIdentity $user

Implements WatchedItemStoreInterface.

Definition at line 151 of file NoWriteWatchedItemStore.php.

◆ countUnreadNotifications()

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

Definition at line 96 of file NoWriteWatchedItemStore.php.

◆ countVisitingWatchers()

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

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

Since: 1.31

Parameters

LinkTarget	$target
mixed	$threshold	timestamp accepted by wfTimestamp

Returns: int

Exceptions

DBUnexpectedError
MWException

Implements WatchedItemStoreInterface.

Definition at line 55 of file NoWriteWatchedItemStore.php.

◆ countVisitingWatchersMultiple()

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

Implements WatchedItemStoreInterface.

Definition at line 66 of file NoWriteWatchedItemStore.php.

◆ countWatchedItems()

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

Definition at line 47 of file NoWriteWatchedItemStore.php.

◆ countWatchers()

NoWriteWatchedItemStore::countWatchers ( LinkTarget $target )

Since: 1.31

Parameters

LinkTarget $target

Returns: int

Implements WatchedItemStoreInterface.

Definition at line 51 of file NoWriteWatchedItemStore.php.

◆ countWatchersMultiple()

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

Since: 1.31

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.

Implements WatchedItemStoreInterface.

Definition at line 59 of file NoWriteWatchedItemStore.php.

◆ duplicateAllAssociatedEntries()

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

Since: 1.31

Parameters

LinkTarget	$oldTarget
LinkTarget	$newTarget

Implements WatchedItemStoreInterface.

Definition at line 100 of file NoWriteWatchedItemStore.php.

◆ duplicateEntry()

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

Since: 1.31

Parameters

LinkTarget	$oldTarget
LinkTarget	$newTarget

Implements WatchedItemStoreInterface.

Definition at line 104 of file NoWriteWatchedItemStore.php.

◆ getLatestNotificationTimestamp()

NoWriteWatchedItemStore::getLatestNotificationTimestamp	(		$timestamp,
		UserIdentity	$user,
		LinkTarget	$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	$target

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

Implements WatchedItemStoreInterface.

Definition at line 159 of file NoWriteWatchedItemStore.php.

References wfTimestampOrNull().

◆ getNotificationTimestampsBatch()

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

Since: 1.31

Parameters

UserIdentity	$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.

Implements WatchedItemStoreInterface.

Definition at line 92 of file NoWriteWatchedItemStore.php.

◆ getWatchedItem()

NoWriteWatchedItemStore::getWatchedItem	(	UserIdentity	$user,
		LinkTarget	$target )

Get an item (may be cached)

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget	$target

Returns: WatchedItem|false

Implements WatchedItemStoreInterface.

Definition at line 76 of file NoWriteWatchedItemStore.php.

◆ getWatchedItemsForUser()

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

Since: 1.31

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

Returns: WatchedItem[]

Implements WatchedItemStoreInterface.

Definition at line 84 of file NoWriteWatchedItemStore.php.

◆ isWatched()

NoWriteWatchedItemStore::isWatched	(	UserIdentity	$user,
		LinkTarget	$target )

Must be called separately for Subject & Talk namespaces.

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget	$target

Returns: bool

Implements WatchedItemStoreInterface.

Definition at line 88 of file NoWriteWatchedItemStore.php.

◆ loadWatchedItem()

NoWriteWatchedItemStore::loadWatchedItem	(	UserIdentity	$user,
		LinkTarget	$target )

Loads an item from the db.

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget	$target

Returns: WatchedItem|false

Implements WatchedItemStoreInterface.

Definition at line 80 of file NoWriteWatchedItemStore.php.

◆ removeWatch()

NoWriteWatchedItemStore::removeWatch	(	UserIdentity	$user,
		LinkTarget	$target )

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

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget	$target

Returns: bool success

Exceptions

DBUnexpectedError
MWException

Implements WatchedItemStoreInterface.

Definition at line 116 of file NoWriteWatchedItemStore.php.

◆ removeWatchBatchForUser()

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

Since: 1.32

Parameters

UserIdentity	$user
LinkTarget[]	$targets

Returns: bool success

Implements WatchedItemStoreInterface.

Definition at line 155 of file NoWriteWatchedItemStore.php.

◆ resetAllNotificationTimestampsForUser()

NoWriteWatchedItemStore::resetAllNotificationTimestampsForUser ( UserIdentity $user )

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

Implements WatchedItemStoreInterface.

Definition at line 134 of file NoWriteWatchedItemStore.php.

◆ resetNotificationTimestamp()

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

Reset the notification timestamp of this entry.

Since: 1.31

Parameters

UserIdentity	$user
LinkTarget	$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 Whether a job was enqueued

Implements WatchedItemStoreInterface.

Definition at line 138 of file NoWriteWatchedItemStore.php.

◆ setNotificationTimestampsForUser()

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[]	$targets	List of targets to update. Default to all targets

Returns: bool success

Implements WatchedItemStoreInterface.

Definition at line 120 of file NoWriteWatchedItemStore.php.

◆ updateNotificationTimestamp()

NoWriteWatchedItemStore::updateNotificationTimestamp	(	UserIdentity	$editor,
		LinkTarget	$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	$target	The target to update timestamps for
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 WatchedItemStoreInterface.

Definition at line 128 of file NoWriteWatchedItemStore.php.

Member Data Documentation

◆ $actualStore

WatchedItemStoreInterface NoWriteWatchedItemStore::$actualStore

private

Definition at line 35 of file NoWriteWatchedItemStore.php.

Referenced by __construct().

◆ DB_READONLY_ERROR

const NoWriteWatchedItemStore::DB_READONLY_ERROR = 'The watchlist is currently readonly.'

Definition at line 37 of file NoWriteWatchedItemStore.php.

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

includes/watcheditem/NoWriteWatchedItemStore.php

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addWatch()

◆ addWatchBatchForUser()

◆ clearUserWatchedItems()

◆ clearUserWatchedItemsUsingJobQueue()

◆ countUnreadNotifications()

◆ countVisitingWatchers()

◆ countVisitingWatchersMultiple()

◆ countWatchedItems()

◆ countWatchers()

◆ countWatchersMultiple()

◆ duplicateAllAssociatedEntries()

◆ duplicateEntry()

◆ getLatestNotificationTimestamp()

◆ getNotificationTimestampsBatch()

◆ getWatchedItem()

◆ getWatchedItemsForUser()

◆ isWatched()

◆ loadWatchedItem()

◆ removeWatch()

◆ removeWatchBatchForUser()

◆ resetAllNotificationTimestampsForUser()

◆ resetNotificationTimestamp()

◆ setNotificationTimestampsForUser()

◆ updateNotificationTimestamp()

Member Data Documentation

◆ $actualStore

◆ DB_READONLY_ERROR