MediaWiki  REL1_31
WatchedItemStoreInterface Interface Reference
Inheritance diagram for WatchedItemStoreInterface:

Public Member Functions

 addWatch (User $user, LinkTarget $target)
 Must be called separately for Subject & Talk namespaces. More...
 
 addWatchBatchForUser (User $user, array $targets)
 
 clearUserWatchedItems (User $user)
 Queues a job that will clear the users watchlist using the Job Queue. More...
 
 clearUserWatchedItemsUsingJobQueue (User $user)
 Queues a job that will clear the users watchlist using the Job Queue. More...
 
 countUnreadNotifications (User $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 (User $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...
 
 getNotificationTimestampsBatch (User $user, array $targets)
 
 getWatchedItem (User $user, LinkTarget $target)
 Get an item (may be cached) More...
 
 getWatchedItemsForUser (User $user, array $options=[])
 
 isWatched (User $user, LinkTarget $target)
 Must be called separately for Subject & Talk namespaces. More...
 
 loadWatchedItem (User $user, LinkTarget $target)
 Loads an item from the db. More...
 
 removeWatch (User $user, LinkTarget $target)
 Removes the an entry for the User watching the LinkTarget Must be called separately for Subject & Talk namespaces. More...
 
 resetAllNotificationTimestampsForUser (User $user)
 Reset all watchlist notificaton timestamps for a user using the job queue. More...
 
 resetNotificationTimestamp (User $user, Title $title, $force='', $oldid=0)
 Reset the notification timestamp of this entry. More...
 
 setNotificationTimestampsForUser (User $user, $timestamp, array $targets=[])
 
 updateNotificationTimestamp (User $editor, LinkTarget $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 27 of file WatchedItemStoreInterface.php.

Member Function Documentation

◆ addWatch()

WatchedItemStoreInterface::addWatch ( User  $user,
LinkTarget  $target 
)

Must be called separately for Subject & Talk namespaces.

Since
1.31
Parameters
User$user
LinkTarget$target

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ addWatchBatchForUser()

WatchedItemStoreInterface::addWatchBatchForUser ( User  $user,
array  $targets 
)
Since
1.31
Parameters
User$user
LinkTarget[]$targets
Returns
bool success

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ clearUserWatchedItems()

WatchedItemStoreInterface::clearUserWatchedItems ( User  $user)

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

Since
1.31
Parameters
User$user

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ clearUserWatchedItemsUsingJobQueue()

WatchedItemStoreInterface::clearUserWatchedItemsUsingJobQueue ( User  $user)

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

Since
1.31
Parameters
User$user

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ countUnreadNotifications()

WatchedItemStoreInterface::countUnreadNotifications ( User  $user,
  $unreadLimit = null 
)
Since
1.31
Parameters
User$user
int$unreadLimit
Returns
int|bool The number of unread notifications true if greater than or equal to $unreadLimit

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ countVisitingWatchers()

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

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

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

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ countWatchedItems()

WatchedItemStoreInterface::countWatchedItems ( User  $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
User$user
Returns
int

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ countWatchers()

WatchedItemStoreInterface::countWatchers ( LinkTarget  $target)
Since
1.31
Parameters
LinkTarget$target
Returns
int

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ countWatchersMultiple()

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

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ duplicateAllAssociatedEntries()

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

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ duplicateEntry()

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

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ getNotificationTimestampsBatch()

WatchedItemStoreInterface::getNotificationTimestampsBatch ( User  $user,
array  $targets 
)
Since
1.31
Parameters
User$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.

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ getWatchedItem()

WatchedItemStoreInterface::getWatchedItem ( User  $user,
LinkTarget  $target 
)

Get an item (may be cached)

Since
1.31
Parameters
User$user
LinkTarget$target
Returns
WatchedItem|false

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ getWatchedItemsForUser()

WatchedItemStoreInterface::getWatchedItemsForUser ( User  $user,
array  $options = [] 
)
Since
1.31
Parameters
User$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[]

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ isWatched()

WatchedItemStoreInterface::isWatched ( User  $user,
LinkTarget  $target 
)

Must be called separately for Subject & Talk namespaces.

Since
1.31
Parameters
User$user
LinkTarget$target
Returns
bool

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ loadWatchedItem()

WatchedItemStoreInterface::loadWatchedItem ( User  $user,
LinkTarget  $target 
)

Loads an item from the db.

Since
1.31
Parameters
User$user
LinkTarget$target
Returns
WatchedItem|false

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ removeWatch()

WatchedItemStoreInterface::removeWatch ( User  $user,
LinkTarget  $target 
)

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

Since
1.31
Parameters
User$user
LinkTarget$target
Returns
bool success
Exceptions
DBUnexpectedError
MWException

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ resetAllNotificationTimestampsForUser()

WatchedItemStoreInterface::resetAllNotificationTimestampsForUser ( User  $user)

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

Since
1.31
Parameters
User$userThe user to reset the timestamps for

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ resetNotificationTimestamp()

WatchedItemStoreInterface::resetNotificationTimestamp ( User  $user,
Title  $title,
  $force = '',
  $oldid = 0 
)

Reset the notification timestamp of this entry.

Since
1.31
Parameters
User$user
Title$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

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ setNotificationTimestampsForUser()

WatchedItemStoreInterface::setNotificationTimestampsForUser ( User  $user,
  $timestamp,
array  $targets = [] 
)
Since
1.31
Parameters
User$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

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

◆ updateNotificationTimestamp()

WatchedItemStoreInterface::updateNotificationTimestamp ( User  $editor,
LinkTarget  $target,
  $timestamp 
)
Since
1.31
Parameters
User$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 timestamp to this value
Returns
int[] Array of user IDs the timestamp has been updated for

Implemented in WatchedItemStore, and NoWriteWatchedItemStore.

Member Data Documentation

◆ SORT_ASC

const WatchedItemStoreInterface::SORT_ASC = 'ASC'

◆ SORT_DESC

const WatchedItemStoreInterface::SORT_DESC = 'DESC'
Since
1.31

Definition at line 37 of file WatchedItemStoreInterface.php.

Referenced by ApiQueryWatchlistRaw\run().


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