MediaWiki  master
WatchedItemStoreInterface.php
Go to the documentation of this file.
1 <?php
25 
31 
35  const SORT_ASC = 'ASC';
36 
40  const SORT_DESC = 'DESC';
41 
52  public function countWatchedItems( UserIdentity $user );
53 
61  public function countWatchers( LinkTarget $target );
62 
75  public function countVisitingWatchers( LinkTarget $target, $threshold );
76 
88  public function countWatchersMultiple( array $targets, array $options = [] );
89 
110  public function countVisitingWatchersMultiple(
111  array $targetsWithVisitThresholds,
112  $minimumWatchers = null
113  );
114 
125  public function getWatchedItem( UserIdentity $user, LinkTarget $target );
126 
137  public function loadWatchedItem( UserIdentity $user, LinkTarget $target );
138 
150  public function getWatchedItemsForUser( UserIdentity $user, array $options = [] );
151 
162  public function isWatched( UserIdentity $user, LinkTarget $target );
163 
175  public function getNotificationTimestampsBatch( UserIdentity $user, array $targets );
176 
185  public function addWatch( UserIdentity $user, LinkTarget $target );
186 
195  public function addWatchBatchForUser( UserIdentity $user, array $targets );
196 
210  public function removeWatch( UserIdentity $user, LinkTarget $target );
211 
221  public function setNotificationTimestampsForUser(
222  UserIdentity $user,
223  $timestamp,
224  array $targets = []
225  );
226 
235  public function resetAllNotificationTimestampsForUser( UserIdentity $user, $timestamp = null );
236 
247  public function updateNotificationTimestamp(
248  UserIdentity $editor, LinkTarget $target, $timestamp );
249 
265  public function resetNotificationTimestamp(
266  UserIdentity $user, LinkTarget $title, $force = '', $oldid = 0 );
267 
277  public function countUnreadNotifications( UserIdentity $user, $unreadLimit = null );
278 
290  public function duplicateAllAssociatedEntries( LinkTarget $oldTarget, LinkTarget $newTarget );
291 
304  public function duplicateEntry( LinkTarget $oldTarget, LinkTarget $newTarget );
305 
313  public function clearUserWatchedItems( UserIdentity $user );
314 
322  public function clearUserWatchedItemsUsingJobQueue( UserIdentity $user );
323 
332  public function removeWatchBatchForUser( UserIdentity $user, array $targets );
333 
347  public function getLatestNotificationTimestamp(
348  $timestamp, UserIdentity $user, LinkTarget $target );
349 }
WatchedItemStoreInterface\addWatchBatchForUser
addWatchBatchForUser(UserIdentity $user, array $targets)
WatchedItemStoreInterface\getNotificationTimestampsBatch
getNotificationTimestampsBatch(UserIdentity $user, array $targets)
WatchedItemStoreInterface\countWatchersMultiple
countWatchersMultiple(array $targets, array $options=[])
WatchedItemStoreInterface\countUnreadNotifications
countUnreadNotifications(UserIdentity $user, $unreadLimit=null)
WatchedItemStoreInterface\clearUserWatchedItemsUsingJobQueue
clearUserWatchedItemsUsingJobQueue(UserIdentity $user)
Queues a job that will clear the users watchlist using the Job Queue.
WatchedItemStoreInterface\updateNotificationTimestamp
updateNotificationTimestamp(UserIdentity $editor, LinkTarget $target, $timestamp)
WatchedItemStoreInterface\duplicateEntry
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.
WatchedItemStoreInterface\duplicateAllAssociatedEntries
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.
MediaWiki\User\UserIdentity
Interface for objects representing user identity.
Definition: UserIdentity.php:32
WatchedItemStoreInterface\getLatestNotificationTimestamp
getLatestNotificationTimestamp( $timestamp, UserIdentity $user, LinkTarget $target)
Convert $timestamp to TS_MW or return null if the page was visited since then by $user.
WatchedItemStoreInterface\getWatchedItemsForUser
getWatchedItemsForUser(UserIdentity $user, array $options=[])
WatchedItemStoreInterface\addWatch
addWatch(UserIdentity $user, LinkTarget $target)
Must be called separately for Subject & Talk namespaces.
WatchedItemStoreInterface\countVisitingWatchers
countVisitingWatchers(LinkTarget $target, $threshold)
Number of page watchers who also visited a "recent" edit.
WatchedItemStoreInterface\countWatchers
countWatchers(LinkTarget $target)
WatchedItemStoreInterface\resetNotificationTimestamp
resetNotificationTimestamp(UserIdentity $user, LinkTarget $title, $force='', $oldid=0)
Reset the notification timestamp of this entry.
WatchedItemStoreInterface\countVisitingWatchersMultiple
countVisitingWatchersMultiple(array $targetsWithVisitThresholds, $minimumWatchers=null)
Number of watchers of each page who have visited recent edits to that page.
WatchedItemStoreInterface\SORT_DESC
const SORT_DESC
Definition: WatchedItemStoreInterface.php:40
WatchedItemStoreInterface\isWatched
isWatched(UserIdentity $user, LinkTarget $target)
Must be called separately for Subject & Talk namespaces.
$title
$title
Definition: testCompression.php:36
WatchedItemStoreInterface\getWatchedItem
getWatchedItem(UserIdentity $user, LinkTarget $target)
Get an item (may be cached)
WatchedItemStoreInterface\loadWatchedItem
loadWatchedItem(UserIdentity $user, LinkTarget $target)
Loads an item from the db.
WatchedItemStoreInterface\setNotificationTimestampsForUser
setNotificationTimestampsForUser(UserIdentity $user, $timestamp, array $targets=[])
WatchedItemStoreInterface\SORT_ASC
const SORT_ASC
Definition: WatchedItemStoreInterface.php:35
Wikimedia\Rdbms\DBUnexpectedError
Definition: DBUnexpectedError.php:27
WatchedItemStoreInterface\removeWatchBatchForUser
removeWatchBatchForUser(UserIdentity $user, array $targets)
WatchedItemStoreInterface\resetAllNotificationTimestampsForUser
resetAllNotificationTimestampsForUser(UserIdentity $user, $timestamp=null)
Reset all watchlist notificaton timestamps for a user using the job queue.
WatchedItemStoreInterface\countWatchedItems
countWatchedItems(UserIdentity $user)
Count the number of individual items that are watched by the user.
WatchedItemStoreInterface\clearUserWatchedItems
clearUserWatchedItems(UserIdentity $user)
Synchronously clear the users watchlist.
MediaWiki\Linker\LinkTarget
Definition: LinkTarget.php:26
WatchedItemStoreInterface
Definition: WatchedItemStoreInterface.php:30
WatchedItemStoreInterface\removeWatch
removeWatch(UserIdentity $user, LinkTarget $target)
Removes an entry for the UserIdentity watching the LinkTarget Must be called separately for Subject &...