MediaWiki  master
NoWriteWatchedItemStore Class Reference
Inheritance diagram for NoWriteWatchedItemStore:
Collaboration diagram for NoWriteWatchedItemStore:

Public Member Functions

 __construct (WatchedItemStoreInterface $actualStore)
 Initialy set WatchedItemStore that will be used in cases where writing is not needed. More...
 
 addWatch (UserIdentity $user, LinkTarget $target, ?string $expiry=null)
 Must be called separately for Subject & Talk namespaces. More...
 
 addWatchBatchForUser (UserIdentity $user, array $targets, ?string $expiry=null)
 
 clearUserWatchedItems (UserIdentity $user)
 Synchronously clear the users watchlist. 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. More...
 
 countUnreadNotifications (UserIdentity $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 (UserIdentity $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...
 
 enqueueWatchlistExpiryJob (float $watchlistPurgeRate)
 Probabilistically add a job to purge the expired watchlist items. More...
 
 getLatestNotificationTimestamp ( $timestamp, UserIdentity $user, LinkTarget $target)
 Convert $timestamp to TS_MW or return null if the page was visited since then by $user. More...
 
 getNotificationTimestampsBatch (UserIdentity $user, array $targets)
 
 getWatchedItem (UserIdentity $user, LinkTarget $target)
 Get an item (may be cached) More...
 
 getWatchedItemsForUser (UserIdentity $user, array $options=[])
 
 isTempWatched (UserIdentity $user, LinkTarget $target)
 Whether the page is only being watched temporarily (has expiry). More...
 
 isWatched (UserIdentity $user, LinkTarget $target)
 Must be called separately for Subject & Talk namespaces. More...
 
 loadWatchedItem (UserIdentity $user, LinkTarget $target)
 Loads an item from the db. More...
 
 mustClearWatchedItemsUsingJobQueue (UserIdentity $user)
 Does the size of the users watchlist require clearUserWatchedItemsUsingJobQueue() to be used instead of clearUserWatchedItems() More...
 
 removeExpired (int $limit, bool $deleteOrphans=false)
 Remove some number of expired watchlist items. More...
 
 removeWatch (UserIdentity $user, LinkTarget $target)
 Removes an entry for the UserIdentity watching the LinkTarget Must be called separately for Subject & Talk namespaces. More...
 
 removeWatchBatchForUser (UserIdentity $user, array $titles)
 
 resetAllNotificationTimestampsForUser (UserIdentity $user, $timestamp=null)
 Reset all watchlist notificaton timestamps for a user using the job queue. More...
 
 resetNotificationTimestamp (UserIdentity $user, LinkTarget $title, $force='', $oldid=0)
 Reset the notification timestamp of this entry. More...
 
 setNotificationTimestampsForUser (UserIdentity $user, $timestamp, array $targets=[])
 
 updateNotificationTimestamp (UserIdentity $editor, LinkTarget $target, $timestamp)
 

Private Attributes

WatchedItemStoreInterface $actualStore
 
const DB_READONLY_ERROR = 'The watchlist is currently readonly.'
 

Additional Inherited Members

- Public Attributes inherited from WatchedItemStoreInterface
const SORT_ASC = 'ASC'
 
const SORT_DESC = 'DESC'
 

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,
?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$target
string | null$expiryOptional expiry timestamp in any format acceptable to wfTimestamp(). null will not create an expiry, or leave it unchanged should one already exist.

Implements WatchedItemStoreInterface.

Definition at line 112 of file NoWriteWatchedItemStore.php.

◆ addWatchBatchForUser()

NoWriteWatchedItemStore::addWatchBatchForUser ( UserIdentity  $user,
array  $targets,
?string  $expiry = null 
)
Since
1.31 Method added.
1.35 Accepts $expiry parameter.
Parameters
UserIdentity$user
LinkTarget[]$targets
string | null$expiryOptional 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 WatchedItemStoreInterface.

Definition at line 116 of file NoWriteWatchedItemStore.php.

◆ clearUserWatchedItems()

NoWriteWatchedItemStore::clearUserWatchedItems ( UserIdentity  $user)

Synchronously clear the users watchlist.

Since
1.31
Parameters
UserIdentity$user

Implements WatchedItemStoreInterface.

Definition at line 155 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 163 of file NoWriteWatchedItemStore.php.

◆ countExpired()

NoWriteWatchedItemStore::countExpired ( )

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

Since
1.35
Returns
int

Implements WatchedItemStoreInterface.

Definition at line 181 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 100 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$thresholdtimestamp 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$targetsWithVisitThresholdsarray 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$optionsAllowed 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 104 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 108 of file NoWriteWatchedItemStore.php.

◆ enqueueWatchlistExpiryJob()

NoWriteWatchedItemStore::enqueueWatchlistExpiryJob ( float  $watchlistPurgeRate)

Probabilistically add a job to purge the expired watchlist items.

Since
1.35
Parameters
float$watchlistPurgeRateThe value of the $wgWatchlistPurgeRate configuration variable.

Implements WatchedItemStoreInterface.

Definition at line 167 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$timestampValue 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 175 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 96 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$optionsAllowed 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.

◆ isTempWatched()

NoWriteWatchedItemStore::isTempWatched ( UserIdentity  $user,
LinkTarget  $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$target
Returns
bool

Implements WatchedItemStoreInterface.

Definition at line 92 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.

◆ mustClearWatchedItemsUsingJobQueue()

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

Definition at line 159 of file NoWriteWatchedItemStore.php.

◆ removeExpired()

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

Remove some number of expired watchlist items.

Since
1.35
Parameters
int$limitThe number of items to remove.
bool$deleteOrphansWhether 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 WatchedItemStoreInterface.

Definition at line 185 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 124 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 171 of file NoWriteWatchedItemStore.php.

◆ resetAllNotificationTimestampsForUser()

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

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

Since
1.31
Parameters
UserIdentity$userThe user to reset the timestamps for
string | int | null$timestampValue to set all timestamps to, null to clear them

Implements WatchedItemStoreInterface.

Definition at line 142 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$forceWhether 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$oldidThe 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 146 of file NoWriteWatchedItemStore.php.

◆ setNotificationTimestampsForUser()

NoWriteWatchedItemStore::setNotificationTimestampsForUser ( UserIdentity  $user,
  $timestamp,
array  $targets = [] 
)
Since
1.31
Parameters
UserIdentity$userThe user to set the timestamps for
string | null$timestampSet the update timestamp to this value
LinkTarget[]$targetsList of targets to update. Default to all targets
Returns
bool success

Implements WatchedItemStoreInterface.

Definition at line 128 of file NoWriteWatchedItemStore.php.

◆ updateNotificationTimestamp()

NoWriteWatchedItemStore::updateNotificationTimestamp ( UserIdentity  $editor,
LinkTarget  $target,
  $timestamp 
)
Since
1.31
Parameters
UserIdentity$editorThe editor that triggered the update. Their notification timestamp will not be updated(they have already seen it)
LinkTarget$targetThe target to update timestamps for
string$timestampSet 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 136 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.'
private

Definition at line 37 of file NoWriteWatchedItemStore.php.


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