WatchedItem.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkTarget;

class WatchedItem {

    const IGNORE_USER_RIGHTS = User::IGNORE_USER_RIGHTS;

    const CHECK_USER_RIGHTS = User::CHECK_USER_RIGHTS;

    const DEPRECATED_USAGE_TIMESTAMP = -100;

    public $checkRights = User::CHECK_USER_RIGHTS;

    private $title;

    private $linkTarget;

    private $user;

    private $notificationTimestamp;

    public function __construct(
        User $user,
        LinkTarget $linkTarget,
        $notificationTimestamp,
        $checkRights = null
    ) {
        $this->user = $user;
        $this->linkTarget = $linkTarget;
        $this->notificationTimestamp = $notificationTimestamp;
        if ( $checkRights !== null ) {
            $this->checkRights = $checkRights;
        }
    }

    public function getUser() {
        return $this->user;
    }

    public function getLinkTarget() {
        return $this->linkTarget;
    }

    public function getNotificationTimestamp() {
        // Back compat for objects constructed using self::fromUserTitle
        if ( $this->notificationTimestamp === self::DEPRECATED_USAGE_TIMESTAMP ) {
            // wfDeprecated( __METHOD__, '1.27' );
            if ( $this->checkRights && !$this->user->isAllowed( 'viewmywatchlist' ) ) {
                return false;
            }
            $item = WatchedItemStore::getDefaultInstance()
                ->loadWatchedItem( $this->user, $this->linkTarget );
            if ( $item ) {
                $this->notificationTimestamp = $item->getNotificationTimestamp();
            } else {
                $this->notificationTimestamp = false;
            }
        }
        return $this->notificationTimestamp;
    }

    public function getTitle() {
        if ( !$this->title ) {
            $this->title = Title::newFromLinkTarget( $this->linkTarget );
        }
        return $this->title;
    }

    public static function fromUserTitle( $user, $title, $checkRights = User::CHECK_USER_RIGHTS ) {
        // wfDeprecated( __METHOD__, '1.27' );
        return new self( $user, $title, self::DEPRECATED_USAGE_TIMESTAMP, (bool)$checkRights );
    }

    public function resetNotificationTimestamp( $force = '', $oldid = 0 ) {
        // wfDeprecated( __METHOD__, '1.27' );
        if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {
            return;
        }
        WatchedItemStore::getDefaultInstance()->resetNotificationTimestamp(
            $this->user,
            $this->getTitle(),
            $force,
            $oldid
        );
    }

    public static function batchAddWatch( array $items ) {
        // wfDeprecated( __METHOD__, '1.27' );
        if ( !$items ) {
            return false;
        }

        $targets = [];
        $users = [];
        foreach ( $items as $watchedItem ) {
            $user = $watchedItem->getUser();
            if ( $watchedItem->checkRights && !$user->isAllowed( 'editmywatchlist' ) ) {
                continue;
            }
            $userId = $user->getId();
            $users[$userId] = $user;
            $targets[$userId][] = $watchedItem->getTitle()->getSubjectPage();
            $targets[$userId][] = $watchedItem->getTitle()->getTalkPage();
        }

        $store = WatchedItemStore::getDefaultInstance();
        $success = true;
        foreach ( $users as $userId => $user ) {
            $success &= $store->addWatchBatchForUser( $user, $targets[$userId] );
        }

        return $success;
    }

    public function addWatch() {
        // wfDeprecated( __METHOD__, '1.27' );
        $this->user->addWatch( $this->getTitle(), $this->checkRights );
        return true;
    }

    public function removeWatch() {
        // wfDeprecated( __METHOD__, '1.27' );
        if ( $this->checkRights && !$this->user->isAllowed( 'editmywatchlist' ) ) {
            return false;
        }
        $this->user->removeWatch( $this->getTitle(), $this->checkRights );
        return true;
    }

    public function isWatched() {
        // wfDeprecated( __METHOD__, '1.27' );
        return $this->user->isWatched( $this->getTitle(), $this->checkRights );
    }

    public static function duplicateEntries( Title $oldTitle, Title $newTitle ) {
        // wfDeprecated( __METHOD__, '1.27' );
        $store = WatchedItemStore::getDefaultInstance();
        $store->duplicateAllAssociatedEntries( $oldTitle, $newTitle );
    }

}