WatchedItem Class Reference

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

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

Static Public Member Functions
static	calculateExpiryInDays (?string $expiry)
	Get the number of days remaining until the given expiry time. More...
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 38 of file WatchedItem.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

UserIdentity	$user
LinkTarget | PageIdentity	$target	deprecated passing LinkTarget since 1.36
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 75 of file WatchedItem.php.

Member Function Documentation

calculateExpiryInDays()

static 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 194 of file WatchedItem.php.

Referenced by WatchAction\onSuccess().

getExpiry()

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 152 of file WatchedItem.php.

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

getExpiryInDays()

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 180 of file WatchedItem.php.

getExpiryInDaysText()

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 220 of file WatchedItem.php.

Referenced by WatchAction\getExpiryOptions().

getLinkTarget()

WatchedItem::getLinkTarget

(

)

Returns

LinkTarget

Deprecated:

since 1.36, use getTarget() instead

Definition at line 120 of file WatchedItem.php.

References getTarget().

getNotificationTimestamp()

WatchedItem::getNotificationTimestamp

(

)

Get the notification timestamp of this entry.

Returns

bool|null|string

Definition at line 140 of file WatchedItem.php.

getTarget()

WatchedItem::getTarget

(

)

Returns

LinkTarget|PageIdentity deprecated returning LinkTarget since 1.36

Since

1.36

Definition at line 131 of file WatchedItem.php.

Referenced by getLinkTarget().

getUserIdentity()

WatchedItem::getUserIdentity

(

)

Returns

UserIdentity

Definition at line 112 of file WatchedItem.php.

isExpired()

WatchedItem::isExpired

(

)

Has the watched item expired?

Since

1.35

Returns

bool

Definition at line 165 of file WatchedItem.php.

newFromRecentChange()

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

static

Since

1.35

Parameters

RecentChange	$recentChange
UserIdentity	$user

Returns

WatchedItem

Definition at line 100 of file WatchedItem.php.

References RecentChange\getTitle().

---

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

• includes/watcheditem/WatchedItem.php