MediaWiki\Watchlist\WatchedItem Class Reference

Representation of a pair of user and title for watchlist entries. More...

Public Member Functions
	__construct (UserIdentity $user, PageReference $target, $notificationTimestamp, ?string $expiry=null)
	getExpiry (?int $style=TS_MW)
	When the watched item will expire.
	getExpiryInDays ()
	Get days remaining until a watched item expires.
	getExpiryInDaysText (MessageLocalizer $msgLocalizer, $isDropdownOption=false)
	Get days remaining until a watched item expires as a text.
	getLinkTarget ()
	getNotificationTimestamp ()
	Get the notification timestamp of this entry.
	getTarget ()
	getUserIdentity ()
	isExpired ()
	Has the watched item expired?

Static Public Member Functions
static	calculateExpiryInDays (?string $expiry)
	Get the number of days remaining until the given expiry time.
static	newFromRecentChange (RecentChange $recentChange, UserIdentity $user)

Detailed Description

Representation of a pair of user and title for watchlist entries.

Author

Tim Starling

Addshore

Definition at line 28 of file WatchedItem.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Watchlist\WatchedItem::__construct	(	UserIdentity	$user,
		PageReference	$target,
			$notificationTimestamp,
		?string	$expiry = null )

Parameters

UserIdentity	$user
PageReference	$target
bool | null | string	$notificationTimestamp	the value of the wl_notificationtimestamp field
null | string	$expiry	Optional expiry timestamp in any format acceptable to wfTimestamp()

Definition at line 65 of file WatchedItem.php.

Member Function Documentation

calculateExpiryInDays()

static MediaWiki\Watchlist\WatchedItem::calculateExpiryInDays ( ?string $expiry )

static

Get the number of days remaining until the given expiry time.

Since

1.35

Parameters

string | null

$expiry

The expiry to calculate from, in any format supported by MWTimestamp::convert().

Returns

int|null The remaining number of days or null if $expiry is null.

Definition at line 182 of file WatchedItem.php.

Referenced by MediaWiki\Actions\WatchAction\makeSuccessMessage().

getExpiry()

MediaWiki\Watchlist\WatchedItem::getExpiry

(

?int

$style = TS_MW

)

When the watched item will expire.

Since

1.35

Parameters

int | null

$style

Given timestamp format to style the ConvertibleTimestamp

Returns

string|null null or in a format acceptable to ConvertibleTimestamp (TS_* constants). Default is TS_MW format.

Definition at line 140 of file WatchedItem.php.

Referenced by MediaWiki\Actions\WatchAction\getExpiryOptions(), and MediaWiki\Specials\SpecialWatchlist\outputChangesList().

getExpiryInDays()

MediaWiki\Watchlist\WatchedItem::getExpiryInDays

(

)

Get days remaining until a watched item expires.

Since

1.35

Returns

int|null days remaining or null if no expiration is present

Definition at line 168 of file WatchedItem.php.

getExpiryInDaysText()

MediaWiki\Watchlist\WatchedItem::getExpiryInDaysText	(	MessageLocalizer	$msgLocalizer,
			$isDropdownOption = false )

Get days remaining until a watched item expires as a text.

Since

1.35

Parameters

MessageLocalizer	$msgLocalizer
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.

Returns

string days remaining text and '' if no expiration is present

Definition at line 208 of file WatchedItem.php.

Referenced by MediaWiki\Actions\WatchAction\getExpiryOptions().

getLinkTarget()

MediaWiki\Watchlist\WatchedItem::getLinkTarget

(

)

Returns

LinkTarget

Deprecated

since 1.36, use getTarget() instead

Definition at line 110 of file WatchedItem.php.

References MediaWiki\Watchlist\WatchedItem\getTarget(), and wfDeprecated().

getNotificationTimestamp()

MediaWiki\Watchlist\WatchedItem::getNotificationTimestamp

(

)

Get the notification timestamp of this entry.

Returns

bool|null|string

Definition at line 128 of file WatchedItem.php.

getTarget()

MediaWiki\Watchlist\WatchedItem::getTarget

(

)

Returns

PageReference

Since

1.36

Definition at line 119 of file WatchedItem.php.

Referenced by MediaWiki\Watchlist\WatchedItem\getLinkTarget().

getUserIdentity()

MediaWiki\Watchlist\WatchedItem::getUserIdentity

(

)

Returns

UserIdentity

Definition at line 102 of file WatchedItem.php.

isExpired()

MediaWiki\Watchlist\WatchedItem::isExpired

(

)

Has the watched item expired?

Since

1.35

Returns

bool

Definition at line 153 of file WatchedItem.php.

newFromRecentChange()

static MediaWiki\Watchlist\WatchedItem::newFromRecentChange ( RecentChange $recentChange, UserIdentity $user )

static

Since

1.35

Parameters

RecentChange	$recentChange
UserIdentity	$user

Returns

WatchedItem

Definition at line 90 of file WatchedItem.php.

References MediaWiki\RecentChanges\RecentChange\getTitle().

---

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

• includes/Watchlist/WatchedItem.php