MediaWiki  master
SpecialRecentChangesLinked Class Reference

This is to display changes made to all articles linked in an article. More...

Inheritance diagram for SpecialRecentChangesLinked:
Collaboration diagram for SpecialRecentChangesLinked:

Public Member Functions

 __construct ()
 
 getDefaultOptions ()
 Get a FormOptions object containing the default options. More...
 
 getExtraOptions ( $opts)
 Get options to be displayed in a form. More...
 
 parseParameters ( $par, FormOptions $opts)
 Process $par and put options found in $opts. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 setTopText (FormOptions $opts)
 Send the text to be displayed above the options. More...
 
- Public Member Functions inherited from SpecialRecentChanges
 __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...
 
 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...
 
- 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...
 
 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...
 
 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

 doMainQuery ( $tables, $select, $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...
 
 outputNoResults ()
 Add the "no results" message to the output. More...
 
- Protected Member Functions inherited from SpecialRecentChanges
 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...
 
 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...
 
 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...
 

Protected Attributes

bool Title $rclTargetTitle
 
- 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
 

Private Member Functions

 getTargetTitle ()
 

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...
 
- Static Protected Attributes inherited from SpecialRecentChanges
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...
 

Detailed Description

This is to display changes made to all articles linked in an article.

Definition at line 29 of file SpecialRecentChangesLinked.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialRecentChangesLinked::__construct ( )

Definition at line 33 of file SpecialRecentChangesLinked.php.

Member Function Documentation

◆ doMainQuery()

SpecialRecentChangesLinked::doMainQuery (   $tables,
  $select,
  $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 SpecialRecentChanges.

Definition at line 52 of file SpecialRecentChangesLinked.php.

References $dbr, $title, SpecialRecentChanges\addWatchlistJoins(), DB_REPLICA, Html\errorBox(), SpecialPage\getOutput(), RecentChange\getQueryInfo(), ChangeTags\modifyDisplayQuery(), SpecialPage\msg(), Title\newFromText(), NS_CATEGORY, NS_FILE, ChangesListSpecialPage\runMainQueryHook(), and wfGetDB().

◆ getDefaultOptions()

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

Definition at line 37 of file SpecialRecentChangesLinked.php.

◆ getExtraOptions()

SpecialRecentChangesLinked::getExtraOptions (   $opts)

Get options to be displayed in a form.

Parameters
FormOptions$opts
Returns
array

Reimplemented from SpecialRecentChanges.

Definition at line 240 of file SpecialRecentChangesLinked.php.

References SpecialPage\addHelpLink(), Xml\check(), Xml\input(), Xml\label(), and SpecialPage\msg().

◆ getTargetTitle()

SpecialRecentChangesLinked::getTargetTitle ( )
private

◆ outputNoResults()

SpecialRecentChangesLinked::outputNoResults ( )
protected

Add the "no results" message to the output.

Reimplemented from ChangesListSpecialPage.

Definition at line 282 of file SpecialRecentChangesLinked.php.

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

◆ parseParameters()

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

Process $par and put options found in $opts.

Used when including the page.

Parameters
string$par
FormOptions$opts

Reimplemented from SpecialRecentChanges.

Definition at line 45 of file SpecialRecentChangesLinked.php.

◆ prefixSearchSubpages()

SpecialRecentChangesLinked::prefixSearchSubpages (   $search,
  $limit,
  $offset 
)

Return an array of subpages beginning with $search that this special page will accept.

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 278 of file SpecialRecentChangesLinked.php.

References SpecialPage\prefixSearchString().

◆ setTopText()

SpecialRecentChangesLinked::setTopText ( FormOptions  $opts)

Send the text to be displayed above the options.

Parameters
FormOptions$optsUnused

Reimplemented from SpecialRecentChanges.

Definition at line 226 of file SpecialRecentChangesLinked.php.

References SpecialPage\getOutput(), SpecialPage\getSkin(), and getTargetTitle().

Member Data Documentation

◆ $rclTargetTitle

bool Title SpecialRecentChangesLinked::$rclTargetTitle
protected

Definition at line 31 of file SpecialRecentChangesLinked.php.

Referenced by getTargetTitle().


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