MediaWiki master
MediaWiki\Specials\SpecialRecentChangesLinked Class Reference

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

Inherits MediaWiki\Specials\SpecialRecentChanges.

Collaboration diagram for MediaWiki\Specials\SpecialRecentChangesLinked:

Public Member Functions

 __construct (WatchedItemStoreInterface $watchedItemStore, MessageCache $messageCache, UserOptionsLookup $userOptionsLookup, SearchEngineFactory $searchEngineFactory, ChangeTagsStore $changeTagsStore, UserIdentityUtils $userIdentityUtils, TempUserConfig $tempUserConfig)
 
 getDefaultOptions ()
 Get a FormOptions object containing the default options.
 
 getExtraOptions ( $opts)
 Get options to be displayed in a form.
 
 parseParameters ( $par, FormOptions $opts)
 Process $par and put options found in $opts.
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept.
 
 setTopText (FormOptions $opts)
 Send the text to be displayed above the options.
 
- Public Member Functions inherited from MediaWiki\Specials\SpecialRecentChanges
 __construct (WatchedItemStoreInterface $watchedItemStore=null, MessageCache $messageCache=null, UserOptionsLookup $userOptionsLookup=null, ChangeTagsStore $changeTagsStore=null, UserIdentityUtils $userIdentityUtils=null, TempUserConfig $tempUserConfig=null)
 
 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.
 
 doHeader ( $opts, $numRows)
 Set the text to be displayed above the changes.
 
 execute ( $subpage)
 
 getDefaultLimit ()
 Get the default value of the number of changes to display when loading the result set.
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
 
 outputChangesList ( $rows, $opts)
 Build and output the actual changes list.
 
 outputFeedLinks ()
 
- Public Member Functions inherited from MediaWiki\SpecialPage\ChangesListSpecialPage
 __construct ( $name, $restriction, UserIdentityUtils $userIdentityUtils, TempUserConfig $tempUserConfig)
 
 filterOnUserExperienceLevel ( $specialPageClassName, $context, $dbr, &$tables, &$fields, &$conds, &$query_options, &$join_conds, $selectedExpLevels, $now=0)
 Filter on users' experience levels; this will not be called if nothing is selected.
 
 getDefaultDays ()
 Get the default value of the number of days to display when loading the result set.
 
 getFilterGroup ( $groupName)
 Gets a specified ChangesListFilterGroup by name.
 
 getOptions ()
 Get the current FormOptions for this request.
 
 getRows ()
 Get the database result for this special page instance.
 
 getStructuredFilterJsData ()
 Gets structured filter information needed by JS.
 
 isStructuredFilterUiEnabled ()
 Check whether the structured filter UI is enabled.
 
 makeLegend ()
 Return the legend displayed within the fieldset.
 
 registerFilterGroup (ChangesListFilterGroup $group)
 Register a structured changes list filter group.
 
 replaceOldOptions (FormOptions $opts)
 Replace old options with their structured UI equivalents.
 
 setBottomText (FormOptions $opts)
 Send the text to be displayed after the options.
 
 setTempUserConfig (TempUserConfig $tempUserConfig)
 Set the temp user config.
 
 setup ( $parameters)
 Register all the filters, including legacy hook-driven ones.
 
 validateOptions (FormOptions $opts)
 Validate a FormOptions object generated by getDefaultOptions() with values already populated.
 
 webOutput ( $rows, $opts)
 Send output to the OutputPage object, only called if not used feeds.
 
- Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators.
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError.
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError.
 
 doesWrites ()
 Indicates whether this special page may perform database writes.
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContentLanguage ()
 Shortcut to get content language.
 
 getContext ()
 Gets the context this SpecialPage is executed in.
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.
 
 getFullTitle ()
 Return the full title, including $par.
 
 getLanguage ()
 Shortcut to get user's language.
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page.
 
 getName ()
 Get the canonical, unlocalized name of this special page without namespace.
 
 getOutput ()
 Get the OutputPage being used for this instance.
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object.
 
 getRequest ()
 Get the WebRequest being used for this instance.
 
 getRestriction ()
 Get the permission that a user must have to execute this page.
 
 getShortDescription (string $path='')
 Similar to getDescription but takes into account sub pages and designed for display in tabs.
 
 getSkin ()
 Shortcut to get the skin being used for this instance.
 
 getUser ()
 Shortcut to get the User executing this instance.
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion.
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode.
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages.
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes.
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included.
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context.
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error.
 
 requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in or is a temporary user, throws UserNotLoggedIn.
 
 run ( $subPage)
 Entry point.
 
 setContentLanguage (Language $contentLanguage)
 Set content language.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
 

Protected Member Functions

 doMainQuery ( $tables, $select, $conds, $query_options, $join_conds, FormOptions $opts)
 FIXME: Port useful changes from SpecialRecentChanges.
 
 outputNoResults ()
 Add the "no results" message to the output.
 
- Protected Member Functions inherited from MediaWiki\Specials\SpecialRecentChanges
 addWatchlistJoins (IReadableDatabase $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.
 
 getCacheTTL ()
 
 getCollapsedPreferenceName ()
 
 getDefaultDaysPreferenceName ()
 
 getFeedQuery ()
 Get URL query parameters for action=feedrecentchanges API feed of current recent changes view.
 
 getLimitPreferenceName ()
 
 getSavedQueriesPreferenceName ()
 
 isDenseTagFilter ( $tagIds, $limit)
 Determine whether a tag filter matches a high proportion of the rows in recentchanges.
 
 namespaceFilterForm (FormOptions $opts)
 Creates the choose namespace selection.
 
 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).
 
 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

 
- Protected Member Functions inherited from MediaWiki\SpecialPage\ChangesListSpecialPage
 addModules ()
 Add page-specific modules.
 
 areFiltersInConflict ()
 Check if filters are in conflict and guaranteed to return no results.
 
 buildQuery (&$tables, &$fields, &$conds, &$query_options, &$join_conds, FormOptions $opts)
 Sets appropriate tables, fields, conditions, etc.
 
 considerActionsForDefaultSavedQuery ( $subpage)
 Check whether or not the page should load defaults, and if so, whether a default saved query is relevant to be redirected to.
 
 convertParamsForLink ( $params)
 Convert parameters values from true/false to 1/0 so they are not omitted by wfArrayToCgi() T38524.
 
 fetchOptionsFromRequest ( $opts)
 Fetch values for a FormOptions object from the WebRequest associated with this instance.
 
 getDB ()
 Which database to use for read queries.
 
 getFilterGroups ()
 Gets the currently registered filters groups.
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.
 
 getLegacyShowHideFilters ()
 
 getLinkDays ()
 
 includeRcFiltersApp ()
 Include the modules and configuration for the RCFilters app.
 
 outputTimeout ()
 Add the "timeout" message to the output.
 
 registerFiltersFromDefinitions (array $definition)
 Register filters from a definition object.
 
 runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 authorizeAction (?string $action=null)
 Utility function for authorizing an action to be performed by the special page.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 getAuthManager ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.
 
 getRobotPolicy ()
 Return the robot policy.
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e.
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages.
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Protected Attributes

bool Title $rclTargetTitle
 
- Protected Attributes inherited from MediaWiki\SpecialPage\ChangesListSpecialPage
ChangesListFilterGroup[] $filterGroups = []
 Filter groups, and their contained filters This is an associative array (with group name as key) of ChangesListFilterGroup objects.
 
FormOptions $rcOptions
 
string $rcSubpage
 
TempUserConfig $tempUserConfig
 
UserIdentityUtils $userIdentityUtils
 
- Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
bool $mIncluding
 Whether or not this special page is being included from an article.
 
string $mName
 The canonical name of this special page Also used as the message key for the default.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\SpecialPage\ChangesListSpecialPage
static checkStructuredFilterUiEnabled (UserIdentity $user)
 Static method to check whether StructuredFilter UI is enabled for the given user.
 
static getRcFiltersConfigSummary (RL\Context $context)
 Get essential data about getRcFiltersConfigVars() for change detection.
 
static getRcFiltersConfigVars (RL\Context $context)
 Get config vars to export with the mediawiki.rcfilters.filters.ui module.
 
- Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage.
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name.
 
static newSearchPage (User $user)
 Get the users preferred search page.
 
- Public Attributes inherited from MediaWiki\Specials\SpecialRecentChanges
int $denseRcSizeThreshold = 10000
 
- Static Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).
 

Detailed Description

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

Definition at line 47 of file SpecialRecentChangesLinked.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialRecentChangesLinked::__construct ( WatchedItemStoreInterface $watchedItemStore,
MessageCache $messageCache,
UserOptionsLookup $userOptionsLookup,
SearchEngineFactory $searchEngineFactory,
ChangeTagsStore $changeTagsStore,
UserIdentityUtils $userIdentityUtils,
TempUserConfig $tempUserConfig )
Parameters
WatchedItemStoreInterface$watchedItemStore
MessageCache$messageCache
UserOptionsLookup$userOptionsLookup
SearchEngineFactory$searchEngineFactory

Definition at line 60 of file SpecialRecentChangesLinked.php.

References MediaWiki\SpecialPage\ChangesListSpecialPage\$tempUserConfig, and MediaWiki\SpecialPage\ChangesListSpecialPage\$userIdentityUtils.

Member Function Documentation

◆ doMainQuery()

MediaWiki\Specials\SpecialRecentChangesLinked::doMainQuery ( $tables,
$select,
$conds,
$query_options,
$join_conds,
FormOptions $opts )
protected

FIXME: Port useful changes from SpecialRecentChanges.

Process the query.

Parameters
array$tablesArray of tables; see IReadableDatabase::select $table
array$fieldsArray of fields; see IReadableDatabase::select $vars
array$condsArray of conditions; see IReadableDatabase::select $conds
array$query_optionsArray of query options; see IReadableDatabase::select $options
array$join_condsArray of join conditions; see IReadableDatabase::select $join_conds
FormOptions$opts
Returns
bool|IResultWrapper Result or false

Reimplemented from MediaWiki\Specials\SpecialRecentChanges.

Definition at line 99 of file SpecialRecentChangesLinked.php.

References MediaWiki\Specials\SpecialRecentChanges\addWatchlistJoins(), MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\SpecialPage\ChangesListSpecialPage\getDB(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\MainConfigNames\MaxExecutionTimeForExpensiveQueries, MediaWiki\SpecialPage\SpecialPage\msg(), NS_CATEGORY, NS_FILE, and MediaWiki\SpecialPage\ChangesListSpecialPage\runMainQueryHook().

◆ getDefaultOptions()

MediaWiki\Specials\SpecialRecentChangesLinked::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 from MediaWiki\SpecialPage\ChangesListSpecialPage.

Definition at line 82 of file SpecialRecentChangesLinked.php.

◆ getExtraOptions()

MediaWiki\Specials\SpecialRecentChangesLinked::getExtraOptions ( $opts)

Get options to be displayed in a form.

Parameters
FormOptions$opts
Returns
array

Reimplemented from MediaWiki\Specials\SpecialRecentChanges.

Definition at line 327 of file SpecialRecentChangesLinked.php.

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

◆ outputNoResults()

MediaWiki\Specials\SpecialRecentChangesLinked::outputNoResults ( )
protected

Add the "no results" message to the output.

Reimplemented from MediaWiki\SpecialPage\ChangesListSpecialPage.

Definition at line 369 of file SpecialRecentChangesLinked.php.

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

◆ parseParameters()

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

Definition at line 90 of file SpecialRecentChangesLinked.php.

◆ prefixSearchSubpages()

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

Definition at line 365 of file SpecialRecentChangesLinked.php.

References MediaWiki\SpecialPage\SpecialPage\prefixSearchString().

◆ setTopText()

MediaWiki\Specials\SpecialRecentChangesLinked::setTopText ( FormOptions $opts)

Send the text to be displayed above the options.

Parameters
FormOptions$optsUnused

Reimplemented from MediaWiki\Specials\SpecialRecentChanges.

Definition at line 313 of file SpecialRecentChangesLinked.php.

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

Member Data Documentation

◆ $rclTargetTitle

bool Title MediaWiki\Specials\SpecialRecentChangesLinked::$rclTargetTitle
protected

Definition at line 49 of file SpecialRecentChangesLinked.php.


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