MediaWiki  REL1_31
ChangesListSpecialPage Class Reference

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

Inheritance diagram for ChangesListSpecialPage:
Collaboration diagram for ChangesListSpecialPage:

Public Member Functions

 __construct ( $name, $restriction)
 
 doHeader ( $opts, $numRows)
 Set the text to be displayed above the changes. More...
 
 execute ( $subpage)
 Main execution point. More...
 
 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...
 
 isStructuredFilterUiEnabledByDefault ()
 Check whether the structured filter UI is enabled by default (regardless of this particular user's setting) 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...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. 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...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. 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)
 Wrapper around wfMessage that sets the current context. 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...
 
 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...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 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 (Config $config, User $user)
 Static method to check whether StructuredFilter UI is enabled for the given user. 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...
 

Public Attributes

const TAG_DESC_CHARACTER_LIMIT = 120
 Maximum length of a tag description in UTF-8 characters. 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() Bug 36524. 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...
 
 getChangeTagList ()
 Fetch the change tags list for the front end. More...
 
 getCustomFilters ()
 Get custom show/hide filters using deprecated ChangesListSpecialPageFilters hook. More...
 
 getDB ()
 Return a IDatabase object for reading. More...
 
 getFilterGroupDefinitionFromLegacyCustomFilters (array $customFilters)
 Get filter group definition from legacy custom filters. 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 ()
 
 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...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 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...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

array $customFilters
 
 $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 $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

 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

 $filterGroupDefinitions
 Definition information for the filters and their groups. More...
 
 $hideCategorizationFilterDefinition
 
 $legacyReviewStatusFilterGroupDefinition
 
 $reviewStatusFilterGroupDefinition
 

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:
Way too many public functions, most of them should be protected

Definition at line 35 of file ChangesListSpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addModules()

ChangesListSpecialPage::addModules ( )
protected

Add page-specific modules.

Reimplemented in SpecialRecentChanges.

Definition at line 1728 of file ChangesListSpecialPage.php.

References $out, 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 578 of file ChangesListSpecialPage.php.

References as, 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&$tablesArray of tables; see IDatabase::select $table
array&$fieldsArray of fields; see IDatabase::select $vars
array&$condsArray of conditions; see IDatabase::select $conds
array&$query_optionsArray of query options; see IDatabase::select $options
array&$join_condsArray of join conditions; see IDatabase::select $join_conds
FormOptions$opts

Definition at line 1466 of file ChangesListSpecialPage.php.

References $dbr, $namespaces, $tables, $value, as, MWNamespace\getAssociated(), getDB(), isStructuredFilterUiEnabled(), FormOptions\reset(), and wfTimestamp().

Referenced by getRows().

◆ checkStructuredFilterUiEnabled()

static ChangesListSpecialPage::checkStructuredFilterUiEnabled ( Config  $config,
User  $user 
)
static

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

Since
1.31
Parameters
Config$config
User$user
Returns
bool

Reimplemented in SpecialWatchlist.

Definition at line 1906 of file ChangesListSpecialPage.php.

References $user, and Config\get().

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

References $query, 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() Bug 36524.

Parameters
array$params
Returns
array

Definition at line 1445 of file ChangesListSpecialPage.php.

References $params, $value, and as.

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

◆ doHeader()

ChangesListSpecialPage::doHeader (   $opts,
  $numRows 
)

Set the text to be displayed above the changes.

Parameters
FormOptions$opts
int$numRowsNumber of rows in the result to show after this header

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1627 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$tablesArray of tables; see IDatabase::select $table
array$fieldsArray of fields; see IDatabase::select $vars
array$condsArray of conditions; see IDatabase::select $conds
array$query_optionsArray of query options; see IDatabase::select $options
array$join_condsArray 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 1528 of file ChangesListSpecialPage.php.

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

Referenced by getRows().

◆ execute()

◆ 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 1264 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$specialPageClassNameClass name of current special page
IContextSource$contextContext, for e.g. user
IDatabase$dbrDatabase, for addQuotes, makeList, and similar
array&$tablesArray of tables; see IDatabase::select $table
array&$fieldsArray of fields; see IDatabase::select $vars
array&$condsArray of conditions; see IDatabase::select $conds
array&$query_optionsArray of query options; see IDatabase::select $options
array&$join_condsArray of join conditions; see IDatabase::select $join_conds
array$selectedExpLevelsThe allowed active values, sorted
int$nowNumber of seconds since the UNIX epoch, or 0 if not given (optional)

Definition at line 1763 of file ChangesListSpecialPage.php.

References $dbr, $tables, $wgExperiencedUserEdits, $wgExperiencedUserMemberSince, $wgLearnerEdits, $wgLearnerMemberSince, global, 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 1376 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 1334 of file ChangesListSpecialPage.php.

References as, fixBackwardsCompatibilityOptions(), and use.

Referenced by validateOptions().

◆ getChangeTagList()

◆ getCustomFilters()

ChangesListSpecialPage::getCustomFilters ( )
protected

Get custom show/hide filters using deprecated ChangesListSpecialPageFilters hook.

Returns
array Map of filter URL param names to properties (msg/default)

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1247 of file ChangesListSpecialPage.php.

References $customFilters, and Hooks\run().

Referenced by registerFilters().

◆ getDB()

ChangesListSpecialPage::getDB ( )
protected

Return a IDatabase object for reading.

Returns
IDatabase

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1577 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 1933 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 1921 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 1145 of file ChangesListSpecialPage.php.

References as, 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 1664 of file ChangesListSpecialPage.php.

◆ getFilterGroup()

ChangesListSpecialPage::getFilterGroup (   $groupName)

Gets a specified ChangesListFilterGroup by name.

Parameters
string$groupNameName of group
Returns
ChangesListFilterGroup|null Group, or null if not registered

Definition at line 1197 of file ChangesListSpecialPage.php.

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

◆ getFilterGroupDefinitionFromLegacyCustomFilters()

ChangesListSpecialPage::getFilterGroupDefinitionFromLegacyCustomFilters ( array  $customFilters)
protected

Get filter group definition from legacy custom filters.

Parameters
array$customFiltersCustom filters from legacy hooks
Returns
array Group definition

Definition at line 1074 of file ChangesListSpecialPage.php.

References $customFilters, $name, $params, as, and class.

Referenced by registerFilters().

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

◆ getLegacyShowHideFilters()

ChangesListSpecialPage::getLegacyShowHideFilters ( )
protected
Returns
array The legacy show/hide toggle filters

Definition at line 1097 of file ChangesListSpecialPage.php.

References as.

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

◆ getOptions()

◆ getRows()

ChangesListSpecialPage::getRows ( )

Get the database result for this special page instance.

Used by ApiFeedRecentChanges.

Returns
bool|IResultWrapper Result or false

Definition at line 919 of file ChangesListSpecialPage.php.

References $tables, 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 1215 of file ChangesListSpecialPage.php.

References $output, and as.

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

References $messages, $out, as, getChangeTagList(), SpecialPage\getConfig(), getDefaultDays(), getDefaultLimit(), SpecialPage\getOutput(), getStructuredFilterJsData(), SpecialPage\including(), isStructuredFilterUiEnabled(), ResourceLoader\makeInlineScript(), ResourceLoader\makeMessageSetScript(), and SpecialPage\msg().

Referenced by execute().

◆ isStructuredFilterUiEnabled()

◆ isStructuredFilterUiEnabledByDefault()

ChangesListSpecialPage::isStructuredFilterUiEnabledByDefault ( )

Check whether the structured filter UI is enabled by default (regardless of this particular user's setting)

Returns
bool

Definition at line 1890 of file ChangesListSpecialPage.php.

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

◆ makeLegend()

◆ outputChangesList()

ChangesListSpecialPage::outputChangesList (   $rows,
  $opts 
)
abstract

Build and output the actual changes list.

Parameters
IResultWrapper$rowsDatabase 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 1609 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 895 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 906 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 1276 of file ChangesListSpecialPage.php.

References as.

Referenced by setup().

◆ registerFilterGroup()

ChangesListSpecialPage::registerFilterGroup ( ChangesListFilterGroup  $group)

Register a structured changes list filter group.

Parameters
ChangesListFilterGroup$group

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

References SpecialPage\getConfig(), getCustomFilters(), getFilterGroup(), getFilterGroupDefinitionFromLegacyCustomFilters(), SpecialPage\getUser(), SpecialPage\including(), registerFiltersFromDefinitions(), Hooks\run(), 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

Definition at line 1045 of file ChangesListSpecialPage.php.

References as, registerFilterGroup(), and transformFilterDefinition().

Referenced by registerFilters(), and SpecialRecentChanges\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 1396 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

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1563 of file ChangesListSpecialPage.php.

References $tables, SpecialPage\getName(), and Hooks\run().

Referenced by doMainQuery().

◆ setBottomText()

ChangesListSpecialPage::setBottomText ( FormOptions  $opts)

Send the text to be displayed after the options.

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

Parameters
FormOptions$opts

Definition at line 1651 of file ChangesListSpecialPage.php.

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

◆ setTopText()

ChangesListSpecialPage::setTopText ( FormOptions  $opts)

Send the text to be displayed before the options.

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

Parameters
FormOptions$opts

Reimplemented in SpecialWatchlist, SpecialRecentChangesLinked, and SpecialRecentChanges.

Definition at line 1641 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
array$parameters
Returns
FormOptions

Definition at line 1119 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$filterDefinitionOriginal filter definition
Returns
array Transformed definition

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 1032 of file ChangesListSpecialPage.php.

Referenced by registerFilters(), and registerFiltersFromDefinitions().

◆ validateOptions()

◆ webOutput()

ChangesListSpecialPage::webOutput (   $rows,
  $opts 
)

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

Parameters
IResultWrapper$rowsDatabase rows
FormOptions$opts

Definition at line 1600 of file ChangesListSpecialPage.php.

References $rows, 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$rowCountNumber of database rows
FormOptions$opts

Definition at line 1587 of file ChangesListSpecialPage.php.

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

Referenced by execute(), and webOutput().

Member Data Documentation

◆ $customFilters

◆ $daysPreferenceName

string ChangesListSpecialPage::$daysPreferenceName
staticprotected

Preference name for 'days'.

Subclasses should override this.

Definition at line 52 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. This is done in getFilterGroupDefinitionFromLegacyCustomFilters, for example.

Definition at line 86 of file ChangesListSpecialPage.php.

◆ $filterGroups

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

Referenced by getFilterGroups().

◆ $hideCategorizationFilterDefinition

ChangesListSpecialPage::$hideCategorizationFilterDefinition
private

Definition at line 96 of file ChangesListSpecialPage.php.

◆ $legacyReviewStatusFilterGroupDefinition

ChangesListSpecialPage::$legacyReviewStatusFilterGroupDefinition
private

Definition at line 90 of file ChangesListSpecialPage.php.

◆ $limitPreferenceName

string ChangesListSpecialPage::$limitPreferenceName
staticprotected

Preference name for 'limit'.

Subclasses should override this.

Definition at line 58 of file ChangesListSpecialPage.php.

◆ $rcOptions

FormOptions ChangesListSpecialPage::$rcOptions
protected

Definition at line 64 of file ChangesListSpecialPage.php.

Referenced by getOptions().

◆ $rcSubpage

string ChangesListSpecialPage::$rcSubpage
protected

Definition at line 61 of file ChangesListSpecialPage.php.

◆ $reviewStatusFilterGroupDefinition

ChangesListSpecialPage::$reviewStatusFilterGroupDefinition
private

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

◆ TAG_DESC_CHARACTER_LIMIT

const ChangesListSpecialPage::TAG_DESC_CHARACTER_LIMIT = 120

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

Longer descriptions will be truncated.

Definition at line 40 of file ChangesListSpecialPage.php.


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