Manages user talk page notifications. More...

Collaboration diagram for MediaWiki\User\TalkPageNotificationManager:

[legend]

Public Member Functions
	__construct (ServiceOptions $serviceOptions, ILoadBalancer $loadBalancer, ReadOnlyMode $readOnlyMode, RevisionLookup $revisionLookup)

	clearInstanceCache (UserIdentity $user)
	Remove the cached newtalk status for the given user.

	getLatestSeenMessageTimestamp (UserIdentity $user)
	Returns the timestamp of the latest revision of the user talkpage that the user has already seen in TS_MW format.

	removeUserHasNewMessages (UserIdentity $user)
	Remove the new messages status.

	setUserHasNewMessages (UserIdentity $user, RevisionRecord $curRev=null)
	Update the talk page messages status.

	userHasNewMessages (UserIdentity $user)
	Check if the user has new messages.

Public Attributes
const	CONSTRUCTOR_OPTIONS

Private Member Functions
	dbCheckNewUserMessages (UserIdentity $user)
	Internal uncached check for new messages.

	dbDeleteNewUserMessages (UserIdentity $user)
	Clear the new messages flag for the given user.

	dbUpdateNewUserMessages (UserIdentity $user, RevisionRecord $curRev=null)
	Add or update the new messages flag.

	getCacheKey (UserIdentity $user)
	Gets a unique key for various caches.

	getQueryFieldAndId (UserIdentity $user)
	Get the field name and id for the user_newtalk table query.

	isTalkDisabled (UserIdentity $user)
	Check whether the talk page is disabled for a user.

Private Attributes
bool	$disableAnonTalk

ILoadBalancer	$loadBalancer

ReadOnlyMode	$readOnlyMode

RevisionLookup	$revisionLookup

array	$userMessagesCache = []

Detailed Description

Manages user talk page notifications.

Since: 1.35

Definition at line 35 of file TalkPageNotificationManager.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\User\TalkPageNotificationManager::__construct	(	ServiceOptions	$serviceOptions,
		ILoadBalancer	$loadBalancer,
		ReadOnlyMode	$readOnlyMode,
		RevisionLookup	$revisionLookup )

Parameters

ServiceOptions	$serviceOptions
ILoadBalancer	$loadBalancer
ReadOnlyMode	$readOnlyMode
RevisionLookup	$revisionLookup

Definition at line 62 of file TalkPageNotificationManager.php.

References MediaWiki\User\TalkPageNotificationManager\$loadBalancer, MediaWiki\User\TalkPageNotificationManager\$readOnlyMode, MediaWiki\User\TalkPageNotificationManager\$revisionLookup, MediaWiki\Config\ServiceOptions\assertRequiredOptions(), and MediaWiki\Config\ServiceOptions\get().

Member Function Documentation

◆ clearInstanceCache()

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

Remove the cached newtalk status for the given user.

Definition at line 172 of file TalkPageNotificationManager.php.

◆ dbCheckNewUserMessages()

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

private

Internal uncached check for new messages.

Parameters

UserIdentity $user

Returns: bool True if the user has new messages

Definition at line 191 of file TalkPageNotificationManager.php.

Referenced by MediaWiki\User\TalkPageNotificationManager\userHasNewMessages().

◆ dbDeleteNewUserMessages()

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

private

Clear the new messages flag for the given user.

Parameters

UserIdentity $user

Returns: bool True if successful, false otherwise

Definition at line 245 of file TalkPageNotificationManager.php.

◆ dbUpdateNewUserMessages()

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

private

Add or update the new messages flag.

Parameters

UserIdentity	$user
RevisionRecord \| null	$curRev	New, as yet unseen revision of the user talk page. Ignored if null.

Returns: bool True if successful, false otherwise

Definition at line 210 of file TalkPageNotificationManager.php.

◆ getCacheKey()

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

private

Gets a unique key for various caches.

Parameters

UserIdentity $user

Returns: string

Definition at line 280 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 140 of file TalkPageNotificationManager.php.

◆ getQueryFieldAndId()

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

private

Get the field name and id for the user_newtalk table query.

Parameters

UserIdentity $user

Returns: array ( string $field, string|int $id )

Definition at line 264 of file TalkPageNotificationManager.php.

References MediaWiki\User\UserIdentity\getId().

◆ isTalkDisabled()

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

private

Check whether the talk page is disabled for a user.

Parameters

UserIdentity $user

Returns: bool

Definition at line 182 of file TalkPageNotificationManager.php.

Referenced by MediaWiki\User\TalkPageNotificationManager\userHasNewMessages().

◆ removeUserHasNewMessages()

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

Remove the new messages status.

Parameters

UserIdentity $user

Definition at line 121 of file TalkPageNotificationManager.php.

Referenced by MediaWiki\User\WatchlistNotificationManager\clearTitleUserNotifications().

◆ setUserHasNewMessages()

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

Update the talk page messages status.

Parameters

UserIdentity	$user
RevisionRecord \| null	$curRev	New, 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 104 of file TalkPageNotificationManager.php.

Referenced by MediaWiki\User\WatchlistNotificationManager\clearTitleUserNotifications().