Special page which uses a ChangesList to show query results. More...

Inheritance diagram for ChangesListSpecialPage:

Collaboration diagram for ChangesListSpecialPage:

Public Member Functions
	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...

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

Protected Attributes
array	$customFilters

FormOptions	$rcOptions

string	$rcSubpage

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context. More...

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

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

Detailed Description

Special page which uses a ChangesList to show query results.

Todo:: Way too many public functions, most of them should be protected

Definition at line 30 of file ChangesListSpecialPage.php.

Member Function Documentation

ChangesListSpecialPage::addModules ( )

protected

Add page-specific modules.

Definition at line 475 of file ChangesListSpecialPage.php.

References $out, and SpecialPage\getOutput().

Referenced by execute().

ChangesListSpecialPage::buildMainQueryConds ( FormOptions $opts )

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

Parameters

FormOptions $opts

Returns: array

Definition at line 213 of file ChangesListSpecialPage.php.

References $dbr, $user, MWNamespace\getAssociated(), SpecialPage\getConfig(), getDB(), SpecialPage\getUser(), RC_CATEGORIZE, and true.

Referenced by getRows().

ChangesListSpecialPage::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 382 of file ChangesListSpecialPage.php.

References setBottomText(), and setTopText().

Referenced by execute(), and webOutput().

ChangesListSpecialPage::doMainQuery	(	$conds,
		$opts
	)

Process the query.

Parameters

array	$conds
FormOptions	$opts

Returns: bool|ResultWrapper Result or false

Definition at line 295 of file ChangesListSpecialPage.php.

References $dbr, $tables, getDB(), ChangeTags\modifyDisplayQuery(), runMainQueryHook(), and RecentChange\selectFields().

Referenced by getRows().

ChangesListSpecialPage::execute ( $subpage )

Main execution point.

Parameters

string $subpage

Definition at line 45 of file ChangesListSpecialPage.php.

References $batch, $title, addModules(), as, doHeader(), getOptions(), SpecialPage\getOutput(), getRows(), SpecialPage\including(), LogFormatter\newFromRow(), NS_USER, NS_USER_TALK, SpecialPage\outputHeader(), SpecialPage\setHeaders(), RecentChange\SRC_LOG, and webOutput().

ChangesListSpecialPage::fetchOptionsFromRequest ( $opts )

protected

Fetch values for a FormOptions object from the WebRequest associated with this instance.

Intended for subclassing, e.g. to add a backwards-compatibility layer.

Parameters

FormOptions $opts

Returns: FormOptions

Definition at line 182 of file ChangesListSpecialPage.php.

References SpecialPage\getRequest().

Referenced by setup().

ChangesListSpecialPage::getCustomFilters ( )

protected

Get custom show/hide filters.

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

Definition at line 165 of file ChangesListSpecialPage.php.

References $customFilters, and Hooks\run().

Referenced by setup().

ChangesListSpecialPage::getDB ( )

protected

Return a IDatabase object for reading.

Returns: IDatabase

Definition at line 342 of file ChangesListSpecialPage.php.

References DB_REPLICA, and wfGetDB().

Referenced by buildMainQueryConds(), and doMainQuery().

ChangesListSpecialPage::getDefaultOptions ( )

Get a FormOptions object containing the default options.

By default returns some basic options, you might want to not call parent method and discard them, or to override default values.

Returns: FormOptions

Definition at line 138 of file ChangesListSpecialPage.php.

References SpecialPage\getConfig(), and FormOptions\INTNULL.

Referenced by setup().

ChangesListSpecialPage::getExtraOptions ( $opts )

Get options to be displayed in a form.

Todo:

This should handle options returned by getDefaultOptions().

Not called by anything, should be called by something… doHeader() maybe?

Parameters

FormOptions $opts

Returns: array

Definition at line 418 of file ChangesListSpecialPage.php.

ChangesListSpecialPage::getGroupName ( )

protected

Definition at line 485 of file ChangesListSpecialPage.php.

ChangesListSpecialPage::getOptions ( )

Get the current FormOptions for this request.

Returns: FormOptions

Definition at line 99 of file ChangesListSpecialPage.php.

References $rcOptions, and setup().

Referenced by execute(), SpecialWatchlist\execute(), SpecialRecentChanges\getFeedQuery(), getRows(), and SpecialRecentChangesLinked\getTargetTitle().

ChangesListSpecialPage::getRows ( )

Get the database result for this special page instance.

Used by ApiFeedRecentChanges.

Returns: bool|ResultWrapper Result or false

Definition at line 87 of file ChangesListSpecialPage.php.

References buildMainQueryConds(), doMainQuery(), and getOptions().

Referenced by execute().

ChangesListSpecialPage::makeLegend ( )

Return the legend displayed within the fieldset.

Returns: string

Definition at line 427 of file ChangesListSpecialPage.php.

References $context, $user, as, Html\closeElement(), Html\element(), Sanitizer\escapeClass(), SpecialPage\getContext(), of, Html\openElement(), Html\rawElement(), and the.

Referenced by SpecialRecentChanges\doHeader(), and SpecialWatchlist\setTopText().

ChangesListSpecialPage::outputChangesList	(	$rows,
		$opts
	)

abstract

Build and output the actual changes list.

Parameters

ResultWrapper	$rows	Database rows
FormOptions	$opts

Referenced by webOutput().

ChangesListSpecialPage::outputFeedLinks ( )

Output feed links.

Definition at line 364 of file ChangesListSpecialPage.php.

Referenced by webOutput().

ChangesListSpecialPage::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 194 of file ChangesListSpecialPage.php.

Referenced by setup().

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

protected

Definition at line 328 of file ChangesListSpecialPage.php.

References $tables, SpecialPage\getName(), and Hooks\run().

Referenced by doMainQuery().

ChangesListSpecialPage::setBottomText ( FormOptions $opts )

Send the text to be displayed after the options.

Should use $this->getOutput()->addWikiText() or similar methods to print the text.

Parameters

FormOptions $opts

Definition at line 406 of file ChangesListSpecialPage.php.

Referenced by doHeader(), SpecialRecentChanges\doHeader(), and SpecialWatchlist\doHeader().

ChangesListSpecialPage::setTopText ( FormOptions $opts )

Send the text to be displayed before the options.

Should use $this->getOutput()->addWikiText() or similar methods to print the text.

Parameters

FormOptions $opts

Definition at line 396 of file ChangesListSpecialPage.php.

Referenced by doHeader().

ChangesListSpecialPage::setup ( $parameters )

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

Parameters

array $parameters

Returns: FormOptions

Definition at line 114 of file ChangesListSpecialPage.php.

References $params, as, fetchOptionsFromRequest(), getCustomFilters(), getDefaultOptions(), parseParameters(), and validateOptions().

Referenced by getOptions().

ChangesListSpecialPage::validateOptions ( FormOptions $opts )

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

Parameters

FormOptions $opts

Definition at line 203 of file ChangesListSpecialPage.php.

Referenced by setup().

ChangesListSpecialPage::webOutput	(	$rows,
		$opts
	)

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

Parameters

ResultWrapper	$rows	Database rows
FormOptions	$opts

Definition at line 352 of file ChangesListSpecialPage.php.

References doHeader(), SpecialPage\including(), outputChangesList(), and outputFeedLinks().

Referenced by execute().

Member Data Documentation

array ChangesListSpecialPage::$customFilters

protected

Definition at line 38 of file ChangesListSpecialPage.php.

Referenced by SpecialRecentChanges\getCustomFilters(), SpecialWatchlist\getCustomFilters(), and getCustomFilters().

FormOptions ChangesListSpecialPage::$rcOptions

protected

Definition at line 35 of file ChangesListSpecialPage.php.

Referenced by getOptions().

string ChangesListSpecialPage::$rcSubpage

protected

Definition at line 32 of file ChangesListSpecialPage.php.

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

includes/specialpage/ChangesListSpecialPage.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation