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

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

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

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

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

	getContentLanguage ()
	Shortcut to get content language. 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...

	getShortDescription (string $path='')
	Similar to getDescription but takes into account sub pages and designed for display in tabs. 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...

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

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

	setContentLanguage (Language $contentLanguage)
	Set content language. 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...

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	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 (UserIdentity $user)
	Static method to check whether StructuredFilter UI is enabled for the given user. More...

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

static	getRcFiltersConfigVars (RL\Context $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...

static	newSearchPage (User $user)
	Get the users preferred search page. 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...

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

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

	getDefaultDaysPreferenceName ()
	Preference name for 'days'. 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 ()

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

	getLinkDays ()

	getSavedQueriesPreferenceName ()
	Preference name for saved queries. More...

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

	getAuthManager ()

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

	getSpecialPageFactory ()

	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, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages. More...

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor. 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...

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

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

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

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

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

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

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 39 of file ChangesListSpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

ChangesListSpecialPage::__construct	(	$name,
		$restriction
	)

Definition at line 85 of file ChangesListSpecialPage.php.

References $dbr, $s, SpecialPage\getHookRunner(), LIST_OR, 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.

Definition at line 1699 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 563 of file ChangesListSpecialPage.php.

References getFilterGroups(), getOptions(), and wfLogWarning().

Referenced by 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 1408 of file ChangesListSpecialPage.php.

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

Referenced by getRows().

◆ checkStructuredFilterUiEnabled()

static 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 SpecialWatchlist.

Definition at line 1863 of file ChangesListSpecialPage.php.

◆ 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 688 of file ChangesListSpecialPage.php.

References FormatJson\decode(), getOptions(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), getSavedQueriesPreferenceName(), 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 1387 of file ChangesListSpecialPage.php.

Referenced by 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 1572 of file ChangesListSpecialPage.php.

References setBottomText(), and setTopText().

◆ 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 1478 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 SpecialWatchlist, and SpecialRecentChanges.

Definition at line 599 of file ChangesListSpecialPage.php.

References $title, 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, and webOutput().

◆ 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 1205 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 1735 of file ChangesListSpecialPage.php.

References $dbr, SpecialPage\getConfig(), LIST_AND, and LIST_OR.

◆ getCollapsedPreferenceName()

ChangesListSpecialPage::getCollapsedPreferenceName ( )

abstractprotected

Preference name for collapsing the active filter display.

Since: 1.38

Returns: string

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Referenced by includeRcFiltersApp().

◆ getDB()

ChangesListSpecialPage::getDB ( )

protected

Return a IDatabase object for reading.

Returns: IDatabase

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1525 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 1890 of file ChangesListSpecialPage.php.

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

Referenced by getDefaultOptions(), and includeRcFiltersApp().

◆ getDefaultDaysPreferenceName()

ChangesListSpecialPage::getDefaultDaysPreferenceName ( )

abstractprotected

Preference name for 'days'.

Since: 1.38

Returns: string

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Referenced by getDefaultDays(), 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 1876 of file ChangesListSpecialPage.php.

References getLimitPreferenceName(), and 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 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 SpecialRecentChangesLinked.

Definition at line 1102 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 SpecialRecentChangesLinked, and SpecialRecentChanges.

Definition at line 1611 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 1154 of file ChangesListSpecialPage.php.

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

◆ getFilterGroups()

ChangesListSpecialPage::getFilterGroups ( )

protected

Gets the currently registered filters groups.

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

Definition at line 1143 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'.

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 1715 of file ChangesListSpecialPage.php.

◆ getLegacyShowHideFilters()

ChangesListSpecialPage::getLegacyShowHideFilters ( )

protected

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

Definition at line 1054 of file ChangesListSpecialPage.php.

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

◆ getLimitPreferenceName()

ChangesListSpecialPage::getLimitPreferenceName ( )

abstractprotected

Getting the preference name for 'limit'.

Since: 1.37

Returns: string

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Referenced by getDefaultLimit(), and includeRcFiltersApp().

◆ getLinkDays()

ChangesListSpecialPage::getLinkDays ( )

protected

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

Returns: int[]

Definition at line 758 of file ChangesListSpecialPage.php.

References SpecialPage\getConfig().

Referenced by includeRcFiltersApp().

◆ getOptions()

ChangesListSpecialPage::getOptions ( )

Get the current FormOptions for this request.

Returns: FormOptions

Definition at line 923 of file ChangesListSpecialPage.php.

References $rcOptions, and setup().

Referenced by areFiltersInConflict(), considerActionsForDefaultSavedQuery(), execute(), SpecialWatchlist\execute(), and getRows().

◆ getRcFiltersConfigSummary()

static 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 848 of file ChangesListSpecialPage.php.

References $lang, ChangeTags\getChangeTagListSummary(), and SpecialPage\getTitleFor().

◆ getRcFiltersConfigVars()

static 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 866 of file ChangesListSpecialPage.php.

References $lang, ChangeTags\getChangeTagList(), and SpecialPage\getTitleFor().

◆ getRows()

ChangesListSpecialPage::getRows ( )

Get the database result for this special page instance.

Used by ApiFeedRecentChanges.

Returns: IResultWrapper|false

Definition at line 905 of file ChangesListSpecialPage.php.

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

Referenced by execute().

◆ getSavedQueriesPreferenceName()

ChangesListSpecialPage::getSavedQueriesPreferenceName ( )

abstractprotected

Preference name for saved queries.

Since: 1.38

Returns: string

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Referenced by considerActionsForDefaultSavedQuery(), and includeRcFiltersApp().

◆ 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 1171 of file ChangesListSpecialPage.php.

References ChangesListFilterGroup\getPriority().

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 786 of file ChangesListSpecialPage.php.

References getCollapsedPreferenceName(), SpecialPage\getConfig(), getDefaultDays(), getDefaultDaysPreferenceName(), getDefaultLimit(), getLimitPreferenceName(), getLinkDays(), SpecialPage\getOutput(), getSavedQueriesPreferenceName(), 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 1848 of file ChangesListSpecialPage.php.

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

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

◆ makeLegend()

ChangesListSpecialPage::makeLegend ( )

Return the legend displayed within the fieldset.

Returns: string

Definition at line 1620 of file ChangesListSpecialPage.php.

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

Referenced by SpecialWatchlist\doHeader(), 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 ( )

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1554 of file ChangesListSpecialPage.php.

◆ outputNoResults()

ChangesListSpecialPage::outputNoResults ( )

protected

Add the "no results" message to the output.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 879 of file ChangesListSpecialPage.php.

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

◆ outputTimeout()

ChangesListSpecialPage::outputTimeout ( )

protected

Add the "timeout" message to the output.

Definition at line 892 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 SpecialRecentChangesLinked, and SpecialRecentChanges.

Definition at line 1217 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 1132 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 SpecialWatchlist, and SpecialRecentChanges.

Definition at line 940 of file ChangesListSpecialPage.php.

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

Referenced by setup().