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

	makeOptionsLink ($title, $override, $options, $active=false)
	Makes change an option link which carries all the other options. More...

	optionsPanel ($defaults, $nondefaults, $numRows)
	Creates the options panel. More...

	outputChangesList ($rows, $opts)
	Build and output the actual changes list. More...

	outputFeedLinks ()

	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)

Public Member Functions inherited from ChangesListSpecialPage
	buildMainQueryConds (FormOptions $opts)
	Return an array of conditions depending of options set in $opts. 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...

	getDefaultOptions ()
	Get a FormOptions object containing the default options. More...

	getExtraOptions ($opts)
	Get options to be displayed in a form. More...

	getOptions ()
	Get the current FormOptions for this request. More...

	getRows ()
	Get the database result for this special page instance. More...

	makeLegend ()
	Return the legend displayed within the fieldset. 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...

	setBottomText (FormOptions $opts)
	Send the text to be displayed after the options. More...

	setTopText (FormOptions $opts)
	Send the text to be displayed before the options. More...

	setup ($parameters)
	Create a FormOptions object with options as specified by the user. More...

	validateOptions (FormOptions $opts)
	Validate a FormOptions object generated by getDefaultOptions() with values already populated. 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= '', $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...

	addHelpLink ($to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators. 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...

	doesWrites ()
	Indicates whether this special page may perform database writes. More...

	execute ($subPage)
	Default execute method Checks user permissions. More...

	getConfig ()
	Shortcut to get main config object. 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...

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

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

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}. 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...

	maxIncludeCacheTime ()
	How long to cache page when it is being included. 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...

	prefixSearchSubpages ($search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept. More...

	requireLogin ($reasonMsg= 'exception-nologin-text', $titleMsg= 'exception-nologin')
	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...

	setLinkRenderer (LinkRenderer $linkRenderer)

	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 an input to filter changes by categories. More...

	getCacheTTL ()

	getCustomFilters ()
	Get custom show/hide filters. More...

	getDB ()

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

	namespaceFilterForm (FormOptions $opts)
	Creates the choose namespace selection. More...

	runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)

Protected Member Functions inherited from ChangesListSpecialPage
	addModules ()
	Add page-specific modules. More...

	fetchOptionsFromRequest ($opts)
	Fetch values for a FormOptions object from the WebRequest associated with this instance. More...

	getCustomFilters ()
	Get custom show/hide filters. More...

	getDB ()
	Return a IDatabase object for reading. More...

	getGroupName ()

	runMainQueryHook (&$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts)

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

	checkLoginSecurityLevel ($level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process. More...

	getCacheTTL ()

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

	getLinkRenderer ()

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...

	getRobotPolicy ()
	Return the robot policy. More...

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches. More...

	prefixSearchString ($search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages. More...

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed. More...

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. More...

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. More...

static	getTitleValueFor ($name, $subpage=false, $fragment= '')
	Get a localised TitleValue object for a specified special page name. More...

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

	$mRestriction

Detailed Description

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

Definition at line 31 of file SpecialRecentchanges.php.

Constructor & Destructor Documentation

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

Definition at line 33 of file SpecialRecentchanges.php.

References $name.

Member Function Documentation

SpecialRecentChanges::addModules ( )

protected

Add page-specific modules.

Definition at line 520 of file SpecialRecentchanges.php.

References $out, and SpecialPage\getOutput().

SpecialRecentChanges::buildMainQueryConds ( FormOptions $opts )

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

Parameters

FormOptions $opts

Returns: array

Definition at line 179 of file SpecialRecentchanges.php.

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

SpecialRecentChanges::categoryFilterForm ( FormOptions $opts )

protected

Create an input to filter changes by categories.

Parameters

FormOptions $opts

Returns: array

Definition at line 572 of file SpecialRecentchanges.php.

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

Referenced by getExtraOptions().

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

References $dbr, and getDB().

Referenced by execute().

SpecialRecentChanges::doHeader	(	$opts,
		$numRows
	)

Set the text to be displayed above the changes.

Parameters

FormOptions	$opts
int	$numRows	Number of rows in the result to show after this header

Definition at line 398 of file SpecialRecentchanges.php.

References $count, $name, $out, $t, $value, as, Xml\closeElement(), Xml\fieldset(), getExtraOptions(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), Html\hidden(), ChangesListSpecialPage\makeLegend(), SpecialPage\msg(), Xml\openElement(), optionsPanel(), ChangesListSpecialPage\setBottomText(), setTopText(), Xml\submitButton(), Xml\tags(), text, and wfScript().

SpecialRecentChanges::doMainQuery	(	$conds,
		$opts
	)

Process the query.

Parameters

array	$conds
FormOptions	$opts

Returns: bool|ResultWrapper Result or false (for Recentchangeslinked only)

Definition at line 207 of file SpecialRecentchanges.php.

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

SpecialRecentChanges::execute ( $subpage )

Main execution point.

Parameters

string $subpage

Definition at line 43 of file SpecialRecentchanges.php.

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

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

Filter $rows by categories set in $opts.

Parameters

ResultWrapper	$rows	Database rows
FormOptions	$opts

Definition at line 588 of file SpecialRecentchanges.php.

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

Referenced by doMainQuery().

SpecialRecentChanges::getCacheTTL ( )

protected

Definition at line 801 of file SpecialRecentchanges.php.

SpecialRecentChanges::getCustomFilters ( )

protected

Get custom show/hide filters.

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

Definition at line 102 of file SpecialRecentchanges.php.

References ChangesListSpecialPage\$customFilters, and Hooks\run().

Referenced by optionsPanel().

SpecialRecentChanges::getDB ( )

protected

Definition at line 286 of file SpecialRecentchanges.php.

References DB_REPLICA, and wfGetDB().

Referenced by buildMainQueryConds(), checkLastModified(), doMainQuery(), and outputChangesList().

SpecialRecentChanges::getDefaultOptions ( )

Get a FormOptions object containing the default options.

Returns: FormOptions

Definition at line 74 of file SpecialRecentchanges.php.

References $user, and SpecialPage\getUser().

SpecialRecentChanges::getExtraOptions ( $opts )

Get options to be displayed in a form.

Parameters

FormOptions $opts

Returns: array

Definition at line 492 of file SpecialRecentchanges.php.

References ChangeTags\buildTagFilterSelector(), categoryFilterForm(), SpecialPage\getConfig(), SpecialPage\getName(), namespaceFilterForm(), and Hooks\run().

Referenced by doHeader().

SpecialRecentChanges::getFeedQuery ( )

protected

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

Returns: array

Definition at line 299 of file SpecialRecentchanges.php.

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

Referenced by execute(), and outputFeedLinks().

SpecialRecentChanges::isIncludable ( )

Definition at line 797 of file SpecialRecentchanges.php.

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

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

Parameters

string	$title	Title
array	$override	Options to override
array	$options	Current options
bool	$active	Whether to show the link in bold

Returns: string

Definition at line 655 of file SpecialRecentchanges.php.

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

Referenced by optionsPanel().

SpecialRecentChanges::namespaceFilterForm ( FormOptions $opts )

protected

Creates the choose namespace selection.

Parameters

FormOptions $opts

Returns: string

Definition at line 546 of file SpecialRecentchanges.php.

References Xml\checkLabel(), Xml\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	$numRows	Number of rows in the result to show after this header

Returns: string

Definition at line 683 of file SpecialRecentchanges.php.

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

Referenced by doHeader().

SpecialRecentChanges::outputChangesList	(	$rows,
		$opts
	)

Build and output the actual changes list.

Parameters

ResultWrapper	$rows	Database rows
FormOptions	$opts

Definition at line 319 of file SpecialRecentchanges.php.

References $dbr, $limit, as, SpecialPage\getConfig(), SpecialPage\getContext(), getDB(), SpecialPage\getOutput(), SpecialPage\getUser(), SpecialPage\including(), SpecialPage\msg(), ChangesList\newFromContext(), RecentChange\newFromRow(), and RC_CATEGORIZE.

SpecialRecentChanges::outputFeedLinks ( )

Definition at line 290 of file SpecialRecentchanges.php.

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

SpecialRecentChanges::parseParameters	(		$par,
		FormOptions	$opts
	)

Process $par and put options found in $opts.

Used when including the page.

Parameters

string	$par
FormOptions	$opts

Definition at line 117 of file SpecialRecentchanges.php.

References as.

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

protected

Definition at line 275 of file SpecialRecentchanges.php.

References $tables, and Hooks\run().

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

SpecialRecentChanges::setTopText ( FormOptions $opts )

Send the text to be displayed above the options.

Parameters

FormOptions $opts Unused

Definition at line 470 of file SpecialRecentchanges.php.

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

Referenced by doHeader().

SpecialRecentChanges::validateOptions ( FormOptions $opts )

Definition at line 168 of file SpecialRecentchanges.php.

References FormOptions\validateIntBounds().

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

includes/specials/SpecialRecentchanges.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation