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

Inheritance diagram for ChangesListSpecialPage:

[legend]

Collaboration diagram for ChangesListSpecialPage:

[legend]

Public Member Functions
	buildMainQueryConds (FormOptions $opts)
	Return an array of conditions depending of options set in $opts. More...

	doHeader ( $opts)
	Return 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...

	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='default', $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...

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

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

	getFile ()
	Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. 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...

	getLang ()
	Shortcut to get user's language. 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...

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

	requireLogin ( $reasonMsg=null, $titleMsg=null)
	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...

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

Static Public Member Functions
static	makeLegend (IContextSource $context)
	Return the legend displayed within the fieldset. More...

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. 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 DatabaseBase object for reading. More...

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

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

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

Protected Attributes
array	$customFilters

FormOptions	$rcOptions

string	$rcSubpage

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

	$mIncludable

	$mIncluding

	$mName

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

◆ addModules()

ChangesListSpecialPage::addModules ( )

protected

Add page-specific modules.

Reimplemented in SpecialRecentChanges.

Definition at line 455 of file ChangesListSpecialPage.php.

References $out, and SpecialPage\getOutput().

Referenced by execute().

◆ buildMainQueryConds()

ChangesListSpecialPage::buildMainQueryConds ( FormOptions $opts )

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

Parameters

FormOptions $opts

Returns: array

Reimplemented in SpecialRecentChanges, and SpecialWatchlist.

Definition at line 198 of file ChangesListSpecialPage.php.

References $dbr, $user, array(), MWNamespace\getAssociated(), getDB(), and SpecialPage\getUser().

Referenced by getRows().

◆ doHeader()

ChangesListSpecialPage::doHeader ( $opts )

Return the text to be displayed above the changes.

Parameters

FormOptions $opts

Returns: string XHTML

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 353 of file ChangesListSpecialPage.php.

References setBottomText(), and setTopText().

Referenced by execute(), and webOutput().

◆ doMainQuery()

ChangesListSpecialPage::doMainQuery	(	$conds,
		$opts
	)

Process the query.

Parameters

array	$conds
FormOptions	$opts

Returns: bool|ResultWrapper Result or false

Reimplemented in SpecialRecentChanges, SpecialWatchlist, and SpecialRecentChangesLinked.

Definition at line 275 of file ChangesListSpecialPage.php.

References $dbr, $tables, array(), getDB(), SpecialPage\getName(), ChangeTags\modifyDisplayQuery(), RecentChange\selectFields(), and wfRunHooks().

Referenced by getRows().

◆ execute()

ChangesListSpecialPage::execute ( $subpage )

Main execution point.

Parameters

string $subpage

Reimplemented from SpecialPage.

Reimplemented in SpecialRecentChanges, and SpecialWatchlist.

Definition at line 42 of file ChangesListSpecialPage.php.

References $batch, addModules(), as, doHeader(), getOptions(), getRows(), SpecialPage\including(), NS_USER, NS_USER_TALK, SpecialPage\outputHeader(), SpecialPage\setHeaders(), and webOutput().

◆ fetchOptionsFromRequest()

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 $parameters

Returns: FormOptions

Reimplemented in SpecialWatchlist.

Definition at line 167 of file ChangesListSpecialPage.php.

References SpecialPage\getRequest().

Referenced by setup().

◆ getCustomFilters()

ChangesListSpecialPage::getCustomFilters ( )

protected

Get custom show/hide filters.

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

Reimplemented in SpecialWatchlist, and SpecialRecentChanges.

Definition at line 150 of file ChangesListSpecialPage.php.

References $customFilters, array(), and wfRunHooks().

Referenced by setup().

◆ getDB()

ChangesListSpecialPage::getDB ( )

protected

Return a DatabaseBase object for reading.

Returns: DatabaseBase

Reimplemented in SpecialWatchlist.

Definition at line 313 of file ChangesListSpecialPage.php.

References DB_SLAVE, and wfGetDB().

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

◆ getDefaultOptions()

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

Reimplemented in SpecialWatchlist, SpecialRecentChanges, and SpecialRecentChangesLinked.

Definition at line 128 of file ChangesListSpecialPage.php.

References FormOptions\INTNULL.

Referenced by setup().

◆ getExtraOptions()

ChangesListSpecialPage::getExtraOptions ( $opts )

Get options to be displayed in a form.

Todo:: This should handle options returned by getDefaultOptions().

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

Parameters

FormOptions $opts

Returns: array

Reimplemented in SpecialRecentChanges, and SpecialRecentChangesLinked.

Definition at line 389 of file ChangesListSpecialPage.php.

References array().

◆ getGroupName()

ChangesListSpecialPage::getGroupName ( )

protected

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