SpecialRecentChanges Class Reference
[SpecialPage]

Implements Special:Recentchanges. More...

Inherits SpecialPage.

List of all members.

Public Member Functions

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

Public Attributes

 $rcOptions
 $rcSubpage

Protected Member Functions

 namespaceFilterForm (FormOptions $opts)
 Creates the choose namespace selection.
 categoryFilterForm (FormOptions $opts)
 Create a input to filter changes by categories.


Detailed Description

Implements Special:Recentchanges.

Definition at line 7 of file SpecialRecentchanges.php.


Constructor & Destructor Documentation

SpecialRecentChanges::__construct (  ) 

Definition at line 10 of file SpecialRecentchanges.php.

References SpecialPage::includable().


Member Function Documentation

SpecialRecentChanges::buildMainQueryConds ( FormOptions opts  ) 

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

Parameters:
$opts FormOptions
Returns:
array

Definition at line 210 of file SpecialRecentchanges.php.

References $dbr, $wgUser, FormOptions::reset(), wfGetDB(), and wfTimestamp().

Referenced by execute().

SpecialRecentChanges::categoryFilterForm ( FormOptions opts  )  [protected]

Create a input to filter changes by categories.

Parameters:
$opts FormOptions
Returns:
array

Definition at line 549 of file SpecialRecentchanges.php.

References $input, Xml::checkLabel(), Xml::inputLabelSep(), and wfMsg().

Referenced by getExtraOptions().

SpecialRecentChanges::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.

Parameters:
$feedFormat String
Returns:
string or false

Definition at line 191 of file SpecialRecentchanges.php.

References $dbr, $wgOut, $wgUseRCPatrol, and wfGetDB().

Referenced by execute().

SpecialRecentChanges::doHeader ( opts  ) 

Return the text to be displayed above the changes.

Parameters:
$opts FormOptions
Returns:
String: XHTML

Definition at line 433 of file SpecialRecentchanges.php.

References $defaults, $out, $t, $wgOut, $wgScript, Xml::closeElement(), Xml::fieldset(), ChangesList::flagLegend(), getExtraOptions(), SpecialPage::getTitle(), Xml::hidden(), Xml::openElement(), optionsPanel(), setBottomText(), setTopText(), Xml::tags(), and wfMsg().

Referenced by execute(), and webOutput().

SpecialRecentChanges::doMainQuery ( conds,
opts 
)

Process the query.

Parameters:
$conds array
$opts FormOptions
Returns:
database result or false (for Recentchangeslinked only)

Definition at line 282 of file SpecialRecentchanges.php.

References $dbr, $res, $wgUser, ChangeTags::modifyDisplayQuery(), wfGetDB(), and wfRunHooks().

Referenced by execute().

SpecialRecentChanges::execute ( subpage  ) 

SpecialRecentChanges::feedSetup (  ) 

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

Returns:
FormOptions

Definition at line 69 of file SpecialRecentchanges.php.

References $wgFeedLimit, $wgRequest, and getDefaultOptions().

Referenced by getOptions().

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

Filter $rows by categories set in $opts.

Parameters:
$rows array of database rows
$opts FormOptions

Definition at line 565 of file SpecialRecentchanges.php.

References $rows, and Title::makeTitle().

Referenced by webOutput().

SpecialRecentChanges::getDefaultOptions (  ) 

Get a FormOptions object containing the default options.

Returns:
FormOptions

Definition at line 20 of file SpecialRecentchanges.php.

References $wgUser, and FormOptions::INTNULL.

Referenced by feedSetup(), and setup().

SpecialRecentChanges::getExtraOptions ( opts  ) 

Get options to be displayed in a form.

Parameters:
$opts FormOptions
Returns:
array

Definition at line 494 of file SpecialRecentchanges.php.

References $wgAllowCategorizedRecentChanges, ChangeTags::buildTagFilterSelector(), categoryFilterForm(), namespaceFilterForm(), and wfRunHooks().

Referenced by doHeader().

SpecialRecentChanges::getFeedObject ( feedFormat  ) 

Return an array with a ChangesFeed object and ChannelFeed object.

Returns:
array

Definition at line 147 of file SpecialRecentchanges.php.

References wfMsgForContent().

Referenced by execute().

SpecialRecentChanges::getFeedQuery (  ) 

Get the query string to append to feed link URLs.

This is overridden by RCL to add the target parameter

Definition at line 423 of file SpecialRecentchanges.php.

Referenced by webOutput().

SpecialRecentChanges::getOptions (  ) 

Get the current FormOptions for this request.

Definition at line 81 of file SpecialRecentchanges.php.

References $wgRequest, feedSetup(), and setup().

Referenced by execute().

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

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

Parameters:
$title see Title
$override 
$options 

Definition at line 622 of file SpecialRecentchanges.php.

References $options, $title, $wgUser, and SpecialPage::getTitle().

Referenced by optionsPanel().

SpecialRecentChanges::namespaceFilterForm ( FormOptions opts  )  [protected]

Creates the choose namespace selection.

Parameters:
$opts FormOptions
Returns:
string

Definition at line 536 of file SpecialRecentchanges.php.

References Xml::checkLabel(), Xml::label(), Xml::namespaceSelector(), and wfMsg().

Referenced by getExtraOptions().

SpecialRecentChanges::optionsPanel ( defaults,
nondefaults 
)

Creates the options panel.

Parameters:
$defaults array
$nondefaults array

Definition at line 639 of file SpecialRecentchanges.php.

References $defaults, $options, $wgLang, $wgRCLinkDays, $wgRCLinkLimits, $wgUser, makeOptionsLink(), wfEmptyMsg(), wfMsg(), wfMsgExt(), wfMsgHtml(), and wfTimestampNow().

Referenced by doHeader().

SpecialRecentChanges::parseParameters ( par,
FormOptions opts 
)

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

Parameters:
$par String
$opts FormOptions

Definition at line 163 of file SpecialRecentchanges.php.

Referenced by setup().

SpecialRecentChanges::setBottomText ( OutputPage out,
FormOptions opts 
)

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

Parameters:
$out OutputPage
$opts FormOptions

Definition at line 528 of file SpecialRecentchanges.php.

Referenced by doHeader().

SpecialRecentChanges::setTopText ( OutputPage out,
FormOptions opts 
)

Send the text to be displayed above the options.

Parameters:
$out OutputPage
$opts FormOptions

Definition at line 517 of file SpecialRecentchanges.php.

References OutputPage::addWikiText(), and wfMsgForContentNoTrans().

Referenced by doHeader().

SpecialRecentChanges::setup ( parameters  ) 

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

Returns:
FormOptions

Definition at line 49 of file SpecialRecentchanges.php.

References $wgRequest, getDefaultOptions(), and parseParameters().

Referenced by getOptions().

SpecialRecentChanges::webOutput ( rows,
opts 
)

Send output to $wgOut, only called if not used feeds.

Parameters:
$rows array of database rows
$opts FormOptions

Definition at line 360 of file SpecialRecentchanges.php.

References $dbr, $rows, $s, $wgAllowCategorizedRecentChanges, $wgOut, $wgRCShowWatchingUsers, $wgShowUpdatedMarker, $wgUser, doHeader(), filterByCategories(), getFeedQuery(), SpecialPage::including(), RecentChange::newFromRow(), ChangesList::newFromUser(), and wfGetDB().

Referenced by execute().


Member Data Documentation

SpecialRecentChanges::$rcOptions

Definition at line 8 of file SpecialRecentchanges.php.

SpecialRecentChanges::$rcSubpage

Definition at line 8 of file SpecialRecentchanges.php.


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

Generated on Sat Apr 30 22:57:49 2011 for MediaWiki by  doxygen 1.5.9