MediaWiki\Watchlist Namespace Reference

Namespaces
namespace	Hook

Classes
class	ActivityUpdateJob
	Job for updating user activity like "last viewed" timestamps. More...
class	ClearUserWatchlistJob
	Job to clear a users watchlist in batches. More...
class	ClearWatchlistNotificationsJob
	Job for clearing all of the "last viewed" timestamps for a user's watchlist, or setting them all to the same value. More...
class	NoWriteWatchedItemStore
class	WatchedItem
	Representation of a pair of user and title for watchlist entries. More...
class	WatchedItemQueryService
	Class performing complex database queries related to WatchedItems. More...
interface	WatchedItemQueryServiceExtension
	Extension mechanism for WatchedItemQueryService. More...
class	WatchedItemStore
	Storage layer class for WatchedItems. More...
interface	WatchedItemStoreInterface
class	WatchlistExpiryJob
class	WatchlistLabel
class	WatchlistLabelStore
	Service class for storage of watchlist labels. More...
class	WatchlistManager
	WatchlistManager service. More...

Functions
	buildTools (?int $selectedMode=null)
	Build the HTML for links for navigation between watchlist viewing and editing modes.
	getAssociatedNavigationLinks ()
	getConfig ()
	getLinkRenderer ()
	getOutput ()
	getShortDescription (string $path='')
	getSkin ()
	getUser ()
	getWatchlistOwnerHtml ()
	Get the "For <user>" HTML to add as the special page subtitle.
	msg ( $key,... $params)
	outputSubtitle ()
	For legacy skins, render the watchlist navigation link in the subtitle.

Variables
trait	WatchlistSpecialPage
	Used by the three watchlist special pages (Watchlist, EditWatchlist, and WatchlistLabels) to handle their common navigation.

Detailed Description

Note

GPL-2.0-or-later

Function Documentation

buildTools()

MediaWiki\Watchlist\buildTools

(

?int

$selectedMode = null

)

Build the HTML for links for navigation between watchlist viewing and editing modes.

This is only used for skins that don't support the associated-pages menu.

Parameters

?int

$selectedMode

The mode of the current page, to be shown as active.

Returns

string

Definition at line 103 of file WatchlistSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and wfMessage().

Referenced by MediaWiki\Watchlist\outputSubtitle().

getAssociatedNavigationLinks()

MediaWiki\Watchlist\getAssociatedNavigationLinks

(

)

Definition at line 40 of file WatchlistSpecialPage.php.

References MediaWiki\MainConfigNames\EnableWatchlistLabels, and MediaWiki\Watchlist\getConfig().

getConfig()

MediaWiki\Watchlist\getConfig ( )

abstract

Referenced by MediaWiki\Watchlist\getAssociatedNavigationLinks().

getLinkRenderer()

MediaWiki\Watchlist\getLinkRenderer ( )

abstract

getOutput()

MediaWiki\Watchlist\getOutput ( )

abstract

Referenced by MediaWiki\Watchlist\outputSubtitle().

getShortDescription()

MediaWiki\Watchlist\getShortDescription

(

string

$path = ''

)

Definition at line 49 of file WatchlistSpecialPage.php.

References $path, and MediaWiki\Watchlist\msg().

getSkin()

MediaWiki\Watchlist\getSkin ( )

abstract

getUser()

MediaWiki\Watchlist\getUser ( )

abstract

getWatchlistOwnerHtml()

MediaWiki\Watchlist\getWatchlistOwnerHtml ( )

protected

Get the "For <user>" HTML to add as the special page subtitle.

Returns

string HTML span element.

Definition at line 71 of file WatchlistSpecialPage.php.

Referenced by MediaWiki\Watchlist\outputSubtitle().

msg()

MediaWiki\Watchlist\msg ( $key, $params )

abstract

Referenced by MediaWiki\Watchlist\getShortDescription().

outputSubtitle()

MediaWiki\Watchlist\outputSubtitle ( )

protected

For legacy skins, render the watchlist navigation link in the subtitle.

Definition at line 88 of file WatchlistSpecialPage.php.

References MediaWiki\Watchlist\buildTools(), MediaWiki\Watchlist\getOutput(), and MediaWiki\Watchlist\getWatchlistOwnerHtml().

Variable Documentation

WatchlistSpecialPage

trait MediaWiki::Watchlist\WatchlistSpecialPage

Initial value:

{
 
    
    protected int|false $currentMode

Used by the three watchlist special pages (Watchlist, EditWatchlist, and WatchlistLabels) to handle their common navigation.

Definition at line 16 of file WatchlistSpecialPage.php.