MediaWiki  master
SpecialRecentChanges Class Reference

A special page that lists last changes made to the wiki. More...

Inheritance diagram for SpecialRecentChanges:
Collaboration diagram for SpecialRecentChanges:

Public Member Functions

 __construct ( $name='Recentchanges', $restriction='')
 
 checkLastModified ()
 Get last modified date, for client caching Don't use this if we are using the patrol feature, patrol changes don't update the timestamp. More...
 
 doHeader ( $opts, $numRows)
 Set the text to be displayed above the changes. More...
 
 execute ( $subpage)
 
 getDefaultLimit ()
 Get the default value of the number of changes to display when loading the result set. More...
 
 getExtraOptions ( $opts)
 Get options to be displayed in a form. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override. 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...
 
 setTopText (FormOptions $opts)
 Send the text to be displayed above the options. More...
 
- Public Member Functions inherited from 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. More...
 
 getDefaultDays ()
 Get the default value of the number of days to display when loading the result set. More...
 
 getDefaultOptions ()
 Get a FormOptions object containing the default options. 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...
 
 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...
 
 setup ( $parameters)
 Register all the filters, including legacy hook-driven ones. More...
 
 validateOptions (FormOptions $opts)
 Validate a FormOptions object generated by getDefaultOptions() with values already populated. More...
 
 webOutput ( $rows, $opts)
 Send output to the OutputPage object, only called if not used feeds. More...
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page Stable to override. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 addModules ()
 Add page-specific modules. More...
 
 addWatchlistJoins (IDatabase $dbr, &$tables, &$fields, &$joinConds, &$conds)
 Add required values to a query's $tables, $fields, $joinConds, and $conds arrays to join to the watchlist and watchlist_expiry tables where appropriate. More...
 
 doMainQuery ( $tables, $fields, $conds, $query_options, $join_conds, FormOptions $opts)
 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
More...
 
 getCacheTTL ()
 Stable to override. More...
 
 getDB ()
 Return a IDatabase object for reading. More...
 
 getFeedQuery ()
 Get URL query parameters for action=feedrecentchanges API feed of current recent changes view. More...
 
 namespaceFilterForm (FormOptions $opts)
 Creates the choose namespace selection. More...
 
 registerFilters ()
 Register all filters and their groups (including those from hooks), plus handle conflicts and defaults.You might want to customize these in the same method, in subclasses. You can call getFilterGroup to access a group, and (on the group) getFilter to access a filter, then make necessary modfications to the filter or group (e.g. with setDefault). More...
 
 transformFilterDefinition (array $filterDefinition)
 Transforms filter definition to prepare it for constructor.See overrides of this method as well.
Parameters
array$filterDefinitionOriginal filter definition
Returns
array Transformed definition
More...
 
- Protected Member Functions inherited from ChangesListSpecialPage
 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...
 
 fetchOptionsFromRequest ( $opts)
 Fetch values for a FormOptions object from the WebRequest associated with this instance. More...
 
 getFilterGroups ()
 Gets the currently registered filters groups. More...
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getLegacyShowHideFilters ()
 
 getLinkDays ()
 
 includeRcFiltersApp ()
 Include the modules and configuration for the RCFilters app. More...
 
 outputNoResults ()
 Add the "no results" message to the output. More...
 
 outputTimeout ()
 Add the "timeout" message to the output. More...
 
 registerFiltersFromDefinitions (array $definition)
 Register filters from a definition object. More...
 
 runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)
 
- 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 Stable to override. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! Stable to override. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Static Protected Attributes

static $collapsedPreferenceName = 'rcfilters-rc-collapsed'
 
static $daysPreferenceName = 'rcdays'
 
static $limitPreferenceName = 'rcfilters-limit'
 
static $savedQueriesPreferenceName = 'rcfilters-saved-queries'
 
- Static Protected Attributes inherited from ChangesListSpecialPage
static string $collapsedPreferenceName
 Preference name for collapsing the active filter display. More...
 
static string $daysPreferenceName
 Preference name for 'days'. More...
 
static string $limitPreferenceName
 Preference name for 'limit'. More...
 
static string $savedQueriesPreferenceName
 Preference name for saved queries. More...
 

Private Member Functions

 makeOptionsLink ( $title, $override, $options, $active=false)
 Makes change an option link which carries all the other options. More...
 
 needsWatchlistFeatures ()
 Whether or not the current query needs to use watchlist data: check that the current user can use their watchlist and that this special page isn't being transcluded. More...
 
 optionsPanel ( $defaults, $nondefaults, $numRows)
 Creates the options panel. More...
 

Private Attributes

 $watchlistFilterGroupDefinition
 

Additional Inherited Members

- Static Public Member Functions inherited from ChangesListSpecialPage
static checkStructuredFilterUiEnabled ( $user)
 Static method to check whether StructuredFilter UI is enabled for the given user. More...
 
static getRcFiltersConfigSummary (ResourceLoaderContext $context)
 Get essential data about getRcFiltersConfigVars() for change detection. More...
 
static getRcFiltersConfigVars (ResourceLoaderContext $context)
 Get config vars to export with the mediawiki.rcfilters.filters.ui module. More...
 
- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- Static Protected Member Functions inherited from ChangesListSpecialPage
static getChangeTagList (ResourceLoaderContext $context)
 Get information about change tags to export to JS via getRcFiltersConfigVars(). More...
 
static getChangeTagListSummary (ResourceLoaderContext $context)
 Get information about change tags, without parsing messages, for getRcFiltersConfigSummary(). More...
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 
- Protected Attributes inherited from ChangesListSpecialPage
ChangesListFilterGroup[] $filterGroups = []
 Filter groups, and their contained filters This is an associative array (with group name as key) of ChangesListFilterGroup objects. More...
 
FormOptions $rcOptions
 
string $rcSubpage
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Detailed Description

A special page that lists last changes made to the wiki.

Definition at line 33 of file SpecialRecentChanges.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialRecentChanges::__construct (   $name = 'Recentchanges',
  $restriction = '' 
)

Member Function Documentation

◆ addModules()

SpecialRecentChanges::addModules ( )
protected

Add page-specific modules.

Reimplemented from ChangesListSpecialPage.

Definition at line 710 of file SpecialRecentChanges.php.

References SpecialPage\getOutput().

◆ addWatchlistJoins()

SpecialRecentChanges::addWatchlistJoins ( IDatabase  $dbr,
$tables,
$fields,
$joinConds,
$conds 
)
protected

Add required values to a query's $tables, $fields, $joinConds, and $conds arrays to join to the watchlist and watchlist_expiry tables where appropriate.

Parameters
IDatabase$dbr
string[]&$tables
string[]&$fields
mixed[]&$joinConds
mixed[]&$conds

Definition at line 294 of file SpecialRecentChanges.php.

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

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

◆ checkLastModified()

SpecialRecentChanges::checkLastModified ( )

Get last modified date, for client caching Don't use this if we are using the patrol feature, patrol changes don't update the timestamp.

Returns
string|bool

Definition at line 723 of file SpecialRecentChanges.php.

References $dbr, and getDB().

Referenced by execute().

◆ doHeader()

SpecialRecentChanges::doHeader (   $opts,
  $numRows 
)

◆ doMainQuery()

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

Reimplemented in SpecialRecentChangesLinked.

Definition at line 320 of file SpecialRecentChanges.php.

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

◆ execute()

SpecialRecentChanges::execute (   $subpage)

◆ getCacheTTL()

SpecialRecentChanges::getCacheTTL ( )
protected

Stable to override.

Returns
int Seconds that this page can be cached

Reimplemented from SpecialPage.

Definition at line 922 of file SpecialRecentChanges.php.

◆ getDB()

SpecialRecentChanges::getDB ( )
protected

Return a IDatabase object for reading.

Returns
IDatabase

Reimplemented from ChangesListSpecialPage.

Definition at line 390 of file SpecialRecentChanges.php.

References DB_REPLICA, and wfGetDB().

Referenced by checkLastModified(), and doMainQuery().

◆ getDefaultLimit()

SpecialRecentChanges::getDefaultLimit ( )

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

Since
1.30
Returns
int

Reimplemented from ChangesListSpecialPage.

Definition at line 926 of file SpecialRecentChanges.php.

References SpecialPage\getUser(), and ChangesListSpecialPage\isStructuredFilterUiEnabled().

◆ getExtraOptions()

SpecialRecentChanges::getExtraOptions (   $opts)

Get options to be displayed in a form.

Parameters
FormOptions$opts
Returns
array

Reimplemented from ChangesListSpecialPage.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 685 of file SpecialRecentChanges.php.

References ChangeTags\buildTagFilterSelector(), SpecialPage\getContext(), SpecialPage\getHookRunner(), SpecialPage\getName(), and namespaceFilterForm().

Referenced by doHeader().

◆ getFeedQuery()

SpecialRecentChanges::getFeedQuery ( )
protected

Get URL query parameters for action=feedrecentchanges API feed of current recent changes view.

Returns
array

Definition at line 403 of file SpecialRecentChanges.php.

References SpecialPage\getConfig(), and ChangesListSpecialPage\getOptions().

Referenced by execute(), and outputFeedLinks().

◆ isIncludable()

SpecialRecentChanges::isIncludable ( )

Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override.

Returns
bool

Reimplemented from SpecialPage.

Definition at line 918 of file SpecialRecentChanges.php.

◆ makeOptionsLink()

SpecialRecentChanges::makeOptionsLink (   $title,
  $override,
  $options,
  $active = false 
)
private

Makes change an option link which carries all the other options.

Parameters
string$title
array$overrideOptions to override
array$optionsCurrent options
bool$activeWhether to show the link in bold
Returns
string

Definition at line 770 of file SpecialRecentChanges.php.

References $title, ChangesListSpecialPage\convertParamsForLink(), SpecialPage\getLinkRenderer(), and SpecialPage\getPageTitle().

Referenced by optionsPanel().

◆ namespaceFilterForm()

SpecialRecentChanges::namespaceFilterForm ( FormOptions  $opts)
protected

Creates the choose namespace selection.

Parameters
FormOptions$opts
Returns
string[]

Definition at line 736 of file SpecialRecentChanges.php.

References Xml\checkLabel(), Xml\label(), SpecialPage\msg(), Html\namespaceSelector(), and Html\rawElement().

Referenced by getExtraOptions().

◆ needsWatchlistFeatures()

SpecialRecentChanges::needsWatchlistFeatures ( )
private

Whether or not the current query needs to use watchlist data: check that the current user can use their watchlist and that this special page isn't being transcluded.

Returns
bool

Definition at line 192 of file SpecialRecentChanges.php.

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

Referenced by addWatchlistJoins(), and registerFilters().

◆ optionsPanel()

SpecialRecentChanges::optionsPanel (   $defaults,
  $nondefaults,
  $numRows 
)
private

Creates the options panel.

Parameters
array$defaults
array$nondefaults
int$numRowsNumber of rows in the result to show after this header
Returns
string

Definition at line 791 of file SpecialRecentChanges.php.

References $lang, SpecialPage\getConfig(), SpecialPage\getLanguage(), ChangesListSpecialPage\getLegacyShowHideFilters(), ChangesListSpecialPage\getLinkDays(), SpecialPage\getUser(), makeOptionsLink(), SpecialPage\msg(), Html\rawElement(), and wfTimestampNow().

Referenced by doHeader().

◆ outputChangesList()

◆ outputFeedLinks()

SpecialRecentChanges::outputFeedLinks ( )

Output feed links.

Reimplemented from ChangesListSpecialPage.

Definition at line 394 of file SpecialRecentChanges.php.

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

◆ parseParameters()

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

Process $par and put options found in $opts.

Used when including the page.

Parameters
string$par
FormOptions$opts

Reimplemented from ChangesListSpecialPage.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 259 of file SpecialRecentChanges.php.

◆ registerFilters()

SpecialRecentChanges::registerFilters ( )
protected

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

Reimplemented from ChangesListSpecialPage.

Definition at line 203 of file SpecialRecentChanges.php.

References ChangesListSpecialPage\getFilterGroup(), SpecialPage\getUser(), needsWatchlistFeatures(), and ChangesListSpecialPage\registerFiltersFromDefinitions().

◆ setTopText()

SpecialRecentChanges::setTopText ( FormOptions  $opts)

Send the text to be displayed above the options.

Parameters
FormOptions$optsUnused

Reimplemented from ChangesListSpecialPage.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 611 of file SpecialRecentChanges.php.

References $content, SpecialPage\getOutput(), SpecialPage\getRequest(), ChangesListSpecialPage\isStructuredFilterUiEnabled(), SpecialPage\msg(), and Html\rawElement().

Referenced by doHeader().

◆ transformFilterDefinition()

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

Definition at line 178 of file SpecialRecentChanges.php.

Member Data Documentation

◆ $collapsedPreferenceName

SpecialRecentChanges::$collapsedPreferenceName = 'rcfilters-rc-collapsed'
staticprotected

Definition at line 38 of file SpecialRecentChanges.php.

◆ $daysPreferenceName

SpecialRecentChanges::$daysPreferenceName = 'rcdays'
staticprotected

Definition at line 36 of file SpecialRecentChanges.php.

◆ $limitPreferenceName

SpecialRecentChanges::$limitPreferenceName = 'rcfilters-limit'
staticprotected

Definition at line 37 of file SpecialRecentChanges.php.

◆ $savedQueriesPreferenceName

SpecialRecentChanges::$savedQueriesPreferenceName = 'rcfilters-saved-queries'
staticprotected

Definition at line 35 of file SpecialRecentChanges.php.

◆ $watchlistFilterGroupDefinition

SpecialRecentChanges::$watchlistFilterGroupDefinition
private

Definition at line 40 of file SpecialRecentChanges.php.


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