MediaWiki  1.28.0
WatchedItemStore Class Reference

Storage layer class for WatchedItems. More...

Inheritance diagram for WatchedItemStore:
Collaboration diagram for WatchedItemStore:

Public Member Functions

 __construct (LoadBalancer $loadBalancer, HashBagOStuff $cache)
 
 addWatch (User $user, LinkTarget $target)
 Must be called separately for Subject & Talk namespaces. More...
 
 addWatchBatchForUser (User $user, array $targets)
 
 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...
 
 overrideDeferredUpdatesAddCallableUpdateCallback (callable $callback)
 Overrides the DeferredUpdates::addCallableUpdate callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined. More...
 
 overrideRevisionGetTimestampFromIdCallback (callable $callback)
 Overrides the Revision::getTimestampFromId callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined. 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...
 
 resetNotificationTimestamp (User $user, Title $title, $force= '', $oldid=0)
 Reset the notification timestamp of this entry. More...
 
 setNotificationTimestampsForUser (User $user, $timestamp, array $targets=[])
 
 setStatsdDataFactory (StatsdDataFactoryInterface $stats)
 Sets a StatsdDataFactory instance on the object. More...
 
 updateNotificationTimestamp (User $editor, LinkTarget $target, $timestamp)
 

Public Attributes

const SORT_ASC = 'ASC'
 
const SORT_DESC = 'DESC'
 

Private Member Functions

 cache (WatchedItem $item)
 
 dbCond (User $user, LinkTarget $target)
 Return an array of conditions to select or update the appropriate database row. More...
 
 getCached (User $user, LinkTarget $target)
 
 getCacheKey (User $user, LinkTarget $target)
 
 getConnectionRef ($dbIndex)
 
 getNotificationTimestamp (User $user, Title $title, $item, $force, $oldid)
 
 getVisitingWatchersCondition (IDatabase $db, array $targetsWithVisitThresholds)
 Generates condition for the query used in a batch count visiting watchers. More...
 
 uncache (User $user, LinkTarget $target)
 
 uncacheLinkTarget (LinkTarget $target)
 
 uncacheUser (User $user)
 

Private Attributes

HashBagOStuff $cache
 
array[] $cacheIndex = []
 Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => 'key' The index is needed so that on mass changes all relevant items can be un-cached. More...
 
callable null $deferredUpdatesAddCallableUpdateCallback
 
LoadBalancer $loadBalancer
 
callable null $revisionGetTimestampFromIdCallback
 
StatsdDataFactoryInterface $stats
 

Detailed Description

Storage layer class for WatchedItems.

Database interaction.

Author
Addshore
Since
1.27

Definition at line 16 of file WatchedItemStore.php.

Constructor & Destructor Documentation

WatchedItemStore::__construct ( LoadBalancer  $loadBalancer,
HashBagOStuff  $cache 
)
Parameters
LoadBalancer$loadBalancer
HashBagOStuff$cache

Definition at line 58 of file WatchedItemStore.php.

References $cache, $loadBalancer, and cache().

Member Function Documentation

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

Must be called separately for Subject & Talk namespaces.

Parameters
User$user
LinkTarget$target

Definition at line 581 of file WatchedItemStore.php.

References addWatchBatchForUser().

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

Definition at line 591 of file WatchedItemStore.php.

References as, DB_MASTER, false, getConnectionRef(), User\getId(), User\isAnon(), and uncache().

Referenced by addWatch().

WatchedItemStore::cache ( WatchedItem  $item)
private
WatchedItemStore::countUnreadNotifications ( User  $user,
  $unreadLimit = null 
)
Parameters
User$user
int$unreadLimit
Returns
int|bool The number of unread notifications true if greater than or equal to $unreadLimit

Definition at line 856 of file WatchedItemStore.php.

References $dbr, DB_REPLICA, getConnectionRef(), and User\getId().

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

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

Parameters
LinkTarget$target
mixed$thresholdtimestamp accepted by wfTimestamp
Returns
int
Exceptions
DBUnexpectedError
MWException

Definition at line 255 of file WatchedItemStore.php.

References $dbr, DB_REPLICA, getConnectionRef(), MediaWiki\Linker\LinkTarget\getDBkey(), and MediaWiki\Linker\LinkTarget\getNamespace().

WatchedItemStore::countVisitingWatchersMultiple ( array  $targetsWithVisitThresholds,
  $minimumWatchers = null 
)

Number of watchers of each page who have visited recent edits to that page.

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

Definition at line 327 of file WatchedItemStore.php.

References $dbr, $res, as, DB_REPLICA, getConnectionRef(), getVisitingWatchersCondition(), and list.

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

Parameters
User$user
Returns
int

Definition at line 211 of file WatchedItemStore.php.

References $dbr, DB_REPLICA, getConnectionRef(), and User\getId().

WatchedItemStore::countWatchers ( LinkTarget  $target)
Parameters
LinkTarget$target
Returns
int

Definition at line 230 of file WatchedItemStore.php.

References $dbr, DB_REPLICA, getConnectionRef(), MediaWiki\Linker\LinkTarget\getDBkey(), and MediaWiki\Linker\LinkTarget\getNamespace().

WatchedItemStore::countWatchersMultiple ( array  $targets,
array  $options = [] 
)
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.

Definition at line 282 of file WatchedItemStore.php.

References $dbr, $options, $res, as, DB_REPLICA, and getConnectionRef().

WatchedItemStore::dbCond ( User  $user,
LinkTarget  $target 
)
private

Return an array of conditions to select or update the appropriate database row.

Parameters
User$user
LinkTarget$target
Returns
array

Definition at line 185 of file WatchedItemStore.php.

References MediaWiki\Linker\LinkTarget\getDBkey(), User\getId(), and MediaWiki\Linker\LinkTarget\getNamespace().

Referenced by loadWatchedItem().

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

Parameters
LinkTarget$oldTarget
LinkTarget$newTarget

Definition at line 895 of file WatchedItemStore.php.

References duplicateEntry(), and Title\newFromLinkTarget().

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

Parameters
LinkTarget$oldTarget
LinkTarget$newTarget

Definition at line 913 of file WatchedItemStore.php.

References as, DB_MASTER, getConnectionRef(), MediaWiki\Linker\LinkTarget\getDBkey(), and MediaWiki\Linker\LinkTarget\getNamespace().

Referenced by duplicateAllAssociatedEntries().

WatchedItemStore::getCached ( User  $user,
LinkTarget  $target 
)
private
Parameters
User$user
LinkTarget$target
Returns
WatchedItem|null

Definition at line 172 of file WatchedItemStore.php.

References cache(), and getCacheKey().

Referenced by getNotificationTimestampsBatch(), and getWatchedItem().

WatchedItemStore::getCacheKey ( User  $user,
LinkTarget  $target 
)
private
WatchedItemStore::getNotificationTimestamp ( User  $user,
Title  $title,
  $item,
  $force,
  $oldid 
)
private

Definition at line 802 of file WatchedItemStore.php.

References Title\getNextRevisionID(), loadWatchedItem(), and TS_MW.

Referenced by resetNotificationTimestamp().

WatchedItemStore::getNotificationTimestampsBatch ( User  $user,
array  $targets 
)
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.

Definition at line 530 of file WatchedItemStore.php.

References $dbr, $res, as, DB_REPLICA, getCached(), getConnectionRef(), User\getId(), and User\isAnon().

WatchedItemStore::getVisitingWatchersCondition ( IDatabase  $db,
array  $targetsWithVisitThresholds 
)
private

Generates condition for the query used in a batch count visiting watchers.

Parameters
IDatabase$db
array$targetsWithVisitThresholdsarray of pairs (LinkTarget, last visit threshold)
Returns
string

Definition at line 367 of file WatchedItemStore.php.

References IDatabase\addQuotes(), as, list, LIST_AND, LIST_OR, IDatabase\makeList(), and IDatabase\timestamp().

Referenced by countVisitingWatchersMultiple().

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

Get an item (may be cached)

Parameters
User$user
LinkTarget$target
Returns
WatchedItem|false

Definition at line 412 of file WatchedItemStore.php.

References getCached(), User\isAnon(), and loadWatchedItem().

Referenced by isWatched().

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

Definition at line 471 of file WatchedItemStore.php.

References $options, $res, as, DB_MASTER, DB_REPLICA, false, getConnectionRef(), and User\getId().

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

Must be called separately for Subject & Talk namespaces.

Parameters
User$user
LinkTarget$target
Returns
bool

Definition at line 517 of file WatchedItemStore.php.

References getWatchedItem().

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

Loads an item from the db.

Parameters
User$user
LinkTarget$target
Returns
WatchedItem|false

Definition at line 434 of file WatchedItemStore.php.

References $dbr, cache(), DB_REPLICA, dbCond(), getConnectionRef(), and User\isAnon().

Referenced by getNotificationTimestamp(), getWatchedItem(), and resetNotificationTimestamp().

WatchedItemStore::overrideDeferredUpdatesAddCallableUpdateCallback ( callable  $callback)

Overrides the DeferredUpdates::addCallableUpdate callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.

Parameters
callable$callback
See also
DeferredUpdates::addCallableUpdate for callback signiture
Returns
ScopedCallback to reset the overridden value
Exceptions
MWException

Definition at line 84 of file WatchedItemStore.php.

References $deferredUpdatesAddCallableUpdateCallback, and use.

WatchedItemStore::overrideRevisionGetTimestampFromIdCallback ( callable  $callback)

Overrides the Revision::getTimestampFromId callback This is intended for use while testing and will fail if MW_PHPUNIT_TEST is not defined.

Parameters
callable$callback
See also
Revision::getTimestampFromId for callback signiture
Returns
ScopedCallback to reset the overridden value
Exceptions
MWException

Definition at line 107 of file WatchedItemStore.php.

References $revisionGetTimestampFromIdCallback, and use.

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

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

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

Definition at line 636 of file WatchedItemStore.php.

References $success, DB_MASTER, getConnectionRef(), MediaWiki\Linker\LinkTarget\getDBkey(), User\getId(), MediaWiki\Linker\LinkTarget\getNamespace(), User\isAnon(), and uncache().

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

Reset the notification timestamp of this entry.

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

Definition at line 763 of file WatchedItemStore.php.

References $job, User\getId(), getNotificationTimestamp(), User\isAnon(), loadWatchedItem(), uncache(), and use.

WatchedItemStore::setNotificationTimestampsForUser ( User  $user,
  $timestamp,
array  $targets = [] 
)
Parameters
User$userThe user to set the timestamp for
string$timestampSet the update timestamp to this value
LinkTarget[]$targets List of targets to update. Default to all targets
Returns
bool success

Definition at line 664 of file WatchedItemStore.php.

References $batch, $success, $timestamp, DB_MASTER, getConnectionRef(), User\getId(), User\isAnon(), and uncacheUser().

WatchedItemStore::setStatsdDataFactory ( StatsdDataFactoryInterface  $statsFactory)

Sets a StatsdDataFactory instance on the object.

Parameters
StatsdDataFactoryInterface$statsFactory
Returns
null

Implements StatsdAwareInterface.

Definition at line 69 of file WatchedItemStore.php.

References $stats.

WatchedItemStore::uncacheLinkTarget ( LinkTarget  $target)
private
WatchedItemStore::uncacheUser ( User  $user)
private

Definition at line 154 of file WatchedItemStore.php.

References as, cache(), and User\getId().

Referenced by setNotificationTimestampsForUser().

WatchedItemStore::updateNotificationTimestamp ( User  $editor,
LinkTarget  $target,
  $timestamp 
)
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

Definition at line 698 of file WatchedItemStore.php.

References $fname, $timestamp, DeferredUpdates\addCallableUpdate(), as, DB_MASTER, getConnectionRef(), MediaWiki\Linker\LinkTarget\getDBkey(), User\getId(), MediaWiki\Linker\LinkTarget\getNamespace(), global, DeferredUpdates\POSTSEND, uncacheLinkTarget(), use, and wfGetLBFactory().

Member Data Documentation

HashBagOStuff WatchedItemStore::$cache
private

Definition at line 29 of file WatchedItemStore.php.

Referenced by __construct().

array [] WatchedItemStore::$cacheIndex = []
private

Looks like $cacheIndex[Namespace ID][Target DB Key][User Id] => 'key' The index is needed so that on mass changes all relevant items can be un-cached.

For example: Clearing a users watchlist of all items or updating notification timestamps for all users watching a single target.

Definition at line 37 of file WatchedItemStore.php.

callable null WatchedItemStore::$deferredUpdatesAddCallableUpdateCallback
private
LoadBalancer WatchedItemStore::$loadBalancer
private

Definition at line 24 of file WatchedItemStore.php.

Referenced by __construct().

callable null WatchedItemStore::$revisionGetTimestampFromIdCallback
private

Definition at line 47 of file WatchedItemStore.php.

Referenced by overrideRevisionGetTimestampFromIdCallback().

StatsdDataFactoryInterface WatchedItemStore::$stats
private

Definition at line 52 of file WatchedItemStore.php.

Referenced by setStatsdDataFactory().

const WatchedItemStore::SORT_DESC = 'DESC'

Definition at line 18 of file WatchedItemStore.php.

Referenced by ApiQueryWatchlistRaw\run().


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