Parent special page class, also static functions for handling the special page list. More...

Inheritance diagram for SpecialPage:

Collaboration diagram for SpecialPage:

Public Member Functions
	__call ($fName, $a)
	Use PHP's magic __call handler to get calls to the old PHP4 constructor because PHP E_STRICT yells at you for having __construct() and 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.
	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.
	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.
	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.
	execute ($subPage)
	Default execute method Checks user permissions, calls the function given in mFunction.
	file ($x=null)
	These mutators are very evil, as the relevant variables should not mutate.
	func ($x=null)
	These mutators are very evil, as the relevant variables should not mutate.
	getContext ()
	Gets the context this SpecialPage is executed in.
	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.
	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.
	getFullTitle ()
	Return the full title, including $par.
	getLang ()
	Shortcut to get user's language.
	getLanguage ()
	Shortcut to get user's language.
	getLocalName ()
	Get the localised name of the special page.
	getName ()
	Get the name of this Special Page.
	getOutput ()
	Get the OutputPage being used for this instance.
	getRequest ()
	Get the WebRequest being used for this instance.
	getRestriction ()
	Get the permission that a user must have to execute this page.
	getSkin ()
	Shortcut to get the skin being used for this instance.
	getTitle ($subpage=false)
	Get a self-referential title object.
	getUser ()
	Shortcut to get the User executing this instance.
	includable ($x=null)
	These mutators are very evil, as the relevant variables should not mutate.
	including ($x=null)
	Whether the special page is being evaluated via transclusion.
	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.
	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
	isListed ()
	Whether this special page is listed in Special:SpecialPages.
	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.
	listed ($x=null)
	Get or set whether this special page is listed in Special:SpecialPages.
	msg ()
	Wrapper around wfMessage that sets the current context.
	name ($x=null)
	These mutators are very evil, as the relevant variables should not mutate.
	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 overriden, i.e.
	restriction ($x=null)
	These mutators are very evil, as the relevant variables should not mutate.
	run ($subPage)
	Entry point.
	setContext ($context)
	Sets the context this SpecialPage is executed in.
	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!
	setListed ($listed)
	Set whether this page is listed in Special:Specialpages, at run-time.
	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
Static Public Member Functions
static	addPage (&$page)
	Add a page to the list of valid special pages.
static	executePath (&$title, IContextSource &$context, $including=false)
	Execute a special page path.
static	exists ($name)
	Check if a given name exist as a special page or as a special page alias.
static	getGroup (&$page)
	Get the group that the special page belongs in on Special:SpecialPage.
static	getLocalNameFor ($name, $subpage=false)
	Get the local name for a specified canonical name.
static	getPage ($name)
	Find the object with a given name and return it (or NULL)
static	getPageByAlias ($alias)
	Get a special page with a given localised name, or NULL if there is no such special page.
static	getRegularPages ()
	Return categorised listable special pages for all users.
static	getRestrictedPages ()
	Return categorised listable special pages which are available for the current user, but not for everyone.
static	getSafeTitleFor ($name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.
static	getTitleFor ($name, $subpage=false)
	Get a localised Title object for a specified special page name.
static	getTitleForAlias ($alias)
	Get a title for a given alias.
static	getUsablePages (User $user=null)
	Return categorised listable special pages which are available for the current user, and everyone.
static	initAliasList ()
static	initList ()
	Initialise the special page list This must be called before accessing SpecialPage::$mList.
static	removePage ($name)
	Remove a special page from the list Formerly used to disable expensive or dangerous special pages.
static	resolveAlias ($alias)
	Given a special page alias, return the special page name.
static	resolveAliasWithSubpage ($alias)
	Given a special page name with a possible subpage, return an array where the first element is the special page name and the second is the subpage.
static	setGroup ($page, $group)
	Add a page to a certain display group for Special:SpecialPages.
Protected Member Functions
	addFeedLinks ($params)
	Adds RSS/atom links.
	afterExecute ($subPage)
	Gets called after.
	beforeExecute ($subPage)
	Gets called before.
Protected Attributes
IContextSource	$mContext
	Current request context.
	$mIncludable
	$mIncluding
	$mName
Private Member Functions
	init ($name, $restriction, $listed, $function, $file, $includable)
	Do the real work for the constructor, mainly so __call() can intercept calls to SpecialPage()
Private Attributes
	$mFile
	$mFunction
	$mListed
	$mLocalName
	$mRestriction

Detailed Description

Parent special page class, also static functions for handling the special page list.

Definition at line 29 of file SpecialPage.php.

Constructor & Destructor Documentation

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.

If you override execute(), you can recover the default behaviour with userCanExecute() and displayRestrictionError()

Parameters:

$name	String: name of the special page, as seen in links and URLs
$restriction	String: user right required, e.g. "block" or "delete"
$listed	Bool: whether the page is listed in Special:Specialpages
$function	Callback\|Bool: function called by execute(). By default it is constructed from $name
$file	String: file which is included by execute(). It is also constructed from $name by default
$includable	Bool: whether the page can be included in normal pages

Definition at line 325 of file SpecialPage.php.

Member Function Documentation

SpecialPage::__call	(	$	fName,
		$	a
	)

Use PHP's magic __call handler to get calls to the old PHP4 constructor because PHP E_STRICT yells at you for having __construct() and SpecialPage()

Parameters:

$fName	String Name of called method
$a	Array Arguments to the method

Deprecated:: since 1.17, call parent::__construct()

Definition at line 367 of file SpecialPage.php.

SpecialPage::addFeedLinks ( $ params ) [protected]

Adds RSS/atom links.

Parameters:

$params array

Definition at line 839 of file SpecialPage.php.

Referenced by SpecialWatchlist\execute(), and SpecialContributions\execute().

static SpecialPage::addPage ( &$ page ) [static]

Add a page to the list of valid special pages.

This used to be the preferred method for adding special pages in extensions. It's now suggested that you add an associative record to $wgSpecialPages. This avoids autoloading SpecialPage.

Parameters:

$page SpecialPage

Deprecated:: since 1.7, warnings in 1.17, might be removed in 1.20

Definition at line 115 of file SpecialPage.php.

SpecialPage::afterExecute ( $ subPage ) [protected]

Gets called after.

See also:: SpecialPage::execute.

Since:: 1.20

Parameters:

$subPage string|null

Reimplemented in SpecialCachedPage.

Definition at line 642 of file SpecialPage.php.

SpecialPage::beforeExecute ( $ subPage ) [protected]

Gets called before.

See also:: SpecialPage::execute.

Since:: 1.20

Parameters:

$subPage string|null

Definition at line 631 of file SpecialPage.php.

SpecialPage::checkPermissions ( )

Checks if userCanExecute, and if not throws a PermissionsError.

Since:: 1.19

Definition at line 563 of file SpecialPage.php.

Referenced by SpecialUnblock\execute(), SpecialEditWatchlist\execute(), SpecialUploadStash\execute(), SpecialMergeHistory\execute(), and SpecialRevisionDelete\execute().

SpecialPage::checkReadOnly ( )

If the wiki is currently in readonly mode, throws a ReadOnlyError.

Since:: 1.19

Exceptions:

ReadOnlyError

Definition at line 575 of file SpecialPage.php.

Referenced by SpecialPreferences\execute(), SpecialChangePassword\execute(), SpecialUnblock\execute(), MovePageForm\execute(), EmailConfirmation\execute(), SpecialImport\execute(), UserrightsPage\execute(), SpecialMergeHistory\execute(), and SpecialRevisionDelete\execute().

SpecialPage::displayRestrictionError ( )

Output an error message telling the user what access level they have to have.

Definition at line 554 of file SpecialPage.php.

Referenced by DeletedContributionsPage\execute().

SpecialPage::execute ( $ subPage )

Default execute method Checks user permissions, calls the function given in mFunction.

This must be overridden by subclasses; it will be made abstract in a future version

Parameters:

$subPage string|null

Reimplemented in RedirectSpecialPage, FormSpecialPage, SpecialUndelete, QueryPage, SpecialListUsers, DeletedContributionsPage, SpecialActiveUsers, EmailInvalidation, LoginForm, SpecialRecentChanges, SpecialUpload, SpecialNewpages, SpecialRevisionDelete, SpecialEmailUser, FileDuplicateSearchPage, SpecialMergeHistory, SpecialSearch, SpecialAllpages, UserrightsPage, SpecialUploadStash, SpecialEditWatchlist, MIMEsearchPage, SpecialChangeEmail, RandomPage, SpecialImport, SpecialBookSources, SpecialVersion, SpecialComparePages, SpecialAllmessages, SpecialLog, SpecialWhatLinksHere, EmailConfirmation, LinkSearchPage, SpecialListGroupRights, MovePageForm, SpecialBlockList, SpecialJavaScriptTest, SpecialExport, SpecialPrefixindex, SpecialStatistics, SpecialUnblock, SpecialContributions, SpecialProtectedpages, SpecialProtectedtitles, SpecialChangePassword, SpecialWatchlist, WithoutInterwikiPage, WantedPagesPage, SpecialBlockme, SpecialFilepath, SpecialSpecialpages, SpecialTags, SpecialUserlogout, SpecialBlankpage, SpecialPreferences, SpecialCategories, SpecialListFiles, and SpecialNewFiles.

Definition at line 654 of file SpecialPage.php.

static SpecialPage::executePath	(	&$	title,
		IContextSource &$	context,
		$	including = `false`
	)		`[static]`

Execute a special page path.

The path may contain parameters, e.g. Special:Name/Params Extracts the special page name and call the execute method, passing the parameters

Returns a title object if the page is redirected, false if there was no such special page, and true if it was successful.

Parameters:

$title	Title object
$context	IContextSource
$including	Bool output is being captured for use in {{special:whatever}}

Returns:: Bool

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 245 of file SpecialPage.php.

static SpecialPage::exists ( $ name ) [static]

Check if a given name exist as a special page or as a special page alias.

Parameters:

$name String: name of a special page

Returns:: Boolean: true if a special page exists with this name

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 164 of file SpecialPage.php.

Referenced by SpecialBlock\maybeAlterFormDefaults().

SpecialPage::file ( $ x = null )

These mutators are very evil, as the relevant variables should not mutate.

So don't use them.

Parameters:

$x Mixed

Returns:: Mixed

Deprecated:: since 1.18

Definition at line 484 of file SpecialPage.php.

Referenced by FileDuplicateSearchPage\execute(), and SpecialVersion\getSvnInfo().

SpecialPage::func ( $ x = null )

These mutators are very evil, as the relevant variables should not mutate.

So don't use them.

Parameters:

$x Mixed

Returns:: Mixed

Deprecated:: since 1.18

Definition at line 475 of file SpecialPage.php.

SpecialPage::getContext ( )

Gets the context this SpecialPage is executed in.

Returns:: IContextSource|RequestContext

Since:: 1.18

Definition at line 730 of file SpecialPage.php.

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

Derived classes can override this, but usually it is easier to keep the default behaviour. Messages can be added at run-time, see MessageCache.php.

Returns:: String

Reimplemented in LoginForm, and SpecialEmailUser.

Definition at line 700 of file SpecialPage.php.

Referenced by SpecialNewpages\feedTitle().

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

No modern code should want or need to know this.

Returns:: String

Deprecated:: since 1.18

Definition at line 409 of file SpecialPage.php.

SpecialPage::getFullTitle ( )

Return the full title, including $par.

Returns:: Title

Since:: 1.18

Definition at line 807 of file SpecialPage.php.

Referenced by SpecialRevisionDelete\execute().

static SpecialPage::getGroup ( &$ page ) [static]

Get the group that the special page belongs in on Special:SpecialPage.

Parameters:

$page SpecialPage

Returns:: string

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 139 of file SpecialPage.php.

Referenced by SpecialSpecialpages\getPageGroups().

SpecialPage::getLang ( )

Shortcut to get user's language.

Deprecated:: 1.19 Use getLanguage instead

Returns:: Language

Since:: 1.18

Definition at line 786 of file SpecialPage.php.

SpecialPage::getLanguage ( )

Shortcut to get user's language.

Returns:: Language

Since:: 1.19

Definition at line 797 of file SpecialPage.php.

SpecialPage::getLocalName ( )

Get the localised name of the special page.

Definition at line 507 of file SpecialPage.php.

static SpecialPage::getLocalNameFor	(	$	name,
		$	subpage = `false`
	)		`[static]`

Get the local name for a specified canonical name.

Parameters:

$name	String
$subpage	Mixed: boolean false, or string

Returns:: String

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 259 of file SpecialPage.php.

SpecialPage::getName ( )

Get the name of this Special Page.

Returns:: String

Definition at line 390 of file SpecialPage.php.

Referenced by SpecialRecentChanges\buildMainQueryConds(), RandomPage\execute(), SpecialEditWatchlist\execute(), SpecialEmailUser\getFormFields(), SpecialMypage\getRedirect(), SpecialMytalk\getRedirect(), SpecialMycontributions\getRedirect(), SpecialMyuploads\getRedirect(), and SpecialLockdb\onSubmit().

SpecialPage::getOutput ( )

Get the OutputPage being used for this instance.

Returns:: OutputPage

Since:: 1.18

Definition at line 755 of file SpecialPage.php.

static SpecialPage::getPage ( $ name ) [static]

Find the object with a given name and return it (or NULL)

Parameters:

$name String

Returns:: SpecialPage object or null if the page doesn't exist

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 176 of file SpecialPage.php.

static SpecialPage::getPageByAlias ( $ alias ) [static]

Get a special page with a given localised name, or NULL if there is no such special page.

Parameters:

$alias String

Returns:: SpecialPage object or null if the page doesn't exist

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 189 of file SpecialPage.php.

static SpecialPage::getRegularPages ( ) [static]

Return categorised listable special pages for all users.

Returns:: array Associative array mapping page's name to its SpecialPage object

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 214 of file SpecialPage.php.

SpecialPage::getRequest ( )

Get the WebRequest being used for this instance.

Returns:: WebRequest

Since:: 1.18

Definition at line 745 of file SpecialPage.php.

Referenced by SpecialBlock\alterForm(), SpecialRevisionDelete\buildCheckBoxes(), SpecialImport\doImport(), SpecialChangePassword\doReturnTo(), SpecialListFiles\execute(), SpecialCategories\execute(), SpecialPreferences\execute(), SpecialBlockme\execute(), SpecialFilepath\execute(), SpecialChangePassword\execute(), SpecialWatchlist\execute(), WithoutInterwikiPage\execute(), SpecialContributions\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialUnblock\execute(), SpecialExport\execute(), SpecialPrefixindex\execute(), SpecialBlockList\execute(), MovePageForm\execute(), LinkSearchPage\execute(), SpecialLog\execute(), SpecialVersion\execute(), SpecialBookSources\execute(), SpecialImport\execute(), RandomPage\execute(), MIMEsearchPage\execute(), SpecialEditWatchlist\execute(), UserrightsPage\execute(), FileDuplicateSearchPage\execute(), SpecialEmailUser\execute(), SpecialRevisionDelete\execute(), SpecialRecentChanges\execute(), DeletedContributionsPage\execute(), SpecialRevisionDelete\extractBitParams(), SpecialRecentchangeslinked\feedSetup(), SpecialRecentChanges\feedSetup(), SpecialRecentChanges\getOptions(), SpecialVersion\IPInfo(), SpecialBlock\maybeAlterFormDefaults(), LoginForm\processLogin(), UserrightsPage\saveUserGroups(), SpecialBlock\setParameter(), SpecialNewpages\setup(), SpecialRecentChanges\setup(), UserrightsPage\showEditUserGroupsForm(), SpecialChangePassword\showForm(), EmailConfirmation\showRequestForm(), SpecialRevisionDelete\submit(), and SpecialRevisionDelete\tryShowFile().

static SpecialPage::getRestrictedPages ( ) [static]

Return categorised listable special pages which are available for the current user, but not for everyone.

Returns:: array Associative array mapping page's name to its SpecialPage object

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 226 of file SpecialPage.php.

SpecialPage::getRestriction ( )

Get the permission that a user must have to execute this page.

Returns:: String

Definition at line 398 of file SpecialPage.php.

static SpecialPage::getSafeTitleFor	(	$	name,
		$	subpage = `false`
	)		`[static]`

Get a localised Title object for a page name with a possibly unvalidated subpage.

Parameters:

$name	String
$subpage	String\|Bool subpage string, or false to not use a subpage

Returns:: Title object or null if the page doesn't exist

Definition at line 287 of file SpecialPage.php.

Referenced by Skin\makeSpecialUrl(), Skin\makeSpecialUrlSubpage(), CologneBlueTemplate\quickBar(), and NostalgiaTemplate\topLinks().

SpecialPage::getSkin ( )

Shortcut to get the skin being used for this instance.

Returns:: Skin

Since:: 1.18

Definition at line 775 of file SpecialPage.php.

Referenced by SpecialEditWatchlist\buildRemoveLine(), SpecialContributions\execute(), DeletedContributionsPage\execute(), SpecialBlock\setParameter(), and SpecialLog\show().

SpecialPage::getTitle ( $ subpage = false )

Get a self-referential title object.

Parameters:

$subpage String|Bool

Returns:: Title object

Definition at line 710 of file SpecialPage.php.

Referenced by SpecialWatchlist\daysLink(), SpecialRecentChanges\doHeader(), SpecialPreferences\execute(), SpecialWatchlist\execute(), SpecialExport\execute(), SpecialJavaScriptTest\execute(), LinkSearchPage\execute(), EmailConfirmation\execute(), SpecialImport\execute(), MIMEsearchPage\execute(), SpecialEditWatchlist\execute(), FileDuplicateSearchPage\execute(), SpecialEmailUser\execute(), SpecialNewpages\filterLinks(), SpecialNewpages\form(), SpecialRecentchangeslinked\getFeedObject(), SpecialRecentChanges\getFeedObject(), SpecialContributions\getForm(), DeletedContributionsPage\getForm(), SpecialJavaScriptTest\getFrameworkListHtml(), SpecialEditWatchlist\getNormalForm(), WithoutInterwikiPage\getPageHeader(), SpecialEditWatchlist\getRawForm(), UserrightsPage\getSuccessURL(), SpecialWatchlist\hoursLink(), SpecialBookSources\makeForm(), SpecialRecentChanges\makeOptionsLink(), SpecialPrefixindex\namespacePrefixForm(), UserrightsPage\showEditUserGroupsForm(), SpecialFilepath\showForm(), SpecialChangePassword\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialWatchlist\showHideLink(), SpecialMergeHistory\showHistory(), SpecialMergeHistory\showMergeForm(), SpecialProtectedtitles\showOptions(), SpecialProtectedpages\showOptions(), SpecialPrefixindex\showPrefixChunk(), EmailConfirmation\showRequestForm(), SpecialPreferences\showResetForm(), SpecialSearch\showResults(), SpecialUploadStash\showUploads(), SpecialPreferences\submitReset(), UserrightsPage\switchForm(), SpecialRevisionDelete\tryShowFile(), and SpecialEmailUser\userForm().

static SpecialPage::getTitleFor	(	$	name,
		$	subpage = `false`
	)		`[static]`

Get a localised Title object for a specified special page name.

Parameters:

$name	String
$subpage	String\|Bool subpage string, or false to not use a subpage

Returns:: Title object

Definition at line 271 of file SpecialPage.php.

Referenced by EmailConfirmation\attemptConfirm(), Linker\blockLink(), SkinTemplate\buildContentNavigationUrls(), SkinTemplate\buildNavUrls(), SpecialEditWatchlist\buildRemoveLine(), SpecialEditWatchlist\buildTools(), Title\checkReadPermissions(), SpecialTags\doTagRow(), Linker\emailLink(), LegacyTemplate\emailUserLink(), SpecialWatchlist\execute(), SpecialBlockList\execute(), SpecialListGroupRights\execute(), ApiFeedContributions\execute(), EmailConfirmation\execute(), ApiFeedWatchlist\execute(), SpecialEditWatchlist\execute(), SpecialRevisionDelete\execute(), UnusedtemplatesPage\formatResult(), SpecialProtectedpages\formatRow(), DeletedContribsPager\formatRow(), BlockListPager\formatValue(), PreferencesForm\getButtons(), InfoAction\getContributors(), HistoryAction\getDescription(), RevDel_ArchiveItem\getDiffLink(), SpecialStatistics\getGroupStats(), RevDel_LogItem\getHTML(), RevDel_ArchivedFileItem\getLink(), SpecialStatistics\getPageStats(), SpecialRedirectToSpecial\getRedirect(), SpecialMycontributions\getRedirect(), SpecialMyuploads\getRedirect(), SpecialLog\getRevisionButton(), RevDel_ArchiveItem\getRevisionLink(), Skin\getSearchLink(), DeletedContributionsPage\getSubTitle(), ImageListPager\getTitle(), SpecialPageFactory\getTitleForAlias(), Skin\getUndeleteLink(), LegacyTemplate\getUploadLink(), Linker\getUploadUrl(), SpecialContributions\getUserLinks(), SpecialStatistics\getUserStats(), ImageHistoryList\imageHistoryLine(), CreditsAction\link(), MostlinkedPage\makeWlhLink(), MostlinkedTemplatesPage\makeWlhLink(), LegacyTemplate\moveThisPage(), LegacyTemplate\nameAndLogin(), Linker\normaliseSpecialPage(), MarkpatrolledAction\onView(), SkinTemplate\outputPage(), InfoAction\pageInfo(), SpecialBlock\postText(), Preferences\profilePreferences(), ManualLogEntry\publish(), StandardTemplate\quickBar(), CologneBlueTemplate\quickBar(), Linker\revDeleteLink(), SpecialRevisionDelete\showConvenienceLinks(), SpecialSearch\showResults(), CoreParserFunctions\special(), Linker\specialLink(), CologneBlueTemplate\sysLinks(), ExtraParserTest\testTrackingCategorySpecial(), LegacyTemplate\userContribsLink(), Linker\userLink(), Linker\userToolLinks(), LegacyTemplate\watchPageLinksLink(), wfProxyCheck(), and LegacyTemplate\whatLinksHere().

static SpecialPage::getTitleForAlias ( $ alias ) [static]

Get a title for a given alias.

Parameters:

$alias String

Returns:: Title or null if there is no such alias

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 303 of file SpecialPage.php.

static SpecialPage::getUsablePages ( User $ user = null ) [static]

Return categorised listable special pages which are available for the current user, and everyone.

Parameters:

$user User object to check permissions, $wgUser will be used if not provided

Returns:: array Associative array mapping page's name to its SpecialPage object

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 203 of file SpecialPage.php.

Referenced by SpecialSpecialpages\getPageGroups().

SpecialPage::getUser ( )

Shortcut to get the User executing this instance.

Returns:: User

Since:: 1.18

Definition at line 765 of file SpecialPage.php.

Referenced by SpecialRevisionDelete\addUsageText(), EmailConfirmation\attemptConfirm(), EmailInvalidation\attemptInvalidate(), SpecialRecentChanges\buildMainQueryConds(), UserrightsPage\changeableGroups(), SpecialRecentChanges\checkLastModified(), SpecialEditWatchlist\cleanupWatchlist(), SpecialEditWatchlist\clearWatchlist(), SpecialWatchlist\countItems(), SpecialImport\doImport(), SpecialRecentchangeslinked\doMainQuery(), SpecialRecentChanges\doMainQuery(), UserrightsPage\doSaveUserGroups(), MovePageForm\doSubmit(), SpecialPreferences\execute(), SpecialUserlogout\execute(), SpecialWatchlist\execute(), SpecialChangePassword\execute(), SpecialContributions\execute(), MovePageForm\execute(), EmailConfirmation\execute(), SpecialLog\execute(), SpecialImport\execute(), SpecialEditWatchlist\execute(), UserrightsPage\execute(), SpecialEmailUser\execute(), SpecialRevisionDelete\execute(), DeletedContributionsPage\execute(), UserrightsPage\fetchUser(), SpecialNewpages\filterLinks(), UnwatchedpagesPage\formatResult(), BrokenRedirectsPage\formatResult(), SpecialMergeHistory\formatRevisionRow(), SpecialProtectedtitles\formatRow(), SpecialProtectedpages\formatRow(), SpecialRecentChanges\getDefaultOptions(), LoginForm\getDescription(), SpecialEmailUser\getFormFields(), SpecialBlock\getFormFields(), SpecialSpecialpages\getPageGroups(), ContribsPager\getQueryInfo(), SpecialMypage\getRedirect(), SpecialMytalk\getRedirect(), SpecialMycontributions\getRedirect(), SpecialMyuploads\getRedirect(), SpecialLog\getRevisionButton(), DeletedContributionsPage\getSubTitle(), SpecialContributions\getUserLinks(), SpecialEditWatchlist\getWatchlist(), SpecialEditWatchlist\getWatchlistInfo(), SpecialLockdb\onSubmit(), SpecialRecentChanges\optionsPanel(), LoginForm\processLogin(), SpecialNewpages\setup(), SpecialRevisionDelete\showConvenienceLinks(), UserrightsPage\showEditUserGroupsForm(), SpecialChangePassword\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialBlockList\showList(), EmailConfirmation\showRequestForm(), SpecialRevisionDelete\submit(), SpecialEditWatchlist\submitRaw(), SpecialPreferences\submitReset(), SpecialRevisionDelete\tryShowFile(), SpecialEditWatchlist\unwatchTitles(), SpecialExport\userCanOverrideExportDepth(), SpecialEditWatchlist\watchTitles(), and SpecialRecentChanges\webOutput().

SpecialPage::includable ( $ x = null )

These mutators are very evil, as the relevant variables should not mutate.

So don't use them.

Parameters:

$x Mixed

Returns:: Mixed

Deprecated:: since 1.18

Definition at line 493 of file SpecialPage.php.

SpecialPage::including ( $ x = null )

Whether the special page is being evaluated via transclusion.

Parameters:

$x Bool

Returns:: Bool

Definition at line 500 of file SpecialPage.php.

Referenced by SpecialNewFiles\execute(), SpecialListFiles\execute(), WantedPagesPage\execute(), SpecialPrefixindex\execute(), SpecialRecentChanges\execute(), SpecialListUsers\execute(), SpecialRecentChanges\getOptions(), SpecialPrefixindex\showPrefixChunk(), and SpecialRecentChanges\webOutput().

SpecialPage::init	(	$	name,
		$	restriction,
		$	listed,
		$	function,
		$	file,
		$	includable
	)		`[private]`

Do the real work for the constructor, mainly so __call() can intercept calls to SpecialPage()

Parameters:

$name	String: name of the special page, as seen in links and URLs
$restriction	String: user right required, e.g. "block" or "delete"
$listed	Bool: whether the page is listed in Special:Specialpages
$function	Callback\|Bool: function called by execute(). By default it is constructed from $name
$file	String: file which is included by execute(). It is also constructed from $name by default
$includable	Bool: whether the page can be included in normal pages

Definition at line 342 of file SpecialPage.php.

static SpecialPage::initAliasList ( ) [static]

Deprecated:: since 1.18

Definition at line 75 of file SpecialPage.php.

static SpecialPage::initList ( ) [static]

Initialise the special page list This must be called before accessing SpecialPage::$mList.

Deprecated:: since 1.18

Definition at line 67 of file SpecialPage.php.

SpecialPage::isExpensive ( )

Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

Originally used (and still overridden) by QueryPage and subclasses, moved here so that Special:SpecialPages can safely call it for all special pages.

Returns:: Boolean

Reimplemented in WantedQueryPage, QueryPage, WithoutInterwikiPage, DeadendPagesPage, LonelyPagesPage, MostlinkedTemplatesPage, UncategorizedImagesPage, UncategorizedPagesPage, MostlinkedPage, MostcategoriesPage, MostimagesPage, MostinterwikisPage, UnusedtemplatesPage, UnwatchedpagesPage, ListredirectsPage, MIMEsearchPage, BrokenRedirectsPage, DoubleRedirectsPage, FewestrevisionsPage, AncientPagesPage, DisambiguationsPage, PopularPagesPage, UnusedimagesPage, and UnusedCategoriesPage.

Definition at line 522 of file SpecialPage.php.

SpecialPage::isIncludable ( )

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

Returns:: Bool

Reimplemented in IncludableSpecialPage.

Definition at line 446 of file SpecialPage.php.

SpecialPage::isListed ( )

Whether this special page is listed in Special:SpecialPages.

Since:: r3583 (v1.3)

Returns:: Bool

Reimplemented in UnlistedSpecialPage, SpecialPasswordReset, SpecialJavaScriptTest, and SpecialChangeEmail.

Definition at line 420 of file SpecialPage.php.

SpecialPage::isRestricted ( )

Can be overridden by subclasses with more complicated permissions schemes.

Returns:: Boolean: should the page be displayed with the restricted-access pages?

Reimplemented in UserrightsPage.

Definition at line 533 of file SpecialPage.php.

SpecialPage::listed ( $ x = null )

Get or set whether this special page is listed in Special:SpecialPages.

Since:: r11308 (v1.6)

Parameters:

$x Bool

Returns:: Bool

Definition at line 438 of file SpecialPage.php.

SpecialPage::msg ( )

Wrapper around wfMessage that sets the current context.

Returns:: Message

See also:: wfMessage

Definition at line 817 of file SpecialPage.php.

SpecialPage::name ( $ x = null )

These mutators are very evil, as the relevant variables should not mutate.

So don't use them.

Parameters:

$x Mixed

Returns:: Mixed

Deprecated:: since 1.18

Definition at line 457 of file SpecialPage.php.

SpecialPage::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 overriden, i.e.

by extensions to stick with the naming conventions for message keys: 'extensionname-xxx'

Parameters:

$summaryMessageKey String: message key of the summary

Definition at line 675 of file SpecialPage.php.

Referenced by SpecialNewFiles\execute(), SpecialListFiles\execute(), SpecialCategories\execute(), SpecialPreferences\execute(), SpecialBlockme\execute(), SpecialUserlogout\execute(), SpecialFilepath\execute(), SpecialSpecialpages\execute(), SpecialTags\execute(), SpecialWatchlist\execute(), SpecialChangePassword\execute(), SpecialContributions\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialUnblock\execute(), SpecialExport\execute(), SpecialPrefixindex\execute(), SpecialBlockList\execute(), SpecialListGroupRights\execute(), MovePageForm\execute(), LinkSearchPage\execute(), SpecialLog\execute(), SpecialComparePages\execute(), SpecialVersion\execute(), SpecialBookSources\execute(), SpecialImport\execute(), SpecialEditWatchlist\execute(), MIMEsearchPage\execute(), UserrightsPage\execute(), SpecialMergeHistory\execute(), FileDuplicateSearchPage\execute(), SpecialEmailUser\execute(), SpecialRevisionDelete\execute(), SpecialRecentChanges\execute(), DeletedContributionsPage\execute(), SpecialListUsers\execute(), and SpecialUploadStash\showUploads().

static SpecialPage::removePage ( $ name ) [static]

Remove a special page from the list Formerly used to disable expensive or dangerous special pages.

The preferred method is now to add a SpecialPage_initList hook.

Deprecated:: since 1.18

Parameters:

$name String the page to remove

Definition at line 152 of file SpecialPage.php.

static SpecialPage::resolveAlias ( $ alias ) [static]

Given a special page alias, return the special page name.

Returns false if there is no such alias.

Parameters:

$alias String

Returns:: String or false

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 88 of file SpecialPage.php.

static SpecialPage::resolveAliasWithSubpage ( $ alias ) [static]

Given a special page name with a possible subpage, return an array where the first element is the special page name and the second is the subpage.

Parameters:

$alias String

Returns:: Array

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 103 of file SpecialPage.php.

SpecialPage::restriction ( $ x = null )

These mutators are very evil, as the relevant variables should not mutate.

So don't use them.

Parameters:

$x Mixed

Returns:: Mixed

Deprecated:: since 1.18

Definition at line 466 of file SpecialPage.php.

SpecialPage::run ( $ subPage ) [final]

Entry point.

Since:: 1.20

Parameters:

$subPage string|null

Definition at line 598 of file SpecialPage.php.

SpecialPage::setContext ( $ context )

Sets the context this SpecialPage is executed in.

Parameters:

$context IContextSource

Since:: 1.18

Definition at line 720 of file SpecialPage.php.

static SpecialPage::setGroup	(	$	page,
		$	group
	)		`[static]`

Add a page to a certain display group for Special:SpecialPages.

Parameters:

$page	Mixed: SpecialPage or string
$group	String

Deprecated:: since 1.18 call SpecialPageFactory method directly

Definition at line 127 of file SpecialPage.php.

SpecialPage::setHeaders ( )

Sets headers - this should be called from the execute() method of all derived classes!

Definition at line 584 of file SpecialPage.php.

SpecialPage::setListed ( $ listed )

Set whether this page is listed in Special:Specialpages, at run-time.

Since:: r3583 (v1.3)

Parameters:

$listed Bool

Returns:: Bool

Definition at line 429 of file SpecialPage.php.

SpecialPage::userCanExecute ( User $ user )

Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Can be overridden by sub- classes with more complicated permissions schemes.

Parameters:

$user User: the user to check

Returns:: Boolean: does the user have permission to view the page?

Reimplemented in SpecialUpload, UserrightsPage, and SpecialPasswordReset.

Definition at line 547 of file SpecialPage.php.

Referenced by DeletedContributionsPage\execute().

Member Data Documentation

IContextSource SpecialPage::$mContext [protected]

Current request context.

Definition at line 60 of file SpecialPage.php.

SpecialPage::$mFile [private]

Definition at line 49 of file SpecialPage.php.

SpecialPage::$mFunction [private]

Definition at line 46 of file SpecialPage.php.

SpecialPage::$mIncludable [protected]

Definition at line 55 of file SpecialPage.php.

SpecialPage::$mIncluding [protected]

Definition at line 52 of file SpecialPage.php.

SpecialPage::$mListed [private]

Definition at line 43 of file SpecialPage.php.

SpecialPage::$mLocalName [private]

Definition at line 36 of file SpecialPage.php.

SpecialPage::$mName [protected]

Definition at line 33 of file SpecialPage.php.

SpecialPage::$mRestriction [private]

Definition at line 40 of file SpecialPage.php.

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

includes/SpecialPage.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation