Page MenuHomeWickedGov Phorge
Files F4134782

WatchedItem.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

WatchedItem.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
* @ingroup Watchlist
*/
namespace MediaWiki\Watchlist;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Page\PageIdentity;
use MediaWiki\RecentChanges\RecentChange;
use MediaWiki\Title\TitleValue;
use MediaWiki\User\UserIdentity;
use MediaWiki\Utils\MWTimestamp;
use MessageLocalizer;
use Wikimedia\ParamValidator\TypeDef\ExpiryDef;
use Wikimedia\Timestamp\ConvertibleTimestamp;
/**
* Representation of a pair of user and title for watchlist entries.
*
* @author Tim Starling
* @author Addshore
*
* @ingroup Watchlist
*/
class WatchedItem {
/**
* @var LinkTarget|PageIdentity deprecated LinkTarget since 1.36
*/
private $target;
/**
* @var UserIdentity
*/
private $user;
/**
* @var bool|null|string the value of the wl_notificationtimestamp field
*/
private $notificationTimestamp;
/**
* @var ConvertibleTimestamp|null value that determines when a watched item will expire.
* 'null' means that there is no expiration.
*/
private $expiry;
/**
* Used to calculate how many days are remaining until a watched item will expire.
* Uses a different algorithm from Language::getDurationIntervals for calculating
* days remaining in an interval of time
*
* @since 1.35
*/
private const SECONDS_IN_A_DAY = 86400;
/**
* @param UserIdentity $user
* @param LinkTarget|PageIdentity $target deprecated passing LinkTarget since 1.36
* @param bool|null|string $notificationTimestamp the value of the wl_notificationtimestamp field
* @param null|string $expiry Optional expiry timestamp in any format acceptable to wfTimestamp()
*/
public function __construct(
UserIdentity $user,
$target,
$notificationTimestamp,
?string $expiry = null
) {
$this->user = $user;
$this->target = $target;
$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;
}
}
/**
* @since 1.35
* @param RecentChange $recentChange
* @param UserIdentity $user
* @return WatchedItem
*/
public static function newFromRecentChange( RecentChange $recentChange, UserIdentity $user ) {
return new self(
$user,
$recentChange->getTitle(),
$recentChange->notificationtimestamp,
$recentChange->watchlistExpiry
);
}
/**
* @return UserIdentity
*/
public function getUserIdentity() {
return $this->user;
}
/**
* @return LinkTarget
* @deprecated since 1.36, use getTarget() instead
*/
public function getLinkTarget() {
if ( !$this->target instanceof LinkTarget ) {
return TitleValue::newFromPage( $this->target );
}
return $this->getTarget();
}
/**
* @return LinkTarget|PageIdentity deprecated returning LinkTarget since 1.36
* @since 1.36
*/
public function getTarget() {
return $this->target;
}
/**
* Get the notification timestamp of this entry.
*
* @return bool|null|string
*/
public function getNotificationTimestamp() {
return $this->notificationTimestamp;
}
/**
* When the watched item will expire.
*
* @since 1.35
* @param int|null $style Given timestamp format to style the ConvertibleTimestamp
* @return string|null null or in a format acceptable to ConvertibleTimestamp (TS_* constants).
* Default is TS_MW format.
*/
public function getExpiry( ?int $style = TS_MW ) {
return $this->expiry instanceof ConvertibleTimestamp
? $this->expiry->getTimestamp( $style )
: $this->expiry;
}
/**
* Has the watched item expired?
*
* @since 1.35
*
* @return bool
*/
public function isExpired(): bool {
$expiry = $this->getExpiry();
if ( $expiry === null ) {
return false;
}
return $expiry < ConvertibleTimestamp::now();
}
/**
* Get days remaining until a watched item expires.
*
* @since 1.35
*
* @return int|null days remaining or null if no expiration is present
*/
public function getExpiryInDays(): ?int {
return self::calculateExpiryInDays( $this->getExpiry() );
}
/**
* Get the number of days remaining until the given expiry time.
*
* @since 1.35
*
* @param string|null $expiry The expiry to calculate from, in any format
* supported by MWTimestamp::convert().
*
* @return int|null The remaining number of days or null if $expiry is null.
*/
public static function calculateExpiryInDays( ?string $expiry ): ?int {
if ( $expiry === null ) {
return null;
}
$unixTimeExpiry = (int)MWTimestamp::convert( TS_UNIX, $expiry );
$diffInSeconds = $unixTimeExpiry - (int)wfTimestamp( TS_UNIX );
$diffInDays = $diffInSeconds / self::SECONDS_IN_A_DAY;
if ( $diffInDays < 1 ) {
return 0;
}
return (int)ceil( $diffInDays );
}
/**
* Get days remaining until a watched item expires as a text.
*
* @since 1.35
* @param MessageLocalizer $msgLocalizer
* @param bool $isDropdownOption Whether the text is being displayed as a dropdown option.
* The text is different as a dropdown option from when it is used in other
* places as a watchlist indicator.
* @return string days remaining text and '' if no expiration is present
*/
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' )->numParams( $expiryInDays )->text();
}
return $msgLocalizer->msg( 'watchlist-expiring-days-full-text' )->numParams( $expiryInDays )->text();
}
}
/** @deprecated class alias since 1.43 */
class_alias( WatchedItem::class, 'WatchedItem' );

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 12:48 (3 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
75/4c/364581a82a14b8076bf20912da8e
Default Alt Text
WatchedItem.php (5 KB)

Event Timeline