MediaWiki REL1_31
WatchedItemStoreInterface.php
Go to the documentation of this file.
1<?php
22
28
32 const SORT_ASC = 'ASC';
33
37 const SORT_DESC = 'DESC';
38
49 public function countWatchedItems( User $user );
50
58 public function countWatchers( LinkTarget $target );
59
72 public function countVisitingWatchers( LinkTarget $target, $threshold );
73
85 public function countWatchersMultiple( array $targets, array $options = [] );
86
108 array $targetsWithVisitThresholds,
109 $minimumWatchers = null
110 );
111
122 public function getWatchedItem( User $user, LinkTarget $target );
123
134 public function loadWatchedItem( User $user, LinkTarget $target );
135
147 public function getWatchedItemsForUser( User $user, array $options = [] );
148
159 public function isWatched( User $user, LinkTarget $target );
160
172 public function getNotificationTimestampsBatch( User $user, array $targets );
173
182 public function addWatch( User $user, LinkTarget $target );
183
192 public function addWatchBatchForUser( User $user, array $targets );
193
207 public function removeWatch( User $user, LinkTarget $target );
208
219 User $user,
220 $timestamp,
221 array $targets = []
222 );
223
232
243 public function updateNotificationTimestamp( User $editor, LinkTarget $target, $timestamp );
244
260 public function resetNotificationTimestamp( User $user, Title $title, $force = '', $oldid = 0 );
261
271 public function countUnreadNotifications( User $user, $unreadLimit = null );
272
284 public function duplicateAllAssociatedEntries( LinkTarget $oldTarget, LinkTarget $newTarget );
285
298 public function duplicateEntry( LinkTarget $oldTarget, LinkTarget $newTarget );
299
307 public function clearUserWatchedItems( User $user );
308
316 public function clearUserWatchedItemsUsingJobQueue( User $user );
317
318}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Represents a title within MediaWiki.
Definition Title.php:39
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:53
the array() calling protocol came about after MediaWiki 1.4rc1.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:2001
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error etc yourself modifying $error and returning true will cause the contents of $error to be echoed at the top of the edit form as wikitext Return true without altering $error to allow the edit to proceed & $editor
Definition hooks.txt:1419
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
countWatchersMultiple(array $targets, array $options=[])
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.
getNotificationTimestampsBatch(User $user, array $targets)
removeWatch(User $user, LinkTarget $target)
Removes the an entry for the User watching the LinkTarget Must be called separately for Subject & Tal...
setNotificationTimestampsForUser(User $user, $timestamp, array $targets=[])
clearUserWatchedItemsUsingJobQueue(User $user)
Queues a job that will clear the users watchlist using the Job Queue.
countVisitingWatchersMultiple(array $targetsWithVisitThresholds, $minimumWatchers=null)
Number of watchers of each page who have visited recent edits to that page.
countWatchers(LinkTarget $target)
countVisitingWatchers(LinkTarget $target, $threshold)
Number of page watchers who also visited a "recent" edit.
resetNotificationTimestamp(User $user, Title $title, $force='', $oldid=0)
Reset the notification timestamp of this entry.
addWatch(User $user, LinkTarget $target)
Must be called separately for Subject & Talk namespaces.
clearUserWatchedItems(User $user)
Queues a job that will clear the users watchlist using the Job Queue.
countWatchedItems(User $user)
Count the number of individual items that are watched by the user.
updateNotificationTimestamp(User $editor, LinkTarget $target, $timestamp)
resetAllNotificationTimestampsForUser(User $user)
Reset all watchlist notificaton timestamps for a user using the job queue.
loadWatchedItem(User $user, LinkTarget $target)
Loads an item from the db.
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.
countUnreadNotifications(User $user, $unreadLimit=null)
getWatchedItem(User $user, LinkTarget $target)
Get an item (may be cached)
addWatchBatchForUser(User $user, array $targets)
isWatched(User $user, LinkTarget $target)
Must be called separately for Subject & Talk namespaces.
getWatchedItemsForUser(User $user, array $options=[])