WatchedItem.php

Go to the documentation of this file.

<?php
use MediaWiki\Linker\LinkTarget;
use MediaWiki\User\UserIdentity;
use Wikimedia\ParamValidator\TypeDef\ExpiryDef;
use Wikimedia\Timestamp\ConvertibleTimestamp;
 
class WatchedItem {
    private $linkTarget;
 
    private $user;
 
    private $notificationTimestamp;
 
    private $expiry;
 
    private const SECONDS_IN_A_DAY = 86400;
 
    public function __construct(
        UserIdentity $user,
        LinkTarget $linkTarget,
        $notificationTimestamp,
        ?string $expiry = null
    ) {
        $this->user = $user;
        $this->linkTarget = $linkTarget;
        $this->notificationTimestamp = $notificationTimestamp;
 
        // Expiry will be saved in ConvertibleTimestamp
        $this->expiry = ExpiryDef::normalizeExpiry( $expiry );
 
        // If the normalization returned 'infinity' then set it as null since they are synonymous
        if ( $this->expiry === 'infinity' ) {
            $this->expiry = null;
        }
    }
 
    public static function newFromRecentChange( RecentChange $recentChange, UserIdentity $user ) {
        return new self(
            $user,
            $recentChange->getTitle(),
            $recentChange->notificationtimestamp,
            $recentChange->watchlistExpiry
        );
    }
 
    public function getUser() {
        wfDeprecated( __METHOD__, '1.34' );
        return User::newFromIdentity( $this->user );
    }
 
    public function getUserIdentity() {
        return $this->user;
    }
 
    public function getLinkTarget() {
        return $this->linkTarget;
    }
 
    public function getNotificationTimestamp() {
        return $this->notificationTimestamp;
    }
 
    public function getExpiry( ?int $style = TS_MW ) {
        return $this->expiry instanceof ConvertibleTimestamp
            ? $this->expiry->getTimestamp( $style )
            : $this->expiry;
    }
 
    public function isExpired(): bool {
        $expiry = $this->getExpiry();
        if ( $expiry === null ) {
            return false;
        }
        return $expiry < ConvertibleTimestamp::now();
    }
 
    public function getExpiryInDays(): ?int {
        return self::calculateExpiryInDays( $this->getExpiry() );
    }
 
    public static function calculateExpiryInDays( ?string $expiry ): ?int {
        if ( $expiry === null ) {
            return null;
        }
 
        $unixTimeExpiry = MWTimestamp::convert( TS_UNIX, $expiry );
        $diffInSeconds = $unixTimeExpiry - wfTimestamp();
        $diffInDays = $diffInSeconds / self::SECONDS_IN_A_DAY;
 
        if ( $diffInDays < 1 ) {
            return 0;
        }
 
        return (int)ceil( $diffInDays );
    }
 
    public function getExpiryInDaysText( MessageLocalizer $msgLocalizer, $isDropdownOption = false ): string {
        $expiryInDays = $this->getExpiryInDays();
        if ( $expiryInDays === null ) {
            return '';
        }
 
        if ( $expiryInDays < 1 ) {
            if ( $isDropdownOption ) {
                return $msgLocalizer->msg( 'watchlist-expiry-hours-left' )->text();
            }
            return $msgLocalizer->msg( 'watchlist-expiring-hours-full-text' )->text();
        }
 
        if ( $isDropdownOption ) {
            return $msgLocalizer->msg( 'watchlist-expiry-days-left', [ $expiryInDays ] )->text();
        }
 
        return $msgLocalizer->msg( 'watchlist-expiring-days-full-text', [ $expiryInDays ] )->text();
    }
}