MediaWiki  1.34.0
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)
 
 getLinkTarget ()
 
 getNotificationTimestamp ()
 Get the notification timestamp of this entry. More...
 
 getUser ()
 
 getUserIdentity ()
 

Private Attributes

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 
)
Parameters
UserIdentity$user
LinkTarget$linkTarget
null | string$notificationTimestampthe value of the wl_notificationtimestamp field

Definition at line 54 of file WatchedItem.php.

References $linkTarget, $notificationTimestamp, and $user.

Member Function Documentation

◆ getLinkTarget()

WatchedItem::getLinkTarget ( )
Returns
LinkTarget

Definition at line 82 of file WatchedItem.php.

References $linkTarget.

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

◆ getNotificationTimestamp()

WatchedItem::getNotificationTimestamp ( )

Get the notification timestamp of this entry.

Returns
bool|null|string

Definition at line 91 of file WatchedItem.php.

References $notificationTimestamp.

Referenced by ApiQueryWatchlist\extractOutputData().

◆ getUser()

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

Definition at line 68 of file WatchedItem.php.

References User\newFromIdentity().

◆ getUserIdentity()

WatchedItem::getUserIdentity ( )
Returns
UserIdentity

Definition at line 75 of file WatchedItem.php.

References $user.

Referenced by WatchedItemStore\cache().

Member Data Documentation

◆ $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: