MediaWiki  master
MediaWiki\User\TalkPageNotificationManager Class Reference

Manages user talk page notifications. More...

Public Member Functions

 __construct (ServiceOptions $serviceOptions, ILoadBalancer $loadBalancer, ReadOnlyMode $readOnlyMode, RevisionLookup $revisionLookup, HookContainer $hookContainer, UserFactory $userFactory)
 
 clearForPageView (UserIdentity $user, RevisionRecord $oldRev=null)
 Clear notifications when the user's own talk page is viewed. More...
 
 clearInstanceCache (UserIdentity $user)
 Remove the cached newtalk status for the given user. More...
 
 getLatestSeenMessageTimestamp (UserIdentity $user)
 Returns the timestamp of the latest revision of the user talkpage that the user has already seen in TS_MW format. More...
 
 removeUserHasNewMessages (UserIdentity $user)
 Remove the new messages status. More...
 
 setUserHasNewMessages (UserIdentity $user, RevisionRecord $curRev=null)
 Update the talk page messages status. More...
 
 userHasNewMessages (UserIdentity $user)
 Check if the user has new messages. More...
 

Public Attributes

const CONSTRUCTOR_OPTIONS
 

Detailed Description

Manages user talk page notifications.

Since
1.35

Definition at line 39 of file TalkPageNotificationManager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\TalkPageNotificationManager::__construct ( ServiceOptions  $serviceOptions,
ILoadBalancer  $loadBalancer,
ReadOnlyMode  $readOnlyMode,
RevisionLookup  $revisionLookup,
HookContainer  $hookContainer,
UserFactory  $userFactory 
)
Parameters
ServiceOptions$serviceOptions
ILoadBalancer$loadBalancer
ReadOnlyMode$readOnlyMode
RevisionLookup$revisionLookup
HookContainer$hookContainer
UserFactory$userFactory

Definition at line 77 of file TalkPageNotificationManager.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), MediaWiki\MainConfigNames\DisableAnonTalk, and MediaWiki\Config\ServiceOptions\get().

Member Function Documentation

◆ clearForPageView()

MediaWiki\User\TalkPageNotificationManager::clearForPageView ( UserIdentity  $user,
RevisionRecord  $oldRev = null 
)

Clear notifications when the user's own talk page is viewed.

Parameters
UserIdentity$user
RevisionRecord | null$oldRevIf it is an old revision view, the old revision. If it is a current revision view, this should be null.

Definition at line 122 of file TalkPageNotificationManager.php.

References DeferredUpdates\addCallableUpdate().

◆ clearInstanceCache()

MediaWiki\User\TalkPageNotificationManager::clearInstanceCache ( UserIdentity  $user)

Remove the cached newtalk status for the given user.

Access: internal
There should be no need to call this other than from User::clearInstanceCache
Parameters
UserIdentity$user

Definition at line 249 of file TalkPageNotificationManager.php.

◆ getLatestSeenMessageTimestamp()

MediaWiki\User\TalkPageNotificationManager::getLatestSeenMessageTimestamp ( UserIdentity  $user)

Returns the timestamp of the latest revision of the user talkpage that the user has already seen in TS_MW format.

If the user has no new messages, returns null

Parameters
UserIdentity$user
Returns
string|null

Definition at line 217 of file TalkPageNotificationManager.php.

◆ removeUserHasNewMessages()

MediaWiki\User\TalkPageNotificationManager::removeUserHasNewMessages ( UserIdentity  $user)

Remove the new messages status.

Parameters
UserIdentity$user

Definition at line 198 of file TalkPageNotificationManager.php.

◆ setUserHasNewMessages()

MediaWiki\User\TalkPageNotificationManager::setUserHasNewMessages ( UserIdentity  $user,
RevisionRecord  $curRev = null 
)

Update the talk page messages status.

Parameters
UserIdentity$user
RevisionRecord | null$curRevNew, as yet unseen revision of the user talk page. Null is acceptable in case the revision is not known. This will indicate that new messages exist, but will not affect the latest seen message timestamp

Definition at line 180 of file TalkPageNotificationManager.php.

◆ userHasNewMessages()

MediaWiki\User\TalkPageNotificationManager::userHasNewMessages ( UserIdentity  $user)

Check if the user has new messages.

Parameters
UserIdentity$user
Returns
bool whether the user has new messages

Definition at line 99 of file TalkPageNotificationManager.php.

Member Data Documentation

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\User\TalkPageNotificationManager::CONSTRUCTOR_OPTIONS
Initial value:
= [
]
const DisableAnonTalk
Name constant for the DisableAnonTalk setting, for use with Config::get()
Access: internal
For use by ServiceWiring

Definition at line 44 of file TalkPageNotificationManager.php.


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