A special page that lists last changes made to the wiki, limited to user-defined list of titles. More...

Inheritance diagram for SpecialWatchlist:

[legend]

Collaboration diagram for SpecialWatchlist:

[legend]

Public Member Functions
	__construct (WatchedItemStoreInterface $watchedItemStore, WatchlistManager $watchlistManager, ILoadBalancer $loadBalancer, UserOptionsLookup $userOptionsLookup)

	doesWrites ()
	Indicates whether this special page may perform database writes.

	doHeader ( $opts, $numRows)
	Set the text to be displayed above the changes.

	execute ( $subpage)
	Main execution point.

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept.

	outputChangesList ( $rows, $opts)
	Build and output the actual changes list.

	outputFeedLinks ()

	setTopText (FormOptions $opts)
	Send the text to be displayed before the options.

Public Member Functions inherited from ChangesListSpecialPage
	__construct ( $name, $restriction)

	filterOnUserExperienceLevel ( $specialPageClassName, $context, $dbr, &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedExpLevels, $now=0)
	Filter on users' experience levels; this will not be called if nothing is selected.

	getDefaultDays ()
	Get the default value of the number of days to display when loading the result set.

	getDefaultLimit ()
	Get the default value of the number of changes to display when loading the result set.

	getDefaultOptions ()
	Get a FormOptions object containing the default options.

	getExtraOptions ( $opts)
	Get options to be displayed in a form.

	getFilterGroup ( $groupName)
	Gets a specified ChangesListFilterGroup by name.

	getOptions ()
	Get the current FormOptions for this request.

	getRows ()
	Get the database result for this special page instance.

	getStructuredFilterJsData ()
	Gets structured filter information needed by JS.

	isStructuredFilterUiEnabled ()
	Check whether the structured filter UI is enabled.

	makeLegend ()
	Return the legend displayed within the fieldset.

	parseParameters ( $par, FormOptions $opts)
	Process $par and put options found in $opts.

	registerFilterGroup (ChangesListFilterGroup $group)
	Register a structured changes list filter group.

	replaceOldOptions (FormOptions $opts)
	Replace old options with their structured UI equivalents.

	setBottomText (FormOptions $opts)
	Send the text to be displayed after the options.

	setup ( $parameters)
	Register all the filters, including legacy hook-driven ones.

	validateOptions (FormOptions $opts)
	Validate a FormOptions object generated by getDefaultOptions() with values already populated.

	webOutput ( $rows, $opts)
	Send output to the OutputPage object, only called if not used feeds.

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page.

	getName ()
	Get the name of this Special Page.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getShortDescription (string $path='')
	Similar to getDescription but takes into account sub pages and designed for display in tabs.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Static Public Member Functions

static checkStructuredFilterUiEnabled (UserIdentity $user)

Static method to check whether StructuredFilter UI is enabled for the given user.

Since: 1.31

Parameters

UserIdentity $user

Returns: bool

Static Public Member Functions inherited from ChangesListSpecialPage

static getRcFiltersConfigSummary (RL\Context $context)

Get essential data about getRcFiltersConfigVars() for change detection.

static getRcFiltersConfigVars (RL\Context $context)

Get config vars to export with the mediawiki.rcfilters.filters.ui module.

Static Public Member Functions inherited from SpecialPage

static getSafeTitleFor ( $name, $subpage=false)

Get a localised Title object for a page name with a possibly unvalidated subpage.

static getTitleFor ( $name, $subpage=false, $fragment='')

Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static getTitleValueFor ( $name, $subpage=false, $fragment='')

Get a localised TitleValue object for a specified special page name.

static newSearchPage (User $user)

Get the users preferred search page.

Protected Member Functions

countItems ()

Count the number of paired items on a user's watchlist.

doMainQuery ( $tables, $fields, $conds, $query_options, $join_conds, FormOptions $opts)

Process the query.

Parameters

array	$tables	Array of tables; see IDatabase::select $table
array	$fields	Array of fields; see IDatabase::select $vars
array	$conds	Array of conditions; see IDatabase::select $conds
array	$query_options	Array of query options; see IDatabase::select $options
array	$join_conds	Array of join conditions; see IDatabase::select $join_conds
FormOptions	$opts

Returns: bool|IResultWrapper Result or false

fetchOptionsFromRequest ( $opts)

Fetch values for a FormOptions object from the WebRequest associated with this instance.

getCollapsedPreferenceName ()

getDB ()

Return a IDatabase object for reading.

getDefaultDaysPreferenceName ()

getLimitPreferenceName ()

getSavedQueriesPreferenceName ()

isChangeEffectivelySeen (RecentChange $rc)

registerFilters ()

Register all filters and their groups (including those from hooks), plus handle conflicts and defaults.You might want to customize these in the same method, in subclasses. You can call getFilterGroup to access a group, and (on the group) getFilter to access a filter, then make necessary modfications to the filter or group (e.g. with setDefault).

showHideCheck ( $options, $message, $name, $value, $inStructuredUi)

transformFilterDefinition (array $filterDefinition)

Transforms filter definition to prepare it for constructor.See overrides of this method as well.

Parameters

array $filterDefinition Original filter definition

Returns: array Transformed definition

Protected Member Functions inherited from ChangesListSpecialPage

addModules ()

Add page-specific modules.

areFiltersInConflict ()

Check if filters are in conflict and guaranteed to return no results.

buildQuery (&$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts)

Sets appropriate tables, fields, conditions, etc.

considerActionsForDefaultSavedQuery ( $subpage)

Check whether or not the page should load defaults, and if so, whether a default saved query is relevant to be redirected to.

convertParamsForLink ( $params)

Convert parameters values from true/false to 1/0 so they are not omitted by wfArrayToCgi() T38524.

getFilterGroups ()

Gets the currently registered filters groups.

getGroupName ()

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

getLegacyShowHideFilters ()

getLinkDays ()

includeRcFiltersApp ()

Include the modules and configuration for the RCFilters app.

outputNoResults ()

Add the "no results" message to the output.

outputTimeout ()

Add the "timeout" message to the output.

registerFiltersFromDefinitions (array $definition)

Register filters from a definition object.

runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)

Protected Member Functions inherited from SpecialPage

addFeedLinks ( $params)

Adds RSS/atom links.

afterExecute ( $subPage)

Gets called after.

beforeExecute ( $subPage)

Gets called before.

buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)

Generate (prev x| next x) (20|50|100...) type links for paging.

checkLoginSecurityLevel ( $level=null)

Verifies that the user meets the security level, possibly reauthenticating them in the process.

displayRestrictionError ()

Output an error message telling the user what access level they have to have.

getAuthManager ()

getCacheTTL ()

getHookContainer ()

getHookRunner ()

getLanguageConverter ()

Shortcut to get language's converter.

getLoginSecurityLevel ()

Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

getRobotPolicy ()

Return the robot policy.

getSpecialPageFactory ()

outputHeader ( $summaryMessageKey='')

Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)

Perform a regular substring search for prefixSearchSubpages.

setAuthManager (AuthManager $authManager)

Set the injected AuthManager from the special page constructor.

setHeaders ()

Sets headers - this should be called from the execute() method of all derived classes!

setReauthPostData (array $data)

Record preserved POST data after a reauthentication.

useTransactionalTimeLimit ()

Call wfTransactionalTimeLimit() if this request was POSTed.

Additional Inherited Members
Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Protected Attributes inherited from ChangesListSpecialPage
ChangesListFilterGroup[]	$filterGroups = []
	Filter groups, and their contained filters This is an associative array (with group name as key) of ChangesListFilterGroup objects.

FormOptions	$rcOptions

string	$rcSubpage

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Detailed Description

A special page that lists last changes made to the wiki, limited to user-defined list of titles.

Definition at line 39 of file SpecialWatchlist.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialWatchlist::__construct	(	WatchedItemStoreInterface	$watchedItemStore,
		WatchlistManager	$watchlistManager,
		ILoadBalancer	$loadBalancer,
		UserOptionsLookup	$userOptionsLookup )

Parameters

WatchedItemStoreInterface	$watchedItemStore
WatchlistManager	$watchlistManager
ILoadBalancer	$loadBalancer
UserOptionsLookup	$userOptionsLookup

Definition at line 65 of file SpecialWatchlist.php.

Member Function Documentation

◆ checkStructuredFilterUiEnabled()

static SpecialWatchlist::checkStructuredFilterUiEnabled ( UserIdentity $user )

static

Static method to check whether StructuredFilter UI is enabled for the given user.

Since: 1.31

Parameters

UserIdentity $user

Returns: bool

Reimplemented from ChangesListSpecialPage.

Definition at line 143 of file SpecialWatchlist.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().

◆ countItems()

SpecialWatchlist::countItems ( )

protected

Count the number of paired items on a user's watchlist.

The assumption made here is that when a subject page is watched a talk page is also watched. Hence the number of individual items is halved.

Returns: int

Definition at line 920 of file SpecialWatchlist.php.

References SpecialPage\getUser().

Referenced by setTopText().

◆ doesWrites()

SpecialWatchlist::doesWrites ( )

Indicates whether this special page may perform database writes.

Stability: stable: to override

Returns: bool

Since: 1.27

Reimplemented from SpecialPage.

Definition at line 79 of file SpecialWatchlist.php.

◆ doHeader()

SpecialWatchlist::doHeader	(		$opts,
			$numRows )

Set the text to be displayed above the changes.

Parameters

FormOptions	$opts
int	$numRows	Number of rows in the result to show after this header

Reimplemented from ChangesListSpecialPage.

Definition at line 625 of file SpecialWatchlist.php.

References $lang, SpecialEditWatchlist\buildTools(), SpecialPage\getLanguage(), ChangesListSpecialPage\getLegacyShowHideFilters(), SpecialPage\getLinkRenderer(), SpecialPage\getName(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), ChangesListSpecialPage\isStructuredFilterUiEnabled(), ChangesListSpecialPage\makeLegend(), SpecialPage\msg(), ChangesListSpecialPage\setBottomText(), setTopText(), showHideCheck(), wfScript(), and wfTimestampNow().

◆ doMainQuery()

SpecialWatchlist::doMainQuery	(		$tables,
			$fields,
			$conds,
			$query_options,
			$join_conds,
		FormOptions	$opts )

protected

Process the query.

Parameters

array	$tables	Array of tables; see IDatabase::select $table
array	$fields	Array of fields; see IDatabase::select $vars
array	$conds	Array of conditions; see IDatabase::select $conds
array	$query_options	Array of query options; see IDatabase::select $options
array	$join_conds	Array of join conditions; see IDatabase::select $join_conds
FormOptions	$opts

Returns: bool|IResultWrapper Result or false

Reimplemented from ChangesListSpecialPage.

Definition at line 379 of file SpecialWatchlist.php.

References $dbr, ChangesListSpecialPage\areFiltersInConflict(), LogPage\DELETED_ACTION, LogPage\DELETED_RESTRICTED, SpecialPage\getAuthority(), SpecialPage\getConfig(), getDB(), SpecialPage\getUser(), LIST_OR, ChangeTags\modifyDisplayQuery(), RC_LOG, and ChangesListSpecialPage\runMainQueryHook().

◆ execute()

SpecialWatchlist::execute ( $subpage )

Main execution point.

Parameters

string | null $subpage

Reimplemented from ChangesListSpecialPage.

Definition at line 88 of file SpecialWatchlist.php.

References $title, SpecialPage\addHelpLink(), SpecialPage\checkPermissions(), SpecialEditWatchlist\EDIT_CLEAR, SpecialEditWatchlist\EDIT_RAW, SpecialPage\getConfig(), SpecialEditWatchlist\getMode(), ChangesListSpecialPage\getOptions(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getTitleFor(), SpecialPage\getUser(), ChangesListSpecialPage\isStructuredFilterUiEnabled(), and SpecialPage\requireNamedUser().

◆ fetchOptionsFromRequest()

SpecialWatchlist::fetchOptionsFromRequest ( $opts )

protected

Fetch values for a FormOptions object from the WebRequest associated with this instance.

Maps old pre-1.23 request parameters Watchlist used to use (different from Recentchanges' ones) to the current ones.

Parameters

FormOptions $opts

Returns: FormOptions

Reimplemented from ChangesListSpecialPage.

Definition at line 334 of file SpecialWatchlist.php.

References ChangesListSpecialPage\getLegacyShowHideFilters(), and SpecialPage\getRequest().

◆ getCollapsedPreferenceName()

SpecialWatchlist::getCollapsedPreferenceName ( )

protected

Returns: string

Reimplemented from ChangesListSpecialPage.

Definition at line 971 of file SpecialWatchlist.php.

◆ getDB()

SpecialWatchlist::getDB ( )

protected

Return a IDatabase object for reading.

Returns: IDatabase

Reimplemented from ChangesListSpecialPage.

Definition at line 484 of file SpecialWatchlist.php.

Referenced by doMainQuery(), and outputChangesList().

◆ getDefaultDaysPreferenceName()

SpecialWatchlist::getDefaultDaysPreferenceName ( )

protected

Returns: string

Reimplemented from ChangesListSpecialPage.

Definition at line 964 of file SpecialWatchlist.php.

◆ getLimitPreferenceName()

SpecialWatchlist::getLimitPreferenceName ( )

protected

Returns: string

Reimplemented from ChangesListSpecialPage.

Definition at line 950 of file SpecialWatchlist.php.

◆ getSavedQueriesPreferenceName()

SpecialWatchlist::getSavedQueriesPreferenceName ( )

protected

Returns: string

Reimplemented from ChangesListSpecialPage.

Definition at line 957 of file SpecialWatchlist.php.

◆ getSubpagesForPrefixSearch()

SpecialWatchlist::getSubpagesForPrefixSearch ( )

Return an array of subpages that this special page will accept.

See also: also SpecialEditWatchlist::getSubpagesForPrefixSearch

Returns: string[] subpages

Reimplemented from SpecialPage.

Definition at line 155 of file SpecialWatchlist.php.

◆ isChangeEffectivelySeen()

SpecialWatchlist::isChangeEffectivelySeen ( RecentChange $rc )

protected

Parameters

RecentChange $rc

Returns: bool User viewed the revision or a newer one

Definition at line 929 of file SpecialWatchlist.php.

References RecentChange\getAttribute().

Referenced by outputChangesList(), and registerFilters().

◆ outputChangesList()

SpecialWatchlist::outputChangesList	(		$rows,
			$opts )

Build and output the actual changes list.

Parameters

IResultWrapper	$rows	Database rows
FormOptions	$opts

Reimplemented from ChangesListSpecialPage.

Definition at line 507 of file SpecialWatchlist.php.

References $dbr, $s, SpecialPage\getConfig(), SpecialPage\getContext(), getDB(), WatchedItem\getExpiry(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), RecentChange\getTitle(), SpecialPage\getUser(), isChangeEffectivelySeen(), ChangesListSpecialPage\isStructuredFilterUiEnabled(), ChangesListSpecialPage\makeLegend(), SpecialPage\msg(), RC_CATEGORIZE, and RC_LOG.

◆ outputFeedLinks()

SpecialWatchlist::outputFeedLinks ( )

Reimplemented from ChangesListSpecialPage.

Definition at line 488 of file SpecialWatchlist.php.

References SpecialPage\addFeedLinks(), and SpecialPage\getUser().

◆ registerFilters()

SpecialWatchlist::registerFilters ( )

protected

Register all filters and their groups (including those from hooks), plus handle conflicts and defaults.You might want to customize these in the same method, in subclasses. You can call getFilterGroup to access a group, and (on the group) getFilter to access a filter, then make necessary modfications to the filter or group (e.g. with setDefault).

Reimplemented from ChangesListSpecialPage.

Definition at line 178 of file SpecialWatchlist.php.

References $dbr, ChangesListSpecialPage\getFilterGroup(), SpecialPage\getHookRunner(), SpecialPage\getUser(), isChangeEffectivelySeen(), ChangesListSpecialPage\isStructuredFilterUiEnabled(), LIST_AND, LIST_OR, ChangesListStringOptionsFilterGroup\NONE, RC_LOG, and ChangesListSpecialPage\registerFilterGroup().

◆ setTopText()

SpecialWatchlist::setTopText ( FormOptions $opts )

Send the text to be displayed before the options.

Should use $this->getOutput()->addWikiTextAsInterface() or similar methods to print the text.

Parameters

FormOptions $opts

Reimplemented from ChangesListSpecialPage.

Definition at line 840 of file SpecialWatchlist.php.

References countItems(), FormOptions\getChangedValues(), SpecialPage\getConfig(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), ChangesListSpecialPage\isStructuredFilterUiEnabled(), and SpecialPage\msg().

Referenced by doHeader().

◆ showHideCheck()

SpecialWatchlist::showHideCheck	(	$options,
		$message,
		$name,
		$value,
		$inStructuredUi )

protected

Definition at line 892 of file SpecialWatchlist.php.

References SpecialPage\msg().

Referenced by doHeader().

◆ transformFilterDefinition()

SpecialWatchlist::transformFilterDefinition ( array $filterDefinition )

protected

Transforms filter definition to prepare it for constructor.See overrides of this method as well.

Parameters

array $filterDefinition Original filter definition

Returns: array Transformed definition

Reimplemented from ChangesListSpecialPage.

Definition at line 166 of file SpecialWatchlist.php.

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

includes/specials/SpecialWatchlist.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkStructuredFilterUiEnabled()

◆ countItems()

◆ doesWrites()

◆ doHeader()

◆ doMainQuery()

◆ execute()

◆ fetchOptionsFromRequest()

◆ getCollapsedPreferenceName()

◆ getDB()

◆ getDefaultDaysPreferenceName()

◆ getLimitPreferenceName()

◆ getSavedQueriesPreferenceName()

◆ getSubpagesForPrefixSearch()

◆ isChangeEffectivelySeen()

◆ outputChangesList()

◆ outputFeedLinks()

◆ registerFilters()

◆ setTopText()

◆ showHideCheck()

◆ transformFilterDefinition()