MediaWiki REL1_28
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 ()
 
 doMainQuery ( $conds, $opts)
 Process the query.
 
 getDefaultOptions ()
 Get a FormOptions object containing the default options.
 
 getExtraOptions ( $opts)
 Get options to be displayed in a form.
 
 getTargetTitle ()
 
 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 SpecialRecentChanges
 __construct ( $name='Recentchanges', $restriction='')
 
 buildMainQueryConds (FormOptions $opts)
 Return an array of conditions depending of options set in $opts.
 
 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)
 Main execution point.
 
 filterByCategories (&$rows, FormOptions $opts)
 Filter $rows by categories set in $opts.
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
 
 makeOptionsLink ( $title, $override, $options, $active=false)
 Makes change an option link which carries all the other options.
 
 optionsPanel ( $defaults, $nondefaults, $numRows)
 Creates the options panel.
 
 outputChangesList ( $rows, $opts)
 Build and output the actual changes list.
 
 outputFeedLinks ()
 Output feed links.
 
 validateOptions (FormOptions $opts)
 Validate a FormOptions object generated by getDefaultOptions() with values already populated.
 
- Public Member Functions inherited from ChangesListSpecialPage
 getOptions ()
 Get the current FormOptions for this request.
 
 getRows ()
 Get the database result for this special page instance.
 
 makeLegend ()
 Return the legend displayed within the fieldset.
 
 setBottomText (FormOptions $opts)
 Send the text to be displayed after the options.
 
 setup ( $parameters)
 Create a FormOptions object with options as specified by the user.
 
 webOutput ( $rows, $opts)
 Send output to the OutputPage object, only called if not used feeds.
 
- 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.
 
 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.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 doesWrites ()
 Indicates whether this special page may perform database writes.
 
 getConfig ()
 Shortcut to get main config object.
 
 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 name of this Special Page.
 
 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.
 
 getSkin ()
 Shortcut to get the skin being used for this instance.
 
 getTitle ( $subpage=false)
 Get a self-referential title object.
 
 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.
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages.
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included.
 
 msg ()
 Wrapper around wfMessage that sets the current context.
 
 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.
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error.
 
 run ( $subPage)
 Entry point.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time.
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
 

Protected Attributes

bool Title $rclTargetTitle
 
- Protected Attributes inherited from ChangesListSpecialPage
array $customFilters
 
FormOptions $rcOptions
 
string $rcSubpage
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context.
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Additional Inherited Members

- 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.
 
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.
 
- Protected Member Functions inherited from SpecialRecentChanges
 addModules ()
 Add page-specific modules.
 
 categoryFilterForm (FormOptions $opts)
 Create an input to filter changes by categories.
 
 getCacheTTL ()
 
 getCustomFilters ()
 Get custom show/hide filters.
 
 getDB ()
 Return a IDatabase object for reading.
 
 getFeedQuery ()
 Get URL query parameters for action=feedrecentchanges API feed of current recent changes view.
 
 namespaceFilterForm (FormOptions $opts)
 Creates the choose namespace selection.
 
 runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)
 
- Protected Member Functions inherited from ChangesListSpecialPage
 fetchOptionsFromRequest ( $opts)
 Fetch values for a FormOptions object from the WebRequest associated with this instance.
 
 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'.
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 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.
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 
- 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).
 

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 (   $conds,
  $opts 
)

Process the query.

Parameters
array$conds
FormOptions$opts
Returns
bool|ResultWrapper Result or false (for Recentchangeslinked only)

Reimplemented from SpecialRecentChanges.

Definition at line 49 of file SpecialRecentchangeslinked.php.

References $dbr, $limit, $query, $res, $tables, $title, as, DB_REPLICA, SpecialPage\getOutput(), SpecialPage\getUser(), ChangeTags\modifyDisplayQuery(), SpecialPage\msg(), NS_CATEGORY, NS_FILE, SpecialRecentChanges\runMainQueryHook(), RecentChange\selectFields(), and wfGetDB().

◆ getDefaultOptions()

SpecialRecentChangesLinked::getDefaultOptions ( )

Get a FormOptions object containing the default options.

Returns
FormOptions

Reimplemented from SpecialRecentChanges.

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 237 of file SpecialRecentchangeslinked.php.

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

◆ getTargetTitle()

SpecialRecentChangesLinked::getTargetTitle ( )
Returns
Title

Definition at line 254 of file SpecialRecentchangeslinked.php.

References $rclTargetTitle, and ChangesListSpecialPage\getOptions().

Referenced by setTopText().

◆ 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 275 of file SpecialRecentchangeslinked.php.

References $limit, and 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 223 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: