MediaWiki  REL1_22
SpecialRecentChanges Class Reference

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

Inheritance diagram for SpecialRecentChanges:
Collaboration diagram for SpecialRecentChanges:

List of all members.

Public Member Functions

 __construct ($name= 'Recentchanges')
 buildMainQueryConds (FormOptions $opts)
 Return an array of conditions depending of options set in $opts.
 checkLastModified ($feedFormat)
 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)
 Return the text to be displayed above the changes.
 doMainQuery ($conds, $opts)
 Process the query.
 execute ($subpage)
 Main execution point.
 feedSetup ()
 Create a FormOptions object specific for feed requests and return it.
 filterByCategories (&$rows, FormOptions $opts)
 Filter $rows by categories set in $opts.
 getDefaultOptions ()
 Get a FormOptions object containing the default options.
 getExtraOptions ($opts)
 Get options to be displayed in a form.
 getFeedObject ($feedFormat)
 Return an array with a ChangesFeed object and ChannelFeed object.
 getFeedQuery ()
 Get the query string to append to feed link URLs.
 getOptions ()
 Get the current FormOptions for this request.
 makeOptionsLink ($title, $override, $options, $active=false)
 Makes change an option link which carries all the other options.
 optionsPanel ($defaults, $nondefaults)
 Creates the options panel.
 parseParameters ($par, FormOptions $opts)
 Process $par and put options found if $opts Mainly used when including the page.
 setBottomText (FormOptions $opts)
 Send the text to be displayed after the options, for use in subclasses.
 setTopText (FormOptions $opts)
 Send the text to be displayed above 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 Attributes

 $rcOptions
 $rcSubpage

Protected Member Functions

 addModules ()
 Add page-specific modules.
 categoryFilterForm (FormOptions $opts)
 Create a input to filter changes by categories.
 getCustomFilters ()
 Get custom show/hide filters.
 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'.
 namespaceFilterForm (FormOptions $opts)
 Creates the choose namespace selection.

Protected Attributes

 $customFilters

Detailed Description

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

Definition at line 29 of file SpecialRecentchanges.php.


Constructor & Destructor Documentation

SpecialRecentChanges::__construct ( name = 'Recentchanges')

Definition at line 33 of file SpecialRecentchanges.php.

References $name.


Member Function Documentation

Add page-specific modules.

Definition at line 917 of file SpecialRecentchanges.php.

References array(), and SpecialPage\getOutput().

Referenced by execute().

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

Parameters:
FormOptions$opts
Returns:
array

Definition at line 287 of file SpecialRecentchanges.php.

References $dbr, array(), MWNamespace\getAssociated(), SpecialPage\getName(), SpecialPage\getUser(), FormOptions\reset(), wfGetDB(), and wfTimestamp().

Referenced by execute().

Create a input to filter changes by categories.

Parameters:
FormOptions$opts
Returns:
array

Definition at line 718 of file SpecialRecentchanges.php.

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

Referenced by getExtraOptions().

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.

Parameters:
string$feedFormat
Returns:
string|bool

Definition at line 268 of file SpecialRecentchanges.php.

References $dbr, SpecialPage\getOutput(), SpecialPage\getUser(), and wfGetDB().

Referenced by execute().

SpecialRecentChanges::doMainQuery ( conds,
opts 
)

Process the query.

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

Reimplemented in SpecialRecentchangeslinked.

Definition at line 381 of file SpecialRecentchanges.php.

References $dbr, $limit, array(), SpecialPage\getUser(), ChangeTags\modifyDisplayQuery(), RecentChange\selectFields(), wfGetDB(), and wfRunHooks().

Referenced by execute().

Create a FormOptions object specific for feed requests and return it.

Returns:
FormOptions

Reimplemented in SpecialRecentchangeslinked.

Definition at line 113 of file SpecialRecentchanges.php.

References getDefaultOptions(), SpecialPage\getRequest(), and global.

Referenced by getOptions().

Filter $rows by categories set in $opts.

Parameters:
array$rowsDatabase rows
FormOptions$opts

Definition at line 734 of file SpecialRecentchanges.php.

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

Referenced by webOutput().

Get custom show/hide filters.

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

Definition at line 99 of file SpecialRecentchanges.php.

References array(), and wfRunHooks().

Referenced by optionsPanel(), and setup().

Get a FormOptions object containing the default options.

Returns:
FormOptions

Reimplemented in SpecialRecentchangeslinked.

Definition at line 42 of file SpecialRecentchanges.php.

References $user, SpecialPage\getUser(), and FormOptions\INTNULL.

Referenced by feedSetup(), and setup().

Get options to be displayed in a form.

Parameters:
FormOptions$opts
Returns:
array

Reimplemented in SpecialRecentchangeslinked.

Definition at line 630 of file SpecialRecentchanges.php.

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

Referenced by doHeader().

Return an array with a ChangesFeed object and ChannelFeed object.

Parameters:
string$feedFormatFeed's format (either 'rss' or 'atom')
Returns:
array

Reimplemented in SpecialRecentchangeslinked.

Definition at line 197 of file SpecialRecentchanges.php.

References array(), SpecialPage\getTitle(), SpecialPage\msg(), and text.

Referenced by execute().

Get the query string to append to feed link URLs.

Returns:
string

Definition at line 533 of file SpecialRecentchanges.php.

References $options, $value, as, getOptions(), global, and wfArrayToCgi().

Referenced by webOutput().

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns:
string
Since:
1.21

Reimplemented from SpecialPage.

Definition at line 923 of file SpecialRecentchanges.php.

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

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

Referenced by optionsPanel().

Creates the choose namespace selection.

Todo:
Uses radio buttons (HASHAR)
Parameters:
FormOptions$opts
Returns:
string

Definition at line 692 of file SpecialRecentchanges.php.

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

Referenced by getExtraOptions().

SpecialRecentChanges::optionsPanel ( defaults,
nondefaults 
)

Creates the options panel.

Parameters:
array$defaults
array$nondefaults
Returns:
string

Definition at line 828 of file SpecialRecentchanges.php.

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

Referenced by doHeader().

Process $par and put options found if $opts Mainly used when including the page.

Parameters:
string$par
FormOptions$opts

Reimplemented in SpecialRecentchangeslinked.

Definition at line 215 of file SpecialRecentchanges.php.

References array(), and as.

Referenced by setup().

Send the text to be displayed after the options, for use in subclasses.

Parameters:
FormOptions$opts

Definition at line 682 of file SpecialRecentchanges.php.

Referenced by doHeader().

Send the text to be displayed above the options.

Parameters:
FormOptions$optsUnused

Reimplemented in SpecialRecentchangeslinked.

Definition at line 661 of file SpecialRecentchanges.php.

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

Referenced by doHeader().

SpecialRecentChanges::setup ( parameters)

Create a FormOptions object with options as specified by the user.

Parameters:
array$parameters
Returns:
FormOptions

Definition at line 75 of file SpecialRecentchanges.php.

References $key, $params, as, getCustomFilters(), getDefaultOptions(), SpecialPage\getRequest(), and parseParameters().

Referenced by getOptions().

SpecialRecentChanges::webOutput ( rows,
opts 
)

Send output to the OutputPage object, only called if not used feeds.

Parameters:
array$rowsDatabase rows
FormOptions$opts

Definition at line 446 of file SpecialRecentchanges.php.

References $dbr, $limit, array(), as, doHeader(), empty, filterByCategories(), SpecialPage\getContext(), getFeedQuery(), SpecialPage\getOutput(), SpecialPage\getUser(), global, SpecialPage\including(), ChangesList\newFromContext(), RecentChange\newFromRow(), and wfGetDB().

Referenced by execute().


Member Data Documentation

SpecialRecentChanges::$customFilters [protected]

Definition at line 31 of file SpecialRecentchanges.php.

SpecialRecentChanges::$rcOptions

Definition at line 30 of file SpecialRecentchanges.php.

SpecialRecentChanges::$rcSubpage

Definition at line 30 of file SpecialRecentchanges.php.


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