MediaWiki  REL1_24
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', $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.
 doMainQuery ($conds, $opts)
 Process the query.
 execute ($subpage)
 Main execution point.
 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.
 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.
 parseParameters ($par, FormOptions $opts)
 Process $par and put options found in $opts.
 setTopText (FormOptions $opts)
 Send the text to be displayed above the options.
 validateOptions (FormOptions $opts)
 Validate a FormOptions object generated by getDefaultOptions() with values already populated.

Protected Member Functions

 addModules ()
 Add page-specific modules.
 categoryFilterForm (FormOptions $opts)
 Create an input to filter changes by categories.
 getCustomFilters ()
 Get custom show/hide filters.
 namespaceFilterForm (FormOptions $opts)
 Creates the choose namespace selection.
 runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)

Private Member Functions

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

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',
restriction = '' 
)

Definition at line 31 of file SpecialRecentchanges.php.

References $name.


Member Function Documentation

Add page-specific modules.

Reimplemented from ChangesListSpecialPage.

Definition at line 487 of file SpecialRecentchanges.php.

References $out, and SpecialPage\getOutput().

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 $conds, $dbr, ChangesListSpecialPage\getDB(), FormOptions\reset(), and wfTimestamp().

Create an input to filter changes by categories.

Parameters:
FormOptions$opts
Returns:
array

Definition at line 539 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.

Returns:
string|bool

Definition at line 500 of file SpecialRecentchanges.php.

References $dbr, and ChangesListSpecialPage\getDB().

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 from ChangesListSpecialPage.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 194 of file SpecialRecentchanges.php.

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

Main execution point.

Parameters:
string$subpage

Reimplemented from ChangesListSpecialPage.

Definition at line 41 of file SpecialRecentchanges.php.

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

Filter $rows by categories set in $opts.

Parameters:
ResultWrapper$rowsDatabase rows
FormOptions$opts

Definition at line 555 of file SpecialRecentchanges.php.

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

Referenced by doMainQuery().

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 array(), and wfRunHooks().

Referenced by optionsPanel().

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().

Get options to be displayed in a form.

Parameters:
FormOptions$opts
Returns:
array

Reimplemented from ChangesListSpecialPage.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 459 of file SpecialRecentchanges.php.

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

Referenced by doHeader().

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

Returns:
array

Definition at line 273 of file SpecialRecentchanges.php.

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

Referenced by execute(), and outputFeedLinks().

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

Returns:
bool

Reimplemented from SpecialPage.

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

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

Referenced by optionsPanel().

Creates the choose namespace selection.

Parameters:
FormOptions$opts
Returns:
string

Definition at line 513 of file SpecialRecentchanges.php.

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

Referenced by getExtraOptions().

SpecialRecentChanges::optionsPanel ( defaults,
nondefaults,
numRows 
)

Creates the options panel.

Parameters:
array$defaults
array$nondefaults
int$numRowsNumber of rows in the result to show after this header
Returns:
string

Definition at line 650 of file SpecialRecentchanges.php.

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

Referenced by doHeader().

Output feed links.

Reimplemented from ChangesListSpecialPage.

Definition at line 264 of file SpecialRecentchanges.php.

References SpecialPage\addFeedLinks(), and getFeedQuery().

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.

SpecialRecentChanges::runMainQueryHook ( &$  tables,
&$  fields,
&$  conds,
&$  query_options,
&$  join_conds,
opts 
) [protected]

Reimplemented from ChangesListSpecialPage.

Definition at line 255 of file SpecialRecentchanges.php.

References $conds, $tables, array(), and wfRunHooks().

Referenced by SpecialRecentChangesLinked\doMainQuery(), and doMainQuery().

Send the text to be displayed above the options.

Parameters:
FormOptions$optsUnused

Reimplemented from ChangesListSpecialPage.

Reimplemented in SpecialRecentChangesLinked.

Definition at line 437 of file SpecialRecentchanges.php.

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

Referenced by doHeader().

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: