MediaWiki  master
WatchedItem Class Reference

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

Collaboration diagram for WatchedItem:

Public Member Functions

 __construct (UserIdentity $user, LinkTarget $linkTarget, $notificationTimestamp, ?string $expiry=null)
 
 getExpiry ()
 When the watched item will expire. More...
 
 getLinkTarget ()
 
 getNotificationTimestamp ()
 Get the notification timestamp of this entry. More...
 
 getUser ()
 
 getUserIdentity ()
 
 isExpired ()
 Has the watched item expired? More...
 

Private Attributes

string null $expiry
 When to automatically unwatch the page. More...
 
LinkTarget $linkTarget
 
null string $notificationTimestamp
 the value of the wl_notificationtimestamp field More...
 
UserIdentity $user
 

Detailed Description

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

Author
Tim Starling
Addshore

Definition at line 33 of file WatchedItem.php.

Constructor & Destructor Documentation

◆ __construct()

WatchedItem::__construct ( UserIdentity  $user,
LinkTarget  $linkTarget,
  $notificationTimestamp,
?string  $expiry = null 
)
Parameters
UserIdentity$user
LinkTarget$linkTarget
null | string$notificationTimestampthe value of the wl_notificationtimestamp field
null | string$expiryOptional expiry timestamp in any format acceptable to wfTimestamp()

Definition at line 60 of file WatchedItem.php.

References $expiry, $linkTarget, $notificationTimestamp, and $user.

Member Function Documentation

◆ getExpiry()

WatchedItem::getExpiry ( )

When the watched item will expire.

Since
1.35
Returns
string|null null or in a format acceptable to wfTimestamp().

Definition at line 110 of file WatchedItem.php.

References $expiry.

Referenced by isExpired().

◆ getLinkTarget()

WatchedItem::getLinkTarget ( )
Returns
LinkTarget

Definition at line 90 of file WatchedItem.php.

References $linkTarget.

Referenced by WatchedItemStore\cache(), ApiQueryWatchlist\extractOutputData(), and ApiQueryWatchlist\run().

◆ getNotificationTimestamp()

WatchedItem::getNotificationTimestamp ( )

Get the notification timestamp of this entry.

Returns
bool|null|string

Definition at line 99 of file WatchedItem.php.

References $notificationTimestamp.

Referenced by ApiQueryWatchlist\extractOutputData().

◆ getUser()

WatchedItem::getUser ( )
Deprecated:
since 1.34, use getUserIdentity()
Returns
User

Definition at line 76 of file WatchedItem.php.

References User\newFromIdentity().

◆ getUserIdentity()

WatchedItem::getUserIdentity ( )
Returns
UserIdentity

Definition at line 83 of file WatchedItem.php.

References $user.

Referenced by WatchedItemStore\cache().

◆ isExpired()

WatchedItem::isExpired ( )

Has the watched item expired?

Since
1.35
Returns
bool

Definition at line 121 of file WatchedItem.php.

References getExpiry(), and wfTimestamp().

Member Data Documentation

◆ $expiry

string null WatchedItem::$expiry
private

When to automatically unwatch the page.

Definition at line 52 of file WatchedItem.php.

Referenced by __construct(), and getExpiry().

◆ $linkTarget

LinkTarget WatchedItem::$linkTarget
private

Definition at line 37 of file WatchedItem.php.

Referenced by __construct(), and getLinkTarget().

◆ $notificationTimestamp

null string WatchedItem::$notificationTimestamp
private

the value of the wl_notificationtimestamp field

Definition at line 47 of file WatchedItem.php.

Referenced by __construct(), and getNotificationTimestamp().

◆ $user

UserIdentity WatchedItem::$user
private

Definition at line 42 of file WatchedItem.php.

Referenced by __construct(), and getUserIdentity().


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