WatchedItemStoreInterface.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Watchlist;
 
use MediaWiki\Page\PageReference;
use MediaWiki\User\UserIdentity;
 
interface WatchedItemStoreInterface {
 
    public const SORT_ASC = 'ASC';
 
    public const SORT_DESC = 'DESC';
 
    public function countWatchedItems( UserIdentity $user );
 
    public function countWatchers( PageReference $target );
 
    public function countVisitingWatchers( PageReference $target, $threshold );
 
    public function countWatchersMultiple( array $targets, array $options = [] );
 
    public function countVisitingWatchersMultiple(
        array $targetsWithVisitThresholds,
        $minimumWatchers = null
    );
 
    public function getWatchedItem( UserIdentity $user, PageReference $target );
 
    public function loadWatchedItem( UserIdentity $user, PageReference $target );
 
    public function loadWatchedItemsBatch( UserIdentity $user, array $targets );
 
    public function getWatchedItemsForUser( UserIdentity $user, array $options = [] );
 
    public function isWatched( UserIdentity $user, PageReference $target );
 
    public function isTempWatched( UserIdentity $user, PageReference $target ): bool;
 
    public function getNotificationTimestampsBatch( UserIdentity $user, array $targets );
 
    public function addWatch( UserIdentity $user, PageReference $target, ?string $expiry = null );
 
    public function addWatchBatchForUser( UserIdentity $user, array $targets, ?string $expiry = null );
 
    public function removeWatch( UserIdentity $user, PageReference $target );
 
    public function setNotificationTimestampsForUser(
        UserIdentity $user,
        $timestamp,
        array $targets = []
    );
 
    public function resetAllNotificationTimestampsForUser( UserIdentity $user, $timestamp = null );
 
    public function updateNotificationTimestamp(
        UserIdentity $editor, PageReference $target, $timestamp );
 
    public function resetNotificationTimestamp(
        UserIdentity $user, PageReference $title, $force = '', $oldid = 0 );
 
    public function countUnreadNotifications( UserIdentity $user, $unreadLimit = null );
 
    public function duplicateAllAssociatedEntries( PageReference $oldTarget, PageReference $newTarget );
 
    public function duplicateEntry( PageReference $oldTarget, PageReference $newTarget );
 
    public function clearUserWatchedItems( UserIdentity $user );
 
    public function mustClearWatchedItemsUsingJobQueue( UserIdentity $user ): bool;
 
    public function clearUserWatchedItemsUsingJobQueue( UserIdentity $user );
 
    public function maybeEnqueueWatchlistExpiryJob(): void;
 
    public function removeWatchBatchForUser( UserIdentity $user, array $targets );
 
    public function getLatestNotificationTimestamp(
        $timestamp, UserIdentity $user, PageReference $target );
 
    public function countExpired(): int;
 
    public function removeExpired( int $limit, bool $deleteOrphans = false ): void;
 
    public function addLabels( UserIdentity $user, array $targets, array $labels ): void;
 
    public function removeLabels( UserIdentity $user, array $targets, array $labels ): void;
}
class_alias( WatchedItemStoreInterface::class, 'WatchedItemStoreInterface' );