MediaWiki  1.23.14
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='')
 
 buildMainQueryConds (FormOptions $opts)
 Return an array of conditions depending of options set in $opts. More...
 
 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...
 
 doMainQuery ( $conds, $opts)
 Process the query. More...
 
 execute ( $subpage)
 Main execution point. More...
 
 filterByCategories (&$rows, FormOptions $opts)
 Filter $rows by categories set in $opts. More...
 
 getDefaultOptions ()
 Get a FormOptions object containing the default options. 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}}. More...
 
 makeOptionsLink ( $title, $override, $options, $active=false)
 Makes change an option link which carries all the other options. More...
 
 optionsPanel ( $defaults, $nondefaults)
 Creates the options panel. 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...
 
 validateOptions (FormOptions $opts)
 Validate a FormOptions object generated by getDefaultOptions() with values already populated. More...
 
- Public Member Functions inherited from ChangesListSpecialPage
 getOptions ()
 Get the current FormOptions for this request. More...
 
 getRows ()
 Get the database result for this special page instance. More...
 
 setBottomText (FormOptions $opts)
 Send the text to be displayed after the options. More...
 
 setup ( $parameters)
 Create a FormOptions object with options as specified by the user. 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='default', $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...
 
 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...
 
 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...
 
 getFile ()
 Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. 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...
 
 getLang ()
 Shortcut to get user's language. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 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...
 
 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...
 
 msg ()
 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...
 
 requireLogin ( $reasonMsg=null, $titleMsg=null)
 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...
 
 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...
 
 categoryFilterForm (FormOptions $opts)
 Create a input to filter changes by categories. More...
 
 getCustomFilters ()
 Get custom show/hide filters. More...
 
 namespaceFilterForm (FormOptions $opts)
 Creates the choose namespace selection. More...
 
- Protected Member Functions inherited from ChangesListSpecialPage
 fetchOptionsFromRequest ( $opts)
 Fetch values for a FormOptions object from the WebRequest associated with this instance. More...
 
 getDB ()
 Return a DatabaseBase object for reading. 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...
 
- 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...
 
 getRobotPolicy ()
 Return the robot policy. More...
 

Private Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from ChangesListSpecialPage
static makeLegend (IContextSource $context)
 Return the legend displayed within the fieldset. 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. More...
 
- Protected Attributes inherited from ChangesListSpecialPage
array $customFilters
 
FormOptions $rcOptions
 
string $rcSubpage
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 

Detailed Description

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

Definition at line 29 of file SpecialRecentchanges.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 31 of file SpecialRecentchanges.php.

References $name.

Member Function Documentation

◆ addModules()

SpecialRecentChanges::addModules ( )
protected

Add page-specific modules.

Reimplemented from ChangesListSpecialPage.

Definition at line 483 of file SpecialRecentchanges.php.

References $out, and SpecialPage\getOutput().

◆ buildMainQueryConds()

SpecialRecentChanges::buildMainQueryConds ( FormOptions  $opts)

Return an array of conditions depending of options set in $opts.

Parameters
FormOptions$opts
Returns
array

Reimplemented from ChangesListSpecialPage.

Definition at line 166 of file SpecialRecentchanges.php.

References $dbr, ChangesListSpecialPage\getDB(), FormOptions\reset(), TS_MW, and wfTimestamp().

◆ categoryFilterForm()

SpecialRecentChanges::categoryFilterForm ( FormOptions  $opts)
protected

Create a input to filter changes by categories.

Parameters
FormOptions$opts
Returns
array

Definition at line 535 of file SpecialRecentchanges.php.

References array(), Xml\checkLabel(), Xml\inputLabelSep(), list, SpecialPage\msg(), and text.

Referenced by getExtraOptions().

◆ 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 496 of file SpecialRecentchanges.php.

References $dbr, and ChangesListSpecialPage\getDB().

Referenced by execute().

◆ doHeader()

SpecialRecentChanges::doHeader (   $opts,
  $numRows 
)

◆ doMainQuery()

SpecialRecentChanges::doMainQuery (   $conds,
  $opts 
)

Process the query.

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

Reimplemented from ChangesListSpecialPage.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 194 of file SpecialRecentchanges.php.

References $dbr, $tables, $user, array(), filterByCategories(), ChangesListSpecialPage\getDB(), SpecialPage\getUser(), global, ChangeTags\modifyDisplayQuery(), RecentChange\selectFields(), and wfRunHooks().

◆ execute()

SpecialRecentChanges::execute (   $subpage)

Main execution point.

Parameters
string$subpage

Reimplemented from ChangesListSpecialPage.

Definition at line 41 of file SpecialRecentchanges.php.

References $query, checkLastModified(), execute(), getFeedQuery(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\including(), wfAppendQuery(), and wfScript().

◆ filterByCategories()

SpecialRecentChanges::filterByCategories ( $rows,
FormOptions  $opts 
)

Filter $rows by categories set in $opts.

Parameters
ResultWrapper$rowsDatabase rows
FormOptions$opts

Definition at line 551 of file SpecialRecentchanges.php.

References $rev, array(), as, Title\makeTitle(), and Categoryfinder\seed().

Referenced by doMainQuery().

◆ getCustomFilters()

SpecialRecentChanges::getCustomFilters ( )
protected

Get custom show/hide filters.

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

Reimplemented from ChangesListSpecialPage.

Definition at line 95 of file SpecialRecentchanges.php.

References ChangesListSpecialPage\$customFilters, array(), and wfRunHooks().

Referenced by optionsPanel().

◆ getDefaultOptions()

SpecialRecentChanges::getDefaultOptions ( )

Get a FormOptions object containing the default options.

Returns
FormOptions

Reimplemented from ChangesListSpecialPage.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 68 of file SpecialRecentchanges.php.

References $user, and SpecialPage\getUser().

◆ 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 454 of file SpecialRecentchanges.php.

References array(), ChangeTags\buildTagFilterSelector(), categoryFilterForm(), SpecialPage\getName(), global, namespaceFilterForm(), and wfRunHooks().

Referenced by doHeader().

◆ getFeedQuery()

SpecialRecentChanges::getFeedQuery ( )
private

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

Returns
array

Definition at line 267 of file SpecialRecentchanges.php.

References $query, $value, ChangesListSpecialPage\getOptions(), and global.

Referenced by execute(), and outputFeedLinks().

◆ isIncludable()

SpecialRecentChanges::isIncludable ( )

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

Returns
bool

Reimplemented from SpecialPage.

Definition at line 746 of file SpecialRecentchanges.php.

◆ makeOptionsLink()

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

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

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

Definition at line 618 of file SpecialRecentchanges.php.

References $options, $params, $title, $value, array(), as, SpecialPage\getPageTitle(), and Linker\linkKnown().

Referenced by optionsPanel().

◆ namespaceFilterForm()

SpecialRecentChanges::namespaceFilterForm ( FormOptions  $opts)
protected

Creates the choose namespace selection.

Parameters
FormOptions$opts
Returns
string

Definition at line 509 of file SpecialRecentchanges.php.

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

Referenced by getExtraOptions().

◆ optionsPanel()

SpecialRecentChanges::optionsPanel (   $defaults,
  $nondefaults 
)

Creates the options panel.

Parameters
array$defaults
array$nondefaults
Returns
string

Definition at line 645 of file SpecialRecentchanges.php.

References $link, $options, $params, $timestamp, $user, $value, array(), as, getCustomFilters(), SpecialPage\getLanguage(), SpecialPage\getUser(), global, makeOptionsLink(), SpecialPage\msg(), and wfTimestampNow().

Referenced by doHeader().

◆ outputChangesList()

SpecialRecentChanges::outputChangesList (   $rows,
  $opts 
)

Build and output the actual changes list.

Parameters
array$rowsDatabase rows
FormOptions$opts

Reimplemented from ChangesListSpecialPage.

Definition at line 287 of file SpecialRecentchanges.php.

References $dbr, $limit, array(), as, SpecialPage\getContext(), ChangesListSpecialPage\getDB(), SpecialPage\getOutput(), SpecialPage\getUser(), global, SpecialPage\msg(), ChangesList\newFromContext(), and RecentChange\newFromRow().

◆ outputFeedLinks()

SpecialRecentChanges::outputFeedLinks ( )

Output feed links.

Reimplemented from ChangesListSpecialPage.

Definition at line 258 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 110 of file SpecialRecentchanges.php.

References array(), and as.

◆ 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 432 of file SpecialRecentchanges.php.

References $wgContLang, array(), SpecialPage\getOutput(), global, SpecialPage\msg(), and Html\rawElement().

Referenced by doHeader().

◆ validateOptions()

SpecialRecentChanges::validateOptions ( FormOptions  $opts)

Validate a FormOptions object generated by getDefaultOptions() with values already populated.

Parameters
FormOptions$opts

Reimplemented from ChangesListSpecialPage.

Definition at line 155 of file SpecialRecentchanges.php.

References FormOptions\validateIntBounds().


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