Special page which uses a ChangesList to show query results. More...

Inheritance diagram for ChangesListSpecialPage:

[legend]

Collaboration diagram for ChangesListSpecialPage:

[legend]

Public Member Functions
	__construct ( $name, $restriction)

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

	execute ( $subpage)

	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. More...

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

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

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

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

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

	getOptions ()
	Get the current FormOptions for this request. More...

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

	getStructuredFilterJsData ()
	Gets structured filter information needed by JS. More...

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

	makeLegend ()
	Return the legend displayed within the fieldset. More...

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

	outputFeedLinks ()
	Output feed links. More...

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

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

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

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

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

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

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

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

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. More...

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

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

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

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

	getConfig ()
	Shortcut to get main config object. More...

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

	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. More...

	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. More...

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

	getLanguage ()
	Shortcut to get user's language. More...

	getLinkRenderer ()

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

	getName ()
	Get the name of this Special Page. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	run ( $subPage)
	Entry point. More...

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

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

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

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

Static Public Member Functions
static	checkStructuredFilterUiEnabled ( $user)
	Static method to check whether StructuredFilter UI is enabled for the given user. More...

static	getRcFiltersConfigSummary (ResourceLoaderContext $context)
	Get essential data about getRcFiltersConfigVars() for change detection. More...

static	getRcFiltersConfigVars (ResourceLoaderContext $context)
	Get config vars to export with the mediawiki.rcfilters.filters.ui module. More...

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. More...

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. More...

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name. More...

Protected Member Functions
	addModules ()
	Add page-specific modules. More...

	areFiltersInConflict ()
	Check if filters are in conflict and guaranteed to return no results. More...

	buildQuery (&$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts)
	Sets appropriate tables, fields, conditions, etc. More...

	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. More...

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

	doMainQuery ( $tables, $fields, $conds, $query_options, $join_conds, FormOptions $opts)
	Process the query. More...

	fetchOptionsFromRequest ( $opts)
	Fetch values for a FormOptions object from the WebRequest associated with this instance. More...

	getDB ()
	Return a IDatabase object for reading. More...

	getFilterGroups ()
	Gets the currently registered filters groups. More...

	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'. More...

	getLegacyShowHideFilters ()

	getLinkDays ()

	includeRcFiltersApp ()
	Include the modules and configuration for the RCFilters app. More...

	outputNoResults ()
	Add the "no results" message to the output. More...

	outputTimeout ()
	Add the "timeout" message to the output. More...

	registerFilters ()
	Register all filters and their groups (including those from hooks), plus handle conflicts and defaults. More...

	registerFiltersFromDefinitions (array $definition)
	Register filters from a definition object. More...

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

	transformFilterDefinition (array $filterDefinition)
	Transforms filter definition to prepare it for constructor. More...

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links. More...

	afterExecute ( $subPage)
	Gets called after. More...

	beforeExecute ( $subPage)
	Gets called before. More...

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging. More...

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process. More...

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have. More...

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter. More...

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

	getRobotPolicy ()
	Return the robot policy. More...

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches. More...

	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. More...

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages. More...

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

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication. More...

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed. More...

Static Protected Member Functions
static	getChangeTagList (ResourceLoaderContext $context)
	Get information about change tags to export to JS via getRcFiltersConfigVars(). More...

static	getChangeTagListSummary (ResourceLoaderContext $context)
	Get information about change tags, without parsing messages, for getRcFiltersConfigSummary(). More...

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). More...

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

FormOptions	$rcOptions

string	$rcSubpage

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Static Protected Attributes
static string	$collapsedPreferenceName
	Preference name for collapsing the active filter display. More...

static string	$daysPreferenceName
	Preference name for 'days'. More...

static string	$limitPreferenceName
	Preference name for 'limit'. More...

static string	$savedQueriesPreferenceName
	Preference name for saved queries. More...

Private Member Functions
	expandSymbolicNamespaceFilters (array $namespaces)

	fixBackwardsCompatibilityOptions (FormOptions $opts)
	Fix a special case (hideanons=1 and hideliu=1) in a special way, for backwards compatibility. More...

	fixContradictoryOptions (FormOptions $opts)
	Fix invalid options by resetting pairs that should never appear together. More...

	webOutputHeader ( $rowCount, $opts)
	Send header output to the OutputPage object, only called if not using feeds. More...

Private Attributes
array	$filterGroupDefinitions
	Definition information for the filters and their groups. More...

	$hideCategorizationFilterDefinition

	$legacyReviewStatusFilterGroupDefinition

	$reviewStatusFilterGroupDefinition

const	TAG_DESC_CHARACTER_LIMIT = 120
	Maximum length of a tag description in UTF-8 characters. More...

Detailed Description

Special page which uses a ChangesList to show query results.

Todo:: Way too many public functions, most of them should be protected

Definition at line 38 of file ChangesListSpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

ChangesListSpecialPage::__construct	(	$name,
		$restriction
	)

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 111 of file ChangesListSpecialPage.php.

References $dbr, $s, SpecialPage\getHookRunner(), LIST_OR, ActorMigration\newMigration(), ChangesListStringOptionsFilterGroup\NONE, RecentChange\PRC_AUTOPATROLLED, RecentChange\PRC_PATROLLED, RecentChange\PRC_UNPATROLLED, RC_CATEGORIZE, RC_EDIT, RC_LOG, RC_NEW, RecentChange\SRC_CATEGORIZE, RecentChange\SRC_EDIT, RecentChange\SRC_LOG, and RecentChange\SRC_NEW.

Member Function Documentation

◆ addModules()

ChangesListSpecialPage::addModules ( )

protected

Add page-specific modules.

Reimplemented in SpecialRecentChanges.

Definition at line 1810 of file ChangesListSpecialPage.php.

References SpecialPage\getOutput(), SpecialPage\including(), and isStructuredFilterUiEnabled().

Referenced by execute().

◆ areFiltersInConflict()

ChangesListSpecialPage::areFiltersInConflict ( )

protected

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

Returns: bool

Definition at line 583 of file ChangesListSpecialPage.php.

References ChangesListFilter\getConflictingFilters(), getFilterGroups(), getOptions(), and wfLogWarning().

Referenced by SpecialRecentChanges\doMainQuery(), and SpecialWatchlist\doMainQuery().

◆ buildQuery()

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

protected

Sets appropriate tables, fields, conditions, etc.

depending on which filters the user requested.

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

Definition at line 1517 of file ChangesListSpecialPage.php.

References $dbr, expandSymbolicNamespaceFilters(), getDB(), isStructuredFilterUiEnabled(), FormOptions\reset(), and wfTimestamp().

Referenced by getRows().

◆ checkStructuredFilterUiEnabled()

static ChangesListSpecialPage::checkStructuredFilterUiEnabled ( $user )

static

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

Since: 1.31

Parameters

User $user

Returns: bool

Reimplemented in SpecialWatchlist.

Definition at line 1971 of file ChangesListSpecialPage.php.

References wfDeprecated().

◆ considerActionsForDefaultSavedQuery()

ChangesListSpecialPage::considerActionsForDefaultSavedQuery ( $subpage )

protected

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

If it is relevant, redirect properly with all necessary query parameters.

Parameters

string $subpage

Definition at line 705 of file ChangesListSpecialPage.php.

References FormatJson\decode(), getOptions(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\including(), and isStructuredFilterUiEnabled().

Referenced by execute().

◆ convertParamsForLink()

ChangesListSpecialPage::convertParamsForLink ( $params )

protected

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

Parameters

array $params

Returns: array

Definition at line 1496 of file ChangesListSpecialPage.php.

Referenced by SpecialRecentChanges\makeOptionsLink(), and validateOptions().

◆ doHeader()

ChangesListSpecialPage::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 in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1684 of file ChangesListSpecialPage.php.

References setBottomText(), and setTopText().

Referenced by webOutputHeader().

◆ doMainQuery()

ChangesListSpecialPage::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 in SpecialRecentChangesLinked, SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1587 of file ChangesListSpecialPage.php.

References $dbr, getDB(), RecentChange\getQueryInfo(), ChangeTags\modifyDisplayQuery(), and runMainQueryHook().

Referenced by getRows().

◆ execute()

ChangesListSpecialPage::execute ( $subpage )

Parameters

string | null $subpage

Reimplemented from SpecialPage.

Reimplemented in SpecialRecentChanges, and SpecialWatchlist.

Definition at line 623 of file ChangesListSpecialPage.php.

References $title, LinkBatch\add(), addModules(), DeferredUpdates\addUpdate(), considerActionsForDefaultSavedQuery(), SpecialPage\getConfig(), getDB(), getOptions(), SpecialPage\getOutput(), SpecialPage\getRequest(), getRows(), SpecialPage\getUser(), includeRcFiltersApp(), MWExceptionHandler\logException(), LogFormatter\newFromRow(), NS_USER, NS_USER_TALK, SpecialPage\outputHeader(), outputTimeout(), SpecialPage\setHeaders(), RecentChange\SRC_LOG, webOutput(), and webOutputHeader().

◆ expandSymbolicNamespaceFilters()

ChangesListSpecialPage::expandSymbolicNamespaceFilters ( array $namespaces )

private

Definition at line 2002 of file ChangesListSpecialPage.php.

Referenced by buildQuery().

◆ fetchOptionsFromRequest()

ChangesListSpecialPage::fetchOptionsFromRequest ( $opts )

protected

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

Intended for subclassing, e.g. to add a backwards-compatibility layer.

Parameters

FormOptions $opts

Returns: FormOptions

Reimplemented in SpecialWatchlist.

Definition at line 1315 of file ChangesListSpecialPage.php.

References SpecialPage\getRequest().

Referenced by setup().

◆ filterOnUserExperienceLevel()

ChangesListSpecialPage::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.

Parameters

string	$specialPageClassName	Class name of current special page
IContextSource	$context	Context, for e.g. user
IDatabase	$dbr	Database, for addQuotes, makeList, and similar
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
array	$selectedExpLevels	The allowed active values, sorted
int	$now	Number of seconds since the UNIX epoch, or 0 if not given (optional)

Definition at line 1846 of file ChangesListSpecialPage.php.

References $dbr, $wgExperiencedUserEdits, $wgExperiencedUserMemberSince, $wgLearnerEdits, $wgLearnerMemberSince, LIST_AND, LIST_OR, and ActorMigration\newMigration().

◆ fixBackwardsCompatibilityOptions()

ChangesListSpecialPage::fixBackwardsCompatibilityOptions ( FormOptions $opts )

private

Fix a special case (hideanons=1 and hideliu=1) in a special way, for backwards compatibility.

This is deprecated and may be removed.

Parameters

FormOptions $opts

Returns: bool True if this change was mode

Definition at line 1427 of file ChangesListSpecialPage.php.

References FormOptions\reset().

Referenced by fixContradictoryOptions().

◆ fixContradictoryOptions()

ChangesListSpecialPage::fixContradictoryOptions ( FormOptions $opts )

private

Fix invalid options by resetting pairs that should never appear together.

Parameters

FormOptions $opts

Returns: bool True if any option was reset

Definition at line 1385 of file ChangesListSpecialPage.php.

References fixBackwardsCompatibilityOptions().

Referenced by validateOptions().

◆ getChangeTagList()

static ChangesListSpecialPage::getChangeTagList ( ResourceLoaderContext $context )

staticprotected

Get information about change tags to export to JS via getRcFiltersConfigVars().

This manipulates the label and description of each tag, which are parsed, stripped and (in the case of description) truncated versions of these messages. Message parsing is expensive, so to detect whether the tag list has changed, use getChangeTagListSummary() instead.

The result of this function is cached in WANCache for 24 hours.

Parameters

ResourceLoaderContext $context

Returns: array[] Same as getChangeTagListSummary(), with messages parsed, stripped and truncated

Definition at line 965 of file ChangesListSpecialPage.php.

References getChangeTagListSummary(), ResourceLoaderContext\getLanguage(), and Sanitizer\stripAllTags().

Referenced by getRcFiltersConfigVars().

◆ getChangeTagListSummary()

static ChangesListSpecialPage::getChangeTagListSummary ( ResourceLoaderContext $context )

staticprotected

Get information about change tags, without parsing messages, for getRcFiltersConfigSummary().

Message contents are the raw values (->plain()), because parsing messages is expensive. Even though we're not parsing messages, building a data structure with the contents of hundreds of i18n messages is still not cheap (see T223260#5370610), so the result of this function is cached in WANCache for 24 hours.

Returns an array of associative arrays with information about each tag:

name: Tag name (string)
labelMsg: Short description message (Message object)
label: Short description message (raw message contents)
descriptionMsg: Long description message (Message object)
description: Long description message (raw message contents)
cssClass: CSS class to use for RC entries with this tag
hits: Number of RC entries that have this tag

Parameters

ResourceLoaderContext $context

Returns: array[] Information about each tag

Definition at line 907 of file ChangesListSpecialPage.php.

References $cache, Sanitizer\escapeClass(), ResourceLoaderContext\getLanguage(), ChangeTags\listExplicitlyDefinedTags(), ChangeTags\listSoftwareActivatedTags(), ChangeTags\tagLongDescriptionMessage(), ChangeTags\tagShortDescriptionMessage(), and ChangeTags\tagUsageStatistics().

Referenced by getChangeTagList(), and getRcFiltersConfigSummary().

◆ getDB()

ChangesListSpecialPage::getDB ( )

protected

Return a IDatabase object for reading.

Returns: IDatabase

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1634 of file ChangesListSpecialPage.php.

References DB_REPLICA, and wfGetDB().

Referenced by buildQuery(), doMainQuery(), and execute().

◆ getDefaultDays()

ChangesListSpecialPage::getDefaultDays ( )

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

Supports fractional values, and should be cast to a float.

Since: 1.30

Returns: float

Definition at line 1998 of file ChangesListSpecialPage.php.

References SpecialPage\getUser().

Referenced by getDefaultOptions(), and includeRcFiltersApp().

◆ getDefaultLimit()

ChangesListSpecialPage::getDefaultLimit ( )

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

Since: 1.30

Returns: int

Reimplemented in SpecialRecentChanges.

Definition at line 1986 of file ChangesListSpecialPage.php.

References SpecialPage\getUser().

Referenced by getDefaultOptions(), and includeRcFiltersApp().

◆ getDefaultOptions()

ChangesListSpecialPage::getDefaultOptions ( )

Get a FormOptions object containing the default options.

By default, returns some basic options. The filters listed explicitly here are overriden in this method, in subclasses, but most filters (e.g. hideminor, userExpLevel filters, and more) are structured. Structured filters are overriden in registerFilters. not here.

Returns: FormOptions

Reimplemented in SpecialRecentChangesLinked.

Definition at line 1212 of file ChangesListSpecialPage.php.

References FormOptions\FLOAT, getDefaultDays(), getDefaultLimit(), SpecialPage\getRequest(), FormOptions\INT, isStructuredFilterUiEnabled(), and FormOptions\STRING.

Referenced by setup().

◆ getExtraOptions()

ChangesListSpecialPage::getExtraOptions ( $opts )

Get options to be displayed in a form.

Todo:: This should handle options returned by getDefaultOptions().

Todo:: Not called by anything in this class (but is in subclasses), should be called by something… doHeader() maybe?

Parameters

FormOptions $opts

Returns: array

Reimplemented in SpecialRecentChanges, and SpecialRecentChangesLinked.

Definition at line 1723 of file ChangesListSpecialPage.php.

◆ getFilterGroup()

ChangesListSpecialPage::getFilterGroup ( $groupName )

Gets a specified ChangesListFilterGroup by name.

Parameters

string $groupName Name of group

Returns: ChangesListFilterGroup|null Group, or null if not registered

Definition at line 1264 of file ChangesListSpecialPage.php.

Referenced by SpecialWatchlist\registerFilters(), SpecialRecentChanges\registerFilters(), registerFilters(), and replaceOldOptions().

◆ getFilterGroups()

ChangesListSpecialPage::getFilterGroups ( )

protected

Gets the currently registered filters groups.

Returns: array Associative array of ChangesListFilterGroup objects, with group name as key

Definition at line 1253 of file ChangesListSpecialPage.php.

References $filterGroups.

Referenced by areFiltersInConflict().

◆ getGroupName()

ChangesListSpecialPage::getGroupName ( )

protected

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

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 1826 of file ChangesListSpecialPage.php.

◆ getLegacyShowHideFilters()

ChangesListSpecialPage::getLegacyShowHideFilters ( )

protected

Returns: array The legacy show/hide toggle filters

Definition at line 1164 of file ChangesListSpecialPage.php.

Referenced by SpecialWatchlist\doHeader(), SpecialWatchlist\fetchOptionsFromRequest(), and SpecialRecentChanges\optionsPanel().

◆ getLinkDays()

ChangesListSpecialPage::getLinkDays ( )

protected

See also: $wgRCLinkDays in DefaultSettings.php.; $wgRCFilterByAge in DefaultSettings.php.

Returns: int[]

Definition at line 775 of file ChangesListSpecialPage.php.

References SpecialPage\getConfig().

Referenced by includeRcFiltersApp(), and SpecialRecentChanges\optionsPanel().

◆ getOptions()

ChangesListSpecialPage::getOptions ( )

Get the current FormOptions for this request.

Returns: FormOptions

Definition at line 1033 of file ChangesListSpecialPage.php.

References $rcOptions, and setup().

Referenced by areFiltersInConflict(), considerActionsForDefaultSavedQuery(), SpecialWatchlist\execute(), execute(), SpecialRecentChanges\getFeedQuery(), getRows(), and SpecialRecentChangesLinked\getTargetTitle().

◆ getRcFiltersConfigSummary()

static ChangesListSpecialPage::getRcFiltersConfigSummary ( ResourceLoaderContext $context )

static

Get essential data about getRcFiltersConfigVars() for change detection.

Definition at line 863 of file ChangesListSpecialPage.php.

References getChangeTagListSummary(), and SpecialPage\getTitleFor().

◆ getRcFiltersConfigVars()

static ChangesListSpecialPage::getRcFiltersConfigVars ( ResourceLoaderContext $context )

static

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

Definition at line 879 of file ChangesListSpecialPage.php.

References getChangeTagList(), and SpecialPage\getTitleFor().

◆ getRows()

ChangesListSpecialPage::getRows ( )

Get the database result for this special page instance.

Used by ApiFeedRecentChanges.

Returns: bool|IResultWrapper Result or false

Definition at line 1015 of file ChangesListSpecialPage.php.

References buildQuery(), doMainQuery(), and getOptions().

Referenced by execute().

◆ getStructuredFilterJsData()

ChangesListSpecialPage::getStructuredFilterJsData ( )

Gets structured filter information needed by JS.

Returns

array Associative array

array $return['groups'] Group data
array $return['messageKeys'] Array of message keys

Definition at line 1281 of file ChangesListSpecialPage.php.

Referenced by includeRcFiltersApp().

◆ includeRcFiltersApp()

ChangesListSpecialPage::includeRcFiltersApp ( )

protected

Include the modules and configuration for the RCFilters app.

Conditional on the user having the feature enabled.

If it is disabled, add a <body> class marking that

Definition at line 803 of file ChangesListSpecialPage.php.

References SpecialPage\getConfig(), getDefaultDays(), getDefaultLimit(), getLinkDays(), SpecialPage\getOutput(), getStructuredFilterJsData(), SpecialPage\getUser(), SpecialPage\including(), isStructuredFilterUiEnabled(), and SpecialPage\msg().

Referenced by execute().

◆ isStructuredFilterUiEnabled()

ChangesListSpecialPage::isStructuredFilterUiEnabled ( )

Check whether the structured filter UI is enabled.

Returns: bool

Definition at line 1956 of file ChangesListSpecialPage.php.

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

Referenced by addModules(), buildQuery(), considerActionsForDefaultSavedQuery(), SpecialRecentChanges\doHeader(), SpecialWatchlist\doHeader(), SpecialWatchlist\execute(), SpecialRecentChanges\getDefaultLimit(), getDefaultOptions(), includeRcFiltersApp(), makeLegend(), SpecialRecentChanges\outputChangesList(), SpecialWatchlist\outputChangesList(), SpecialWatchlist\registerFilters(), replaceOldOptions(), SpecialRecentChanges\setTopText(), and SpecialWatchlist\setTopText().

◆ makeLegend()

ChangesListSpecialPage::makeLegend ( )

Return the legend displayed within the fieldset.

Returns: string

Definition at line 1732 of file ChangesListSpecialPage.php.

References Html\closeElement(), Html\element(), Sanitizer\escapeClass(), SpecialPage\getContext(), SpecialPage\getName(), SpecialPage\getRequest(), isStructuredFilterUiEnabled(), Html\openElement(), and Html\rawElement().

Referenced by SpecialRecentChanges\doHeader(), SpecialWatchlist\doHeader(), SpecialRecentChanges\outputChangesList(), and SpecialWatchlist\outputChangesList().

◆ outputChangesList()

ChangesListSpecialPage::outputChangesList	(	$rows,
		$opts
	)

abstract

Build and output the actual changes list.

Parameters

IResultWrapper	$rows	Database rows
FormOptions	$opts

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Referenced by webOutput().

◆ outputFeedLinks()

ChangesListSpecialPage::outputFeedLinks ( )

Output feed links.

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1666 of file ChangesListSpecialPage.php.

Referenced by webOutputHeader().

◆ outputNoResults()

ChangesListSpecialPage::outputNoResults ( )

protected

Add the "no results" message to the output.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 991 of file ChangesListSpecialPage.php.

References SpecialPage\getOutput(), and SpecialPage\msg().

Referenced by SpecialRecentChanges\outputChangesList().

◆ outputTimeout()

ChangesListSpecialPage::outputTimeout ( )

protected

Add the "timeout" message to the output.

Definition at line 1002 of file ChangesListSpecialPage.php.

References SpecialPage\getOutput(), and SpecialPage\msg().

Referenced by execute().

◆ parseParameters()

ChangesListSpecialPage::parseParameters	(		$par,
		FormOptions	$opts
	)

Process $par and put options found in $opts.

Used when including the page.

Parameters

string	$par
FormOptions	$opts

Reimplemented in SpecialRecentChanges, and SpecialRecentChangesLinked.

Definition at line 1327 of file ChangesListSpecialPage.php.

Referenced by setup().

◆ registerFilterGroup()

ChangesListSpecialPage::registerFilterGroup ( ChangesListFilterGroup $group )

Register a structured changes list filter group.

Parameters

ChangesListFilterGroup $group

Definition at line 1242 of file ChangesListSpecialPage.php.

References ChangesListFilterGroup\getName().

Referenced by SpecialWatchlist\registerFilters(), and registerFiltersFromDefinitions().

◆ registerFilters()

ChangesListSpecialPage::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 in SpecialRecentChanges, and SpecialWatchlist.

Definition at line 1050 of file ChangesListSpecialPage.php.

References SpecialPage\getConfig(), getFilterGroup(), SpecialPage\getHookRunner(), SpecialPage\getUser(), SpecialPage\including(), registerFiltersFromDefinitions(), and transformFilterDefinition().

Referenced by setup().

◆ registerFiltersFromDefinitions()

ChangesListSpecialPage::registerFiltersFromDefinitions ( array $definition )

protected

Register filters from a definition object.

Array specifying groups and their filters; see Filter and ChangesListFilterGroup constructors.

There is light processing to simplify core maintenance.

Parameters

array $definition -param array<int,array{class:string,filters:array}> $definition

Definition at line 1138 of file ChangesListSpecialPage.php.

References registerFilterGroup(), and transformFilterDefinition().

Referenced by SpecialRecentChanges\registerFilters(), and registerFilters().

◆ replaceOldOptions()

ChangesListSpecialPage::replaceOldOptions ( FormOptions $opts )

Replace old options with their structured UI equivalents.

Parameters

FormOptions $opts

Returns: bool True if the change was made

Definition at line 1447 of file ChangesListSpecialPage.php.

References getFilterGroup(), isStructuredFilterUiEnabled(), FormOptions\reset(), and ChangesListStringOptionsFilterGroup\SEPARATOR.

Referenced by validateOptions().

◆ runMainQueryHook()

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

protected

Definition at line 1622 of file ChangesListSpecialPage.php.

References SpecialPage\getHookRunner(), and SpecialPage\getName().

Referenced by SpecialRecentChangesLinked\doMainQuery(), SpecialRecentChanges\doMainQuery(), SpecialWatchlist\doMainQuery(), and doMainQuery().

◆ setBottomText()

ChangesListSpecialPage::setBottomText ( FormOptions $opts )

Send the text to be displayed after the options.

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

Parameters

FormOptions $opts

Definition at line 1710 of file ChangesListSpecialPage.php.

Referenced by SpecialRecentChanges\doHeader(), SpecialWatchlist\doHeader(), and doHeader().

◆ setTopText()

ChangesListSpecialPage::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 in SpecialWatchlist, SpecialRecentChanges, and SpecialRecentChangesLinked.

Definition at line 1699 of file ChangesListSpecialPage.php.

Referenced by doHeader().

◆ setup()

ChangesListSpecialPage::setup ( $parameters )

Register all the filters, including legacy hook-driven ones.

Then create a FormOptions object with options as specified by the user

Parameters

string $parameters

Returns: FormOptions

Definition at line 1186 of file ChangesListSpecialPage.php.

References fetchOptionsFromRequest(), getDefaultOptions(), parseParameters(), registerFilters(), and validateOptions().

Referenced by getOptions().

◆ transformFilterDefinition()

ChangesListSpecialPage::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 in SpecialRecentChanges, and SpecialWatchlist.

Definition at line 1124 of file ChangesListSpecialPage.php.

Referenced by registerFilters(), and registerFiltersFromDefinitions().

◆ validateOptions()

ChangesListSpecialPage::validateOptions ( FormOptions $opts )

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

Parameters

FormOptions $opts

Definition at line 1366 of file ChangesListSpecialPage.php.

References convertParamsForLink(), fixContradictoryOptions(), FormOptions\getChangedValues(), SpecialPage\getConfig(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), replaceOldOptions(), FormOptions\validateBounds(), FormOptions\validateIntBounds(), and wfArrayToCgi().

Referenced by setup().

◆ webOutput()

ChangesListSpecialPage::webOutput	(	$rows,
		$opts
	)

Send output to the OutputPage object, only called if not used feeds.

Parameters

IResultWrapper	$rows	Database rows
FormOptions	$opts

Definition at line 1657 of file ChangesListSpecialPage.php.

References outputChangesList(), and webOutputHeader().

Referenced by execute().

◆ webOutputHeader()

ChangesListSpecialPage::webOutputHeader	(	$rowCount,
		$opts
	)

private

Send header output to the OutputPage object, only called if not using feeds.

Parameters

int	$rowCount	Number of database rows
FormOptions	$opts

Definition at line 1644 of file ChangesListSpecialPage.php.

References doHeader(), SpecialPage\including(), and outputFeedLinks().

Referenced by execute(), and webOutput().

Member Data Documentation

◆ $collapsedPreferenceName

string ChangesListSpecialPage::$collapsedPreferenceName

staticprotected

Preference name for collapsing the active filter display.

Subclasses should override this.

Definition at line 67 of file ChangesListSpecialPage.php.

◆ $daysPreferenceName

string ChangesListSpecialPage::$daysPreferenceName

staticprotected

Preference name for 'days'.

Subclasses should override this.

Definition at line 55 of file ChangesListSpecialPage.php.

◆ $filterGroupDefinitions

array ChangesListSpecialPage::$filterGroupDefinitions

private

Definition information for the filters and their groups.

The value is $groupDefinition, a parameter to the ChangesListFilterGroup constructor. However, priority is dynamically added for the core groups, to ease maintenance.

Groups are displayed to the user in the structured UI. However, if necessary, all of the filters in a group can be configured to only display on the unstuctured UI, in which case you don't need a group title.

Definition at line 91 of file ChangesListSpecialPage.php.

◆ $filterGroups

ChangesListFilterGroup [] ChangesListSpecialPage::$filterGroups = []

protected

Filter groups, and their contained filters This is an associative array (with group name as key) of ChangesListFilterGroup objects.

Definition at line 109 of file ChangesListSpecialPage.php.

Referenced by getFilterGroups().

◆ $hideCategorizationFilterDefinition

ChangesListSpecialPage::$hideCategorizationFilterDefinition

private

Definition at line 101 of file ChangesListSpecialPage.php.

◆ $legacyReviewStatusFilterGroupDefinition

ChangesListSpecialPage::$legacyReviewStatusFilterGroupDefinition

private

Definition at line 95 of file ChangesListSpecialPage.php.

◆ $limitPreferenceName

string ChangesListSpecialPage::$limitPreferenceName

staticprotected

Preference name for 'limit'.

Subclasses should override this.

Definition at line 61 of file ChangesListSpecialPage.php.

◆ $rcOptions

FormOptions ChangesListSpecialPage::$rcOptions

protected

Definition at line 73 of file ChangesListSpecialPage.php.

Referenced by getOptions().

◆ $rcSubpage

string ChangesListSpecialPage::$rcSubpage

protected

Definition at line 70 of file ChangesListSpecialPage.php.

◆ $reviewStatusFilterGroupDefinition

ChangesListSpecialPage::$reviewStatusFilterGroupDefinition

private

Definition at line 98 of file ChangesListSpecialPage.php.

◆ $savedQueriesPreferenceName

string ChangesListSpecialPage::$savedQueriesPreferenceName

staticprotected

Preference name for saved queries.

Subclasses that use saved queries should override this.

Definition at line 49 of file ChangesListSpecialPage.php.

◆ TAG_DESC_CHARACTER_LIMIT

const ChangesListSpecialPage::TAG_DESC_CHARACTER_LIMIT = 120

private

Maximum length of a tag description in UTF-8 characters.

Longer descriptions will be truncated.

Definition at line 43 of file ChangesListSpecialPage.php.

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

includes/specialpage/ChangesListSpecialPage.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addModules()

◆ areFiltersInConflict()

◆ buildQuery()

◆ checkStructuredFilterUiEnabled()

◆ considerActionsForDefaultSavedQuery()

◆ convertParamsForLink()

◆ doHeader()

◆ doMainQuery()

◆ execute()

◆ expandSymbolicNamespaceFilters()

◆ fetchOptionsFromRequest()

◆ filterOnUserExperienceLevel()

◆ fixBackwardsCompatibilityOptions()

◆ fixContradictoryOptions()

◆ getChangeTagList()

◆ getChangeTagListSummary()

◆ getDB()

◆ getDefaultDays()

◆ getDefaultLimit()

◆ getDefaultOptions()

◆ getExtraOptions()

◆ getFilterGroup()

◆ getFilterGroups()

◆ getGroupName()

◆ getLegacyShowHideFilters()

◆ getLinkDays()

◆ getOptions()

◆ getRcFiltersConfigSummary()

◆ getRcFiltersConfigVars()

◆ getRows()

◆ getStructuredFilterJsData()

◆ includeRcFiltersApp()

◆ isStructuredFilterUiEnabled()

◆ makeLegend()

◆ outputChangesList()

◆ outputFeedLinks()

◆ outputNoResults()

◆ outputTimeout()

◆ parseParameters()

◆ registerFilterGroup()

◆ registerFilters()

◆ registerFiltersFromDefinitions()

◆ replaceOldOptions()

◆ runMainQueryHook()

◆ setBottomText()

◆ setTopText()

◆ setup()

◆ transformFilterDefinition()

◆ validateOptions()

◆ webOutput()

◆ webOutputHeader()

Member Data Documentation

◆ $collapsedPreferenceName

◆ $daysPreferenceName

◆ $filterGroupDefinitions

◆ $filterGroups

◆ $hideCategorizationFilterDefinition

◆ $legacyReviewStatusFilterGroupDefinition

◆ $limitPreferenceName

◆ $rcOptions

◆ $rcSubpage

◆ $reviewStatusFilterGroupDefinition

◆ $savedQueriesPreferenceName

◆ TAG_DESC_CHARACTER_LIMIT