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

Inherits MediaWiki\SpecialPage\SpecialPage.

Inherited by MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Collaboration diagram for MediaWiki\SpecialPage\ChangesListSpecialPage:

[legend]

Public Member Functions
	__construct ( $name, $restriction, UserIdentityUtils $userIdentityUtils, TempUserConfig $tempUserConfig)

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

	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.

	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.

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

	outputFeedLinks ()

	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.

	setTempUserConfig (TempUserConfig $tempUserConfig)
	Set the temp user config.

	setTopText (FormOptions $opts)
	Send the text to be displayed before 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 MediaWiki\SpecialPage\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.

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

	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 canonical, unlocalized name of this special page without namespace.

	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.

	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)

	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.

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 MediaWiki\SpecialPage\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
	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.

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

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

	getCollapsedPreferenceName ()
	Preference name for collapsing the active filter display.

	getDB ()
	Which database to use for read queries.

	getDefaultDaysPreferenceName ()
	Preference name for 'days'.

	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 ()

	getLimitPreferenceName ()
	Getting the preference name for 'limit'.

	getLinkDays ()

	getSavedQueriesPreferenceName ()
	Preference name for saved queries.

	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.

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

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

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

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

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

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

	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 ()

	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 ()

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

	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.

Protected Attributes
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

TempUserConfig	$tempUserConfig

UserIdentityUtils	$userIdentityUtils

Protected Attributes inherited from MediaWiki\SpecialPage\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 as the message key for the default.

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

Additional Inherited Members
Static Protected Member Functions inherited from MediaWiki\SpecialPage\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).

Detailed Description

Special page which uses a ChangesList to show query results.

Todo: Most of the functions here should be protected instead of public.

Definition at line 56 of file ChangesListSpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\SpecialPage\ChangesListSpecialPage::__construct	(		$name,
			$restriction,
		UserIdentityUtils	$userIdentityUtils,
		TempUserConfig	$tempUserConfig )

Parameters

string	$name
string	$restriction
UserIdentityUtils	$userIdentityUtils
TempUserConfig	$tempUserConfig

Definition at line 111 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\$tempUserConfig, MediaWiki\SpecialPage\ChangesListSpecialPage\$userIdentityUtils, MediaWiki\SpecialPage\SpecialPage\getHookRunner(), MediaWiki\MediaWikiServices\getInstance(), LIST_OR, ChangesListStringOptionsFilterGroup\NONE, RC_CATEGORIZE, RC_EDIT, RC_LOG, and RC_NEW.

Member Function Documentation

◆ addModules()

MediaWiki\SpecialPage\ChangesListSpecialPage::addModules ( )

protected

Add page-specific modules.

Definition at line 1779 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\execute().

◆ areFiltersInConflict()

MediaWiki\SpecialPage\ChangesListSpecialPage::areFiltersInConflict ( )

protected

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

Returns: bool

Definition at line 621 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\getFilterGroups(), MediaWiki\SpecialPage\ChangesListSpecialPage\getOptions(), and wfLogWarning().

Referenced by MediaWiki\Specials\SpecialWatchlist\doMainQuery().

◆ buildQuery()

MediaWiki\SpecialPage\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 IReadableDatabase::select $table
array	&$fields	Array of fields; see IReadableDatabase::select $vars
array	&$conds	Array of conditions; see IReadableDatabase::select $conds
array	&$query_options	Array of query options; see IReadableDatabase::select $options
array	&$join_conds	Array of join conditions; see IReadableDatabase::select $join_conds
FormOptions	$opts

Definition at line 1487 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\getDB(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\SpecialPage\ChangesListSpecialPage\isStructuredFilterUiEnabled(), MediaWiki\Html\FormOptions\reset(), and wfTimestamp().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\getRows().

◆ checkStructuredFilterUiEnabled()

static MediaWiki\SpecialPage\ChangesListSpecialPage::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 in MediaWiki\Specials\SpecialWatchlist.

Definition at line 1947 of file ChangesListSpecialPage.php.

◆ considerActionsForDefaultSavedQuery()

MediaWiki\SpecialPage\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

Returns: bool Whether a redirect will be performed.

Definition at line 753 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\execute().

◆ convertParamsForLink()

MediaWiki\SpecialPage\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 1466 of file ChangesListSpecialPage.php.

References $params.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\validateOptions().

◆ doHeader()

MediaWiki\SpecialPage\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 MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 1652 of file ChangesListSpecialPage.php.

◆ doMainQuery()

MediaWiki\SpecialPage\ChangesListSpecialPage::doMainQuery	(		$tables,
			$fields,
			$conds,
			$query_options,
			$join_conds,
		FormOptions	$opts )

protected

Process the query.

Parameters

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

Returns: bool|IResultWrapper Result or false

Reimplemented in MediaWiki\Specials\SpecialRecentChanges, MediaWiki\Specials\SpecialWatchlist, and MediaWiki\Specials\SpecialRecentChangesLinked.

Definition at line 1557 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\getDB(), ChangeTags\modifyDisplayQuery(), and MediaWiki\SpecialPage\ChangesListSpecialPage\runMainQueryHook().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\getRows().

◆ execute()

MediaWiki\SpecialPage\ChangesListSpecialPage::execute ( $subpage )

Parameters

string | null $subpage

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Reimplemented in MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 657 of file ChangesListSpecialPage.php.

◆ fetchOptionsFromRequest()

MediaWiki\SpecialPage\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 MediaWiki\Specials\SpecialWatchlist.

Definition at line 1284 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getRequest().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\setup().

◆ filterOnUserExperienceLevel()

MediaWiki\SpecialPage\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
IReadableDatabase	$dbr	Database, for addQuotes, makeList, and similar
array	&$tables	Array of tables; see IReadableDatabase::select $table
array	&$fields	Array of fields; see IReadableDatabase::select $vars
array	&$conds	Array of conditions; see IReadableDatabase::select $conds
array	&$query_options	Array of query options; see IReadableDatabase::select $options
array	&$join_conds	Array of join conditions; see IReadableDatabase::select $join_conds
array	$selectedExpLevels	The allowed active values, sorted
int	$now	Current time as UNIX timestamp (if 0, uses actual time)

Definition at line 1866 of file ChangesListSpecialPage.php.

◆ getCollapsedPreferenceName()

MediaWiki\SpecialPage\ChangesListSpecialPage::getCollapsedPreferenceName ( )

abstractprotected

Preference name for collapsing the active filter display.

Since: 1.38

Returns: string

Reimplemented in MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp().

◆ getDB()

MediaWiki\SpecialPage\ChangesListSpecialPage::getDB ( )

protected

Which database to use for read queries.

Returns: IReadableDatabase

Definition at line 1605 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\buildQuery(), MediaWiki\SpecialPage\ChangesListSpecialPage\doMainQuery(), MediaWiki\Specials\SpecialWatchlist\doMainQuery(), MediaWiki\Specials\SpecialRecentChangesLinked\doMainQuery(), and MediaWiki\Specials\SpecialWatchlist\outputChangesList().

◆ getDefaultDays()

MediaWiki\SpecialPage\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 1974 of file ChangesListSpecialPage.php.

References getUser().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\getDefaultOptions(), and MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp().

◆ getDefaultDaysPreferenceName()

MediaWiki\SpecialPage\ChangesListSpecialPage::getDefaultDaysPreferenceName ( )

abstractprotected

Preference name for 'days'.

Since: 1.38

Returns: string

Reimplemented in MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp().

◆ getDefaultLimit()

MediaWiki\SpecialPage\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 MediaWiki\Specials\SpecialRecentChanges.

Definition at line 1960 of file ChangesListSpecialPage.php.

References getUser().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\getDefaultOptions(), and MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp().

◆ getDefaultOptions()

MediaWiki\SpecialPage\ChangesListSpecialPage::getDefaultOptions ( )

Get a FormOptions object containing the default options.

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

Returns: FormOptions

Reimplemented in MediaWiki\Specials\SpecialRecentChangesLinked.

Definition at line 1179 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\getDefaultDays(), MediaWiki\SpecialPage\ChangesListSpecialPage\getDefaultLimit(), MediaWiki\SpecialPage\SpecialPage\getRequest(), and MediaWiki\SpecialPage\ChangesListSpecialPage\isStructuredFilterUiEnabled().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\setup().

◆ getExtraOptions()

MediaWiki\SpecialPage\ChangesListSpecialPage::getExtraOptions ( $opts )

Get options to be displayed in a form.

Todo

This should handle options returned by getDefaultOptions().

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 MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialRecentChangesLinked.

Definition at line 1691 of file ChangesListSpecialPage.php.

◆ getFilterGroup()

MediaWiki\SpecialPage\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 1233 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\registerFilters(), MediaWiki\Specials\SpecialWatchlist\registerFilters(), and MediaWiki\SpecialPage\ChangesListSpecialPage\replaceOldOptions().

◆ getFilterGroups()

MediaWiki\SpecialPage\ChangesListSpecialPage::getFilterGroups ( )

protected

Gets the currently registered filters groups.

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

Definition at line 1222 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\$filterGroups.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\areFiltersInConflict().

◆ getGroupName()

MediaWiki\SpecialPage\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'.

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 1795 of file ChangesListSpecialPage.php.

◆ getLegacyShowHideFilters()

MediaWiki\SpecialPage\ChangesListSpecialPage::getLegacyShowHideFilters ( )

protected

Returns: ChangesListBooleanFilter[] The legacy show/hide toggle filters

Definition at line 1131 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\Specials\SpecialWatchlist\fetchOptionsFromRequest().

◆ getLimitPreferenceName()

MediaWiki\SpecialPage\ChangesListSpecialPage::getLimitPreferenceName ( )

abstractprotected

Getting the preference name for 'limit'.

Since: 1.37

Returns: string

Reimplemented in MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp().

◆ getLinkDays()

MediaWiki\SpecialPage\ChangesListSpecialPage::getLinkDays ( )

protected

See also: \MediaWiki\MainConfigSchema::RCLinkDays and \MediaWiki\MainConfigSchema::RCFilterByAge.

Returns: int[]

Definition at line 829 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\MainConfigNames\RCFilterByAge, MediaWiki\MainConfigNames\RCLinkDays, and MediaWiki\MainConfigNames\RCMaxAge.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp().

◆ getOptions()

MediaWiki\SpecialPage\ChangesListSpecialPage::getOptions ( )

Get the current FormOptions for this request.

Returns: FormOptions

Definition at line 994 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\$rcOptions, and MediaWiki\SpecialPage\ChangesListSpecialPage\setup().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\areFiltersInConflict(), MediaWiki\SpecialPage\ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), MediaWiki\SpecialPage\ChangesListSpecialPage\execute(), MediaWiki\Specials\SpecialWatchlist\execute(), and MediaWiki\SpecialPage\ChangesListSpecialPage\getRows().

◆ getRcFiltersConfigSummary()

static MediaWiki\SpecialPage\ChangesListSpecialPage::getRcFiltersConfigSummary ( RL\Context $context )

static

Get essential data about getRcFiltersConfigVars() for change detection.

Access: internal: For use by Resources.php only.

See also: Module::getDefinitionSummary() and Module::getVersionHash()

Parameters

RL\\Context $context

Returns: array

Definition at line 919 of file ChangesListSpecialPage.php.

References ChangeTags\getChangeTagListSummary(), MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\SpecialPage\SpecialPage\getTitleFor().

◆ getRcFiltersConfigVars()

static MediaWiki\SpecialPage\ChangesListSpecialPage::getRcFiltersConfigVars ( RL\Context $context )

static

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

Access: internal: For use by Resources.php only.

Parameters

RL\\Context $context

Returns: array

Definition at line 937 of file ChangesListSpecialPage.php.

References ChangeTags\getChangeTagList(), MediaWiki\MediaWikiServices\getInstance(), and MediaWiki\SpecialPage\SpecialPage\getTitleFor().

◆ getRows()

MediaWiki\SpecialPage\ChangesListSpecialPage::getRows ( )

Get the database result for this special page instance.

Used by ApiFeedRecentChanges.

Returns: IResultWrapper|false

Definition at line 976 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\buildQuery(), MediaWiki\SpecialPage\ChangesListSpecialPage\doMainQuery(), and MediaWiki\SpecialPage\ChangesListSpecialPage\getOptions().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\execute().

◆ getSavedQueriesPreferenceName()

MediaWiki\SpecialPage\ChangesListSpecialPage::getSavedQueriesPreferenceName ( )

abstractprotected

Preference name for saved queries.

Since: 1.38

Returns: string

Reimplemented in MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), and MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp().

◆ getStructuredFilterJsData()

MediaWiki\SpecialPage\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 1250 of file ChangesListSpecialPage.php.

References ChangesListFilterGroup\getPriority().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp().

◆ includeRcFiltersApp()

MediaWiki\SpecialPage\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 857 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\execute().

◆ isStructuredFilterUiEnabled()

MediaWiki\SpecialPage\ChangesListSpecialPage::isStructuredFilterUiEnabled ( )

Check whether the structured filter UI is enabled.

Returns: bool

Definition at line 1932 of file ChangesListSpecialPage.php.

References getRequest(), and getUser().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\buildQuery(), MediaWiki\SpecialPage\ChangesListSpecialPage\considerActionsForDefaultSavedQuery(), MediaWiki\Specials\SpecialWatchlist\execute(), MediaWiki\SpecialPage\ChangesListSpecialPage\getDefaultOptions(), MediaWiki\SpecialPage\ChangesListSpecialPage\includeRcFiltersApp(), MediaWiki\Specials\SpecialWatchlist\outputChangesList(), MediaWiki\Specials\SpecialWatchlist\registerFilters(), and MediaWiki\SpecialPage\ChangesListSpecialPage\replaceOldOptions().

◆ makeLegend()

MediaWiki\SpecialPage\ChangesListSpecialPage::makeLegend ( )

Return the legend displayed within the fieldset.

Returns: string

Definition at line 1700 of file ChangesListSpecialPage.php.

References MediaWiki\Html\element(), getContext(), getRequest(), MediaWiki\MainConfigNames\RecentChangesFlags, and MediaWiki\MainConfigNames\WatchlistExpiry.

Referenced by MediaWiki\Specials\SpecialWatchlist\outputChangesList().

◆ outputChangesList()

MediaWiki\SpecialPage\ChangesListSpecialPage::outputChangesList	(		$rows,
			$opts )

abstract

Build and output the actual changes list.

Parameters

IResultWrapper	$rows	Database rows
FormOptions	$opts

Reimplemented in MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

◆ outputFeedLinks()

MediaWiki\SpecialPage\ChangesListSpecialPage::outputFeedLinks ( )

Reimplemented in MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 1634 of file ChangesListSpecialPage.php.

◆ outputNoResults()

MediaWiki\SpecialPage\ChangesListSpecialPage::outputNoResults ( )

protected

Add the "no results" message to the output.

Reimplemented in MediaWiki\Specials\SpecialRecentChangesLinked.

Definition at line 950 of file ChangesListSpecialPage.php.

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

◆ outputTimeout()

MediaWiki\SpecialPage\ChangesListSpecialPage::outputTimeout ( )

protected

Add the "timeout" message to the output.

Definition at line 963 of file ChangesListSpecialPage.php.

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

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\execute().

◆ parseParameters()

MediaWiki\SpecialPage\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 MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialRecentChangesLinked.

Definition at line 1296 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\setup().

◆ registerFilterGroup()

MediaWiki\SpecialPage\ChangesListSpecialPage::registerFilterGroup ( ChangesListFilterGroup $group )

Register a structured changes list filter group.

Parameters

ChangesListFilterGroup $group

Definition at line 1211 of file ChangesListSpecialPage.php.

References ChangesListFilterGroup\getName().

Referenced by MediaWiki\Specials\SpecialWatchlist\registerFilters(), and MediaWiki\SpecialPage\ChangesListSpecialPage\registerFiltersFromDefinitions().

◆ registerFilters()

MediaWiki\SpecialPage\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 MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 1011 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\SpecialPage\ChangesListSpecialPage\getFilterGroup(), MediaWiki\SpecialPage\SpecialPage\getHookRunner(), MediaWiki\SpecialPage\SpecialPage\getUser(), MediaWiki\SpecialPage\SpecialPage\including(), MediaWiki\MainConfigNames\RCWatchCategoryMembership, MediaWiki\SpecialPage\ChangesListSpecialPage\registerFiltersFromDefinitions(), and MediaWiki\SpecialPage\ChangesListSpecialPage\transformFilterDefinition().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\setup().

◆ registerFiltersFromDefinitions()

MediaWiki\SpecialPage\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

Definition at line 1105 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\registerFilterGroup(), and MediaWiki\SpecialPage\ChangesListSpecialPage\transformFilterDefinition().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\registerFilters().

◆ replaceOldOptions()

MediaWiki\SpecialPage\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 1417 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\getFilterGroup(), MediaWiki\SpecialPage\ChangesListSpecialPage\isStructuredFilterUiEnabled(), MediaWiki\Html\FormOptions\reset(), and ChangesListStringOptionsFilterGroup\SEPARATOR.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\validateOptions().

◆ runMainQueryHook()

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

protected

Definition at line 1593 of file ChangesListSpecialPage.php.

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

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\doMainQuery(), MediaWiki\Specials\SpecialWatchlist\doMainQuery(), and MediaWiki\Specials\SpecialRecentChangesLinked\doMainQuery().

◆ setBottomText()

MediaWiki\SpecialPage\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 1678 of file ChangesListSpecialPage.php.

◆ setTempUserConfig()

MediaWiki\SpecialPage\ChangesListSpecialPage::setTempUserConfig ( TempUserConfig $tempUserConfig )

Set the temp user config.

Access: internal

Parameters

TempUserConfig $tempUserConfig

Since: 1.42

Definition at line 741 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\$tempUserConfig.

◆ setTopText()

MediaWiki\SpecialPage\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 MediaWiki\Specials\SpecialRecentChanges, MediaWiki\Specials\SpecialRecentChangesLinked, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 1667 of file ChangesListSpecialPage.php.

◆ setup()

MediaWiki\SpecialPage\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 1153 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\fetchOptionsFromRequest(), MediaWiki\SpecialPage\ChangesListSpecialPage\getDefaultOptions(), MediaWiki\SpecialPage\ChangesListSpecialPage\parseParameters(), MediaWiki\SpecialPage\ChangesListSpecialPage\registerFilters(), and MediaWiki\SpecialPage\ChangesListSpecialPage\validateOptions().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\getOptions().

◆ transformFilterDefinition()

MediaWiki\SpecialPage\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 MediaWiki\Specials\SpecialRecentChanges, and MediaWiki\Specials\SpecialWatchlist.

Definition at line 1091 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\registerFilters(), and MediaWiki\SpecialPage\ChangesListSpecialPage\registerFiltersFromDefinitions().

◆ validateOptions()

MediaWiki\SpecialPage\ChangesListSpecialPage::validateOptions ( FormOptions $opts )

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

Parameters

FormOptions $opts

Definition at line 1335 of file ChangesListSpecialPage.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\convertParamsForLink(), MediaWiki\Html\FormOptions\getChangedValues(), MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getPageTitle(), MediaWiki\MainConfigNames\RCMaxAge, MediaWiki\SpecialPage\ChangesListSpecialPage\replaceOldOptions(), MediaWiki\Html\FormOptions\validateBounds(), MediaWiki\Html\FormOptions\validateIntBounds(), and wfArrayToCgi().

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\setup().

◆ webOutput()

MediaWiki\SpecialPage\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 1628 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\execute().

Member Data Documentation

◆ $filterGroups

ChangesListFilterGroup [] MediaWiki\SpecialPage\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 103 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\getFilterGroups().

◆ $rcOptions

FormOptions MediaWiki\SpecialPage\ChangesListSpecialPage::$rcOptions

protected

Definition at line 62 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\getOptions().

◆ $rcSubpage

string MediaWiki\SpecialPage\ChangesListSpecialPage::$rcSubpage

protected

Definition at line 59 of file ChangesListSpecialPage.php.

◆ $tempUserConfig

TempUserConfig MediaWiki\SpecialPage\ChangesListSpecialPage::$tempUserConfig

protected

Definition at line 65 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\__construct(), MediaWiki\Specials\SpecialRecentChangesLinked\__construct(), MediaWiki\Specials\SpecialWatchlist\__construct(), MediaWiki\Specials\SpecialRecentChanges\__construct(), and MediaWiki\SpecialPage\ChangesListSpecialPage\setTempUserConfig().

◆ $userIdentityUtils

UserIdentityUtils MediaWiki\SpecialPage\ChangesListSpecialPage::$userIdentityUtils

protected

Definition at line 64 of file ChangesListSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ChangesListSpecialPage\__construct(), MediaWiki\Specials\SpecialRecentChangesLinked\__construct(), MediaWiki\Specials\SpecialWatchlist\__construct(), and MediaWiki\Specials\SpecialRecentChanges\__construct().

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

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addModules()

◆ areFiltersInConflict()

◆ buildQuery()

◆ checkStructuredFilterUiEnabled()

◆ considerActionsForDefaultSavedQuery()

◆ convertParamsForLink()

◆ doHeader()

◆ doMainQuery()

◆ execute()

◆ fetchOptionsFromRequest()

◆ filterOnUserExperienceLevel()

◆ getCollapsedPreferenceName()

◆ getDB()

◆ getDefaultDays()

◆ getDefaultDaysPreferenceName()

◆ getDefaultLimit()

◆ getDefaultOptions()

◆ getExtraOptions()

◆ getFilterGroup()

◆ getFilterGroups()

◆ getGroupName()

◆ getLegacyShowHideFilters()

◆ getLimitPreferenceName()

◆ getLinkDays()

◆ getOptions()

◆ getRcFiltersConfigSummary()

◆ getRcFiltersConfigVars()

◆ getRows()

◆ getSavedQueriesPreferenceName()

◆ getStructuredFilterJsData()

◆ includeRcFiltersApp()

◆ isStructuredFilterUiEnabled()

◆ makeLegend()

◆ outputChangesList()

◆ outputFeedLinks()

◆ outputNoResults()

◆ outputTimeout()

◆ parseParameters()

◆ registerFilterGroup()

◆ registerFilters()

◆ registerFiltersFromDefinitions()

◆ replaceOldOptions()

◆ runMainQueryHook()

◆ setBottomText()

◆ setTempUserConfig()

◆ setTopText()

◆ setup()

◆ transformFilterDefinition()

◆ validateOptions()

◆ webOutput()

Member Data Documentation

◆ $filterGroups

◆ $rcOptions

◆ $rcSubpage

◆ $tempUserConfig

◆ $userIdentityUtils