MediaWiki  REL1_19
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
SpecialPage Class Reference
SpecialPage

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

Inheritance diagram for SpecialPage:
Inheritance graph
[legend]

List of all members.

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

Protected Attributes

 $mContext
 $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 30 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:
$nameString: name of the special page, as seen in links and URLs
$restrictionString: user right required, e.g. "block" or "delete"
$listedBool: whether the page is listed in Special:Specialpages
$functionCallback|Bool: function called by execute(). By default it is constructed from $name
$fileString: file which is included by execute(). It is also constructed from $name by default
$includableBool: whether the page can be included in normal pages

Definition at line 328 of file SpecialPage.php.

References $file.

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:
$fNameString Name of called method
$aArray Arguments to the method
Deprecated:
since 1.17, call parent::__construct()

Definition at line 370 of file SpecialPage.php.

References $file, and wfDeprecated().

Here is the call graph for this function:

SpecialPage::addFeedLinks ( $  params) [protected]

Adds RSS/atom links.

Parameters:
$paramsarray

Definition at line 779 of file SpecialPage.php.

References $url, $wgFeedClasses, wfArrayToCGI(), and wfScript().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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:
$pageSpecialPage
Deprecated:
since 1.7, warnings in 1.17, might be removed in 1.20

Definition at line 117 of file SpecialPage.php.

References $page, SpecialPageFactory\getList(), and wfDeprecated().

Here is the call graph for this function:

SpecialPage::checkPermissions ( )

Checks if userCanExecute, and if not throws a PermissionsError.

Since:
1.19

Definition at line 566 of file SpecialPage.php.

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

Here is the caller graph for this function:

SpecialPage::checkReadOnly ( )

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

Since:
1.19
Exceptions:
ReadOnlyError

Definition at line 578 of file SpecialPage.php.

References wfReadOnly().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialPage::displayRestrictionError ( )

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

Definition at line 557 of file SpecialPage.php.

Referenced by DeletedContributionsPage\execute(), and QueryPage\execute().

Here is the caller graph for this function:

SpecialPage::execute ( $  par)

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:
$parString subpage string, if one was specified

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

Definition at line 602 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:
$titleTitle object
$contextIContextSource
$includingBool output is being captured for use in {{special:whatever}}
Returns:
Bool
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 248 of file SpecialPage.php.

References $title, SpecialPageFactory\executePath(), and wfDeprecated().

Here is the call graph for this function:

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

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

Parameters:
$nameString: 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 167 of file SpecialPage.php.

References SpecialPageFactory\exists(), and wfDeprecated().

Referenced by SpecialBlock\maybeAlterFormDefaults().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialPage::file ( $  x = null)

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

So don't use them.

Parameters:
$xMixed
Returns:
Mixed
Deprecated:
since 1.18

Definition at line 487 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialPage::func ( $  x = null)

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

So don't use them.

Parameters:
$xMixed
Returns:
Mixed
Deprecated:
since 1.18

Definition at line 478 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

Here is the call graph for this function:

SpecialPage::getContext ( )

Gets the context this SpecialPage is executed in.

Returns:
IContextSource|RequestContext
Since:
1.18

Definition at line 678 of file SpecialPage.php.

References RequestContext\getMain(), and wfDebug().

Referenced by LoginForm\addNewAccount(), LoginForm\authenticateUserData(), SpecialImport\doImport(), SpecialNewFiles\execute(), SpecialListFiles\execute(), SpecialCategories\execute(), SpecialPreferences\execute(), SpecialChangePassword\execute(), SpecialUnblock\execute(), SpecialWatchlist\execute(), SpecialContributions\execute(), SpecialBlockList\execute(), SpecialComparePages\execute(), SpecialEmailUser\execute(), SpecialActiveUsers\execute(), DeletedContributionsPage\execute(), SpecialListUsers\execute(), FormSpecialPage\getForm(), SpecialRevisionDelete\getList(), SpecialEditWatchlist\getNormalForm(), SpecialEditWatchlist\getRawForm(), DeletedContributionsPage\getSubTitle(), SpecialUpload\getUploadForm(), SpecialContributions\getUserLinks(), LoginForm\processLogin(), LoginForm\resetLoginForm(), SpecialUndelete\showDiff(), SpecialPreferences\showResetForm(), SpecialUploadStash\showUploads(), and SpecialRecentChanges\webOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Definition at line 648 of file SpecialPage.php.

Referenced by SpecialNewpages\feedTitle(), and QueryPage\feedTitle().

Here is the caller graph for this function:

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 412 of file SpecialPage.php.

References wfDeprecated().

Here is the call graph for this function:

SpecialPage::getFullTitle ( )

Return the full title, including $par.

Returns:
Title
Since:
1.18

Definition at line 755 of file SpecialPage.php.

Referenced by SpecialRevisionDelete\execute().

Here is the caller graph for this function:

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

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

Parameters:
$pageSpecialPage
Returns:
null
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 142 of file SpecialPage.php.

References $page, SpecialPageFactory\getGroup(), and wfDeprecated().

Referenced by SpecialSpecialpages\getPageGroups().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialPage::getLang ( )

Shortcut to get user's language.

Deprecated:
1.19 Use getLanguage instead
Returns:
Language
Since:
1.18

Definition at line 734 of file SpecialPage.php.

References wfDeprecated().

Here is the call graph for this function:

SpecialPage::getLanguage ( )

Shortcut to get user's language.

Returns:
Language
Since:
1.19

Definition at line 745 of file SpecialPage.php.

Referenced by SpecialEditWatchlist\buildRemoveLine(), SpecialVersion\compare(), SpecialContributions\contributionsSub(), SpecialWatchlist\cutoffLinks(), SpecialWatchlist\daysLink(), SpecialUndelete\diffHeader(), MovePageForm\doSubmit(), SpecialTags\doTagRow(), SpecialWatchlist\execute(), SpecialBlockList\execute(), LinkSearchPage\execute(), FileDuplicateSearchPage\execute(), SpecialActiveUsers\execute(), QueryPage\execute(), SpecialNewpages\filterLinks(), SpecialUndelete\formatFileRow(), SpecialListGroupRights\formatPermissions(), WantedCategoriesPage\formatResult(), PopularPagesPage\formatResult(), MostcategoriesPage\formatResult(), AncientPagesPage\formatResult(), UnusedtemplatesPage\formatResult(), UnwatchedpagesPage\formatResult(), FewestrevisionsPage\formatResult(), MostlinkedCategoriesPage\formatResult(), DoubleRedirectsPage\formatResult(), ShortPagesPage\formatResult(), BrokenRedirectsPage\formatResult(), MIMEsearchPage\formatResult(), MostlinkedPage\formatResult(), MostlinkedTemplatesPage\formatResult(), ListredirectsPage\formatResult(), DisambiguationsPage\formatResult(), FileDuplicateSearchPage\formatResult(), WantedQueryPage\formatResult(), SpecialMergeHistory\formatRevisionRow(), SpecialUndelete\formatRevisionRow(), SpecialProtectedtitles\formatRow(), SpecialProtectedpages\formatRow(), SpecialNewpages\formatRow(), ContribsPager\formatRow(), SpecialSearch\formHeader(), SpecialStatistics\getEditStats(), SpecialUndelete\getFileLink(), SpecialWhatLinksHere\getFilterPanel(), SpecialStatistics\getGroupStats(), SpecialStatistics\getMostViewedPages(), SpecialEditWatchlist\getNormalForm(), SpecialStatistics\getOtherStats(), SpecialUndelete\getPageLink(), SpecialStatistics\getPageStats(), SpecialWhatLinksHere\getPrevNext(), DeletedContributionsPage\getSubTitle(), SpecialStatistics\getUserStats(), SpecialStatistics\getViewsStats(), SpecialWatchlist\hoursLink(), SpecialWhatLinksHere\listItem(), SpecialVersion\listToText(), LoginForm\makeLanguageSelector(), SpecialRecentChanges\optionsPanel(), SpecialNewpages\parseParams(), SpecialUpload\processVerificationError(), SpecialAllpages\showChunk(), SpecialRevisionDelete\showConvenienceLinks(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), MovePageForm\showForm(), SpecialRevisionDelete\showForm(), SpecialSearch\showHit(), SpecialUndelete\showList(), EmailConfirmation\showRequestForm(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), MovePageForm\showSubpages(), and SpecialRevisionDelete\tryShowFile().

SpecialPage::getLocalName ( )

Get the localised name of the special page.

Definition at line 510 of file SpecialPage.php.

References SpecialPageFactory\getLocalNameFor().

Here is the call graph for this function:

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

Get the local name for a specified canonical name.

Parameters:
$nameString
$subpageMixed: boolean false, or string
Returns:
String
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 262 of file SpecialPage.php.

References SpecialPageFactory\getLocalNameFor(), and wfDeprecated().

Here is the call graph for this function:

SpecialPage::getName ( )

Get the name of this Special Page.

Returns:
String

Definition at line 393 of file SpecialPage.php.

Referenced by LoginForm\authenticateUserData(), SpecialRecentChanges\buildMainQueryConds(), LoginForm\displaySuccessfulLogin(), SpecialEditWatchlist\execute(), RandomPage\execute(), QueryPage\execute(), QueryPage\fetchFromCache(), QueryPage\getCachedTimestamp(), FormSpecialPage\getForm(), SpecialEmailUser\getFormFields(), SpecialMypage\getRedirect(), SpecialMytalk\getRedirect(), SpecialMycontributions\getRedirect(), SpecialMyuploads\getRedirect(), SpecialLockdb\onSubmit(), and QueryPage\recache().

Here is the caller graph for this function:

SpecialPage::getOutput ( )

Get the OutputPage being used for this instance.

Returns:
OutputPage
Since:
1.18

Definition at line 703 of file SpecialPage.php.

Referenced by SpecialLog\addHeader(), LoginForm\addNewAccount(), LoginForm\addNewAccountMailPassword(), SpecialRecentChanges\addRecentChangesJS(), SpecialRevisionDelete\addUsageText(), SpecialChangeEmail\attemptChange(), EmailConfirmation\attemptConfirm(), EmailInvalidation\attemptInvalidate(), SpecialRecentChanges\checkLastModified(), SpecialContributions\contributionsSub(), LoginForm\cookieRedirectCheck(), LoginForm\displaySuccessfulLogin(), QueryPage\doFeed(), SpecialRecentChanges\doHeader(), SpecialImport\doImport(), SpecialRecentchangeslinked\doMainQuery(), LinkSearchPage\doQuery(), SpecialChangeEmail\doReturnTo(), SpecialChangePassword\doReturnTo(), MovePageForm\doSubmit(), UserrightsPage\editUserGroupsForm(), SpecialChangeEmail\error(), SpecialChangePassword\error(), SpecialJavaScriptTest\execute(), SpecialNewFiles\execute(), SpecialListFiles\execute(), SpecialCategories\execute(), SpecialEditWatchlist\execute(), SpecialPreferences\execute(), SpecialBlankpage\execute(), SpecialFilepath\execute(), SpecialSpecialpages\execute(), SpecialBlockme\execute(), SpecialUserlogout\execute(), SpecialWatchlist\execute(), SpecialChangePassword\execute(), SpecialUnblock\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialTags\execute(), SpecialContributions\execute(), SpecialStatistics\execute(), SpecialPrefixindex\execute(), SpecialExport\execute(), SpecialChangeEmail\execute(), SpecialBlockList\execute(), SpecialListGroupRights\execute(), LinkSearchPage\execute(), EmailConfirmation\execute(), SpecialWhatLinksHere\execute(), SpecialAllmessages\execute(), SpecialVersion\execute(), SpecialBookSources\execute(), RandomPage\execute(), SpecialAllpages\execute(), MIMEsearchPage\execute(), UserrightsPage\execute(), SpecialSearch\execute(), SpecialMergeHistory\execute(), SpecialEmailUser\execute(), FileDuplicateSearchPage\execute(), SpecialRevisionDelete\execute(), SpecialNewpages\execute(), SpecialRecentChanges\execute(), SpecialActiveUsers\execute(), DeletedContributionsPage\execute(), SpecialListUsers\execute(), QueryPage\execute(), SpecialUndelete\execute(), RedirectSpecialPage\execute(), SpecialRevisionDelete\failure(), SpecialNewpages\feed(), SpecialNewpages\form(), DeletedContributionsPage\getSubTitle(), SpecialUpload\getUploadForm(), SpecialSearch\goResult(), SpecialJavaScriptTest\initQUnitTesting(), LoginForm\mainLoginForm(), SpecialMergeHistory\merge(), SpecialUnlockdb\onSuccess(), SpecialLockdb\onSuccess(), SpecialPasswordReset\onSuccess(), SpecialSpecialpages\outputPageList(), SpecialUpload\processUpload(), LoginForm\resetLoginForm(), UserrightsPage\saveUserGroups(), SpecialRecentchangeslinked\setBottomText(), SpecialRecentchangeslinked\setTopText(), SpecialRecentChanges\setTopText(), SpecialSearch\setupPage(), SpecialLog\show(), SpecialAllpages\showChunk(), SpecialRevisionDelete\showConvenienceLinks(), SpecialSearch\showCreateLink(), SpecialUndelete\showDiff(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFile(), SpecialUndelete\showFileConfirmationForm(), SpecialFilepath\showForm(), SpecialChangeEmail\showForm(), MovePageForm\showForm(), SpecialChangePassword\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialWhatLinksHere\showIndirectLinks(), FileDuplicateSearchPage\showList(), SpecialBlockList\showList(), SpecialBookSources\showList(), SpecialUndelete\showList(), MovePageForm\showLogFragment(), SpecialMergeHistory\showMergeForm(), SpecialPrefixindex\showPrefixChunk(), EmailConfirmation\showRequestForm(), SpecialPreferences\showResetForm(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), MovePageForm\showSubpages(), SpecialAllpages\showToplevel(), SpecialUploadStash\showUpload(), SpecialUpload\showUploadForm(), SpecialUploadStash\showUploads(), SpecialUpload\showViewDeletedLinks(), SpecialRevisionDelete\submit(), SpecialPreferences\submitReset(), SpecialRevisionDelete\success(), LoginForm\successfulLogin(), UserrightsPage\switchForm(), SpecialRevisionDelete\tryShowFile(), SpecialUndelete\undelete(), SpecialUpload\unsaveUploadedFile(), LoginForm\userBlockedMessage(), and SpecialRecentChanges\webOutput().

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

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

Parameters:
$nameString
Returns:
SpecialPage object or null if the page doesn't exist
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 179 of file SpecialPage.php.

References SpecialPageFactory\getPage(), and wfDeprecated().

Here is the call graph for this function:

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

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

Parameters:
$aliasString
Returns:
SpecialPage object or null if the page doesn't exist
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 192 of file SpecialPage.php.

References SpecialPageFactory\getPage(), and wfDeprecated().

Here is the call graph for this function:

static SpecialPage::getRegularPages ( ) [static]

Return categorised listable special pages for all users.

Returns:
Associative array mapping page's name to its SpecialPage object
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 217 of file SpecialPage.php.

References SpecialPageFactory\getRegularPages(), and wfDeprecated().

Here is the call graph for this function:

SpecialPage::getRequest ( )

Get the WebRequest being used for this instance.

Returns:
WebRequest
Since:
1.18

Definition at line 693 of file SpecialPage.php.

Referenced by LoginForm\addNewAccountInternal(), SpecialBlock\alterForm(), SpecialRevisionDelete\buildCheckBoxes(), SpecialImport\doImport(), SpecialChangeEmail\doReturnTo(), SpecialChangePassword\doReturnTo(), SpecialListFiles\execute(), SpecialCategories\execute(), SpecialPreferences\execute(), SpecialEditWatchlist\execute(), SpecialBlockme\execute(), SpecialFilepath\execute(), SpecialChangePassword\execute(), SpecialWatchlist\execute(), WithoutInterwikiPage\execute(), SpecialUnblock\execute(), SpecialProtectedpages\execute(), SpecialProtectedtitles\execute(), SpecialContributions\execute(), SpecialPrefixindex\execute(), SpecialExport\execute(), SpecialBlockList\execute(), SpecialChangeEmail\execute(), MovePageForm\execute(), LinkSearchPage\execute(), SpecialLog\execute(), SpecialAllmessages\execute(), SpecialWhatLinksHere\execute(), SpecialVersion\execute(), SpecialBookSources\execute(), SpecialImport\execute(), RandomPage\execute(), SpecialAllpages\execute(), MIMEsearchPage\execute(), UserrightsPage\execute(), SpecialSearch\execute(), SpecialEmailUser\execute(), FileDuplicateSearchPage\execute(), SpecialRevisionDelete\execute(), SpecialRecentChanges\execute(), DeletedContributionsPage\execute(), QueryPage\execute(), SpecialRevisionDelete\extractBitParams(), SpecialRecentchangeslinked\feedSetup(), SpecialRecentChanges\feedSetup(), FormSpecialPage\getForm(), SpecialRecentChanges\getOptions(), RedirectSpecialPage\getRedirectQuery(), LoginForm\hasSessionCookie(), SpecialVersion\IPInfo(), LoginForm\load(), SpecialSearch\load(), SpecialUpload\loadRequest(), SpecialUndelete\loadRequest(), SpecialMergeHistory\loadRequestParams(), LoginForm\mailPasswordInternal(), LoginForm\mainLoginForm(), SpecialBlock\maybeAlterFormDefaults(), SpecialPasswordReset\onSubmit(), LoginForm\processLogin(), UserrightsPage\saveUserGroups(), SpecialBlock\setParameter(), SpecialNewpages\setup(), SpecialRecentChanges\setup(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFile(), SpecialChangeEmail\showForm(), 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:
Associative array mapping page's name to its SpecialPage object
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 229 of file SpecialPage.php.

References SpecialPageFactory\getRestrictedPages(), and wfDeprecated().

Here is the call graph for this function:

SpecialPage::getRestriction ( )

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

Returns:
String

Definition at line 401 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:
$nameString
$subpageString|Bool subpage string, or false to not use a subpage
Returns:
Title object or null if the page doesn't exist

Definition at line 290 of file SpecialPage.php.

References SpecialPageFactory\getLocalNameFor(), and Title\makeTitleSafe().

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

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialPage::getSkin ( )

Shortcut to get the skin being used for this instance.

Returns:
Skin
Since:
1.18

Definition at line 723 of file SpecialPage.php.

Referenced by SpecialEditWatchlist\buildRemoveLine(), SpecialContributions\execute(), SpecialWhatLinksHere\execute(), QueryPage\execute(), SpecialUndelete\execute(), SpecialBlock\setParameter(), SpecialLog\show(), and MovePageForm\showForm().

Here is the caller graph for this function:

SpecialPage::getTitle ( $  subpage = false)

Get a self-referential title object.

Parameters:
$subpageString|Bool
Returns:
Title object

Definition at line 658 of file SpecialPage.php.

Referenced by LoginForm\addNewAccount(), LoginForm\addNewAccountInternal(), SpecialWatchlist\daysLink(), SpecialUndelete\diffHeader(), SpecialRecentChanges\doHeader(), SpecialJavaScriptTest\execute(), SpecialPreferences\execute(), SpecialEditWatchlist\execute(), SpecialWatchlist\execute(), SpecialExport\execute(), LinkSearchPage\execute(), EmailConfirmation\execute(), SpecialWhatLinksHere\execute(), SpecialImport\execute(), SpecialEmailUser\execute(), FileDuplicateSearchPage\execute(), QueryPage\execute(), SpecialNewpages\feed(), QueryPage\feedUrl(), SpecialNewpages\filterLinks(), SpecialNewpages\form(), SpecialUndelete\formatFileRow(), SpecialUndelete\formatRevisionRow(), SpecialUpload\getExistsWarning(), SpecialRecentchangeslinked\getFeedObject(), SpecialRecentChanges\getFeedObject(), SpecialContributions\getForm(), DeletedContributionsPage\getForm(), SpecialJavaScriptTest\getFrameworkListHtml(), SpecialEditWatchlist\getNormalForm(), WithoutInterwikiPage\getPageHeader(), SpecialEditWatchlist\getRawForm(), UserrightsPage\getSuccessURL(), SpecialUpload\getUploadForm(), SpecialWatchlist\hoursLink(), LoginForm\mainLoginForm(), SpecialBookSources\makeForm(), LoginForm\makeLanguageSelectorLink(), SpecialRecentChanges\makeOptionsLink(), SpecialSearch\makeSearchLink(), SpecialAllpages\namespaceForm(), SpecialPrefixindex\namespacePrefixForm(), SpecialSearch\shortDialog(), SpecialAllpages\showChunk(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), SpecialFilepath\showForm(), SpecialChangeEmail\showForm(), MovePageForm\showForm(), SpecialChangePassword\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialWatchlist\showHideLink(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialAllpages\showline(), SpecialUndelete\showList(), SpecialMergeHistory\showMergeForm(), SpecialProtectedtitles\showOptions(), SpecialProtectedpages\showOptions(), SpecialPrefixindex\showPrefixChunk(), EmailConfirmation\showRequestForm(), SpecialPreferences\showResetForm(), SpecialSearch\showResults(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), SpecialAllpages\showToplevel(), SpecialUploadStash\showUploads(), UserrightsPage\switchForm(), SpecialRevisionDelete\tryShowFile(), SpecialEmailUser\userForm(), SpecialWhatLinksHere\whatlinkshereForm(), and SpecialWhatLinksHere\wlhLink().

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

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

Parameters:
$nameString
$subpageString|Bool subpage string, or false to not use a subpage
Returns:
Title object

Definition at line 274 of file SpecialPage.php.

References SpecialPageFactory\getLocalNameFor(), and Title\makeTitle().

Referenced by EmailConfirmation\attemptConfirm(), Linker\blockLink(), SkinTemplate\buildContentNavigationUrls(), SkinTemplate\buildNavUrls(), SkinTemplate\buildPersonalUrls(), SpecialEditWatchlist\buildRemoveLine(), SpecialEditWatchlist\buildTools(), Title\checkReadPermissions(), LoginForm\cookieRedirectCheck(), DifferenceEngine\deletedLink(), SpecialTags\doTagRow(), Linker\emailLink(), LegacyTemplate\emailUserLink(), SpecialEditWatchlist\execute(), SpecialWatchlist\execute(), SpecialBlockList\execute(), SpecialListGroupRights\execute(), ApiFeedContributions\execute(), EmailConfirmation\execute(), ApiFeedWatchlist\execute(), MIMEsearchPage\execute(), UnusedtemplatesPage\formatResult(), SpecialProtectedpages\formatRow(), DeletedContribsPager\formatRow(), BlockListPager\formatValue(), PreferencesForm\getButtons(), HistoryAction\getDescription(), RevDel_ArchiveItem\getDiffLink(), SpecialUpload\getExistsWarning(), SpecialStatistics\getGroupStats(), OutputPage\getHeadLinks(), RevDel_LogItem\getHTML(), RevDel_FileItem\getLink(), RevDel_ArchivedFileItem\getLink(), RevisionDeleter\getLogLinks(), SearchEngine\getNearMatchInternal(), SpecialStatistics\getPageStats(), SpecialRedirectToSpecial\getRedirect(), SpecialMycontributions\getRedirect(), SpecialMyuploads\getRedirect(), RevDel_ArchiveItem\getRevisionLink(), Skin\getSearchLink(), LogEventsList\getShowHideLinks(), UploadStashFile\getSpecialUrl(), DeletedContributionsPage\getSubTitle(), ProtectedTitlesPager\getTitle(), AllmessagesTablePager\getTitle(), SpecialPageFactory\getTitleForAlias(), Skin\getUndeleteLink(), LegacyTemplate\getUploadLink(), ImagePage\getUploadUrl(), Linker\getUploadUrl(), SpecialContributions\getUserLinks(), SpecialStatistics\getUserStats(), ImageHistoryList\imageHistoryLine(), CreditsAction\link(), LogEventsList\logActionLinks(), Parser\magicLinkCallback(), MostlinkedPage\makeWlhLink(), MostlinkedTemplatesPage\makeWlhLink(), WantedQueryPage\makeWlhLink(), LegacyTemplate\moveThisPage(), LegacyTemplate\nameAndLogin(), Linker\normaliseSpecialPage(), MarkpatrolledAction\onView(), ImagePage\openShowImage(), SkinTemplate\outputPage(), MediaWiki\parseTitle(), MediaWiki\performRequest(), SpecialBlock\postText(), Preferences\profilePreferences(), ManualLogEntry\publish(), StandardTemplate\quickBar(), CologneBlueTemplate\quickBar(), EnhancedChangesList\recentChangesBlockLine(), EnhancedChangesList\recentChangesLine(), Linker\revDeleteLink(), LogPage\saveContent(), SpecialRevisionDelete\showConvenienceLinks(), SpecialSearch\showHit(), LogEventsList\showOptions(), OutputPage\showPermissionsErrorPage(), SpecialSearch\showResults(), SpecialUpload\showViewDeletedLinks(), CoreParserFunctions\special(), Linker\specialLink(), SpecialPreferences\submitReset(), CologneBlueTemplate\sysLinks(), ExtraParserTest\testTrackingCategorySpecial(), LegacyTemplate\userContribsLink(), Linker\userLink(), Linker\userToolLinks(), LegacyTemplate\watchPageLinksLink(), wfProxyCheck(), and LegacyTemplate\whatLinksHere().

Here is the call graph for this function:

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

Get a title for a given alias.

Parameters:
$aliasString
Returns:
Title or null if there is no such alias
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 306 of file SpecialPage.php.

References SpecialPageFactory\getTitleForAlias(), and wfDeprecated().

Here is the call graph for this function:

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

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

Parameters:
$userUser object to check permissions, $wgUser will be used if not provided
Returns:
Associative array mapping page's name to its SpecialPage object
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 206 of file SpecialPage.php.

References $user, SpecialPageFactory\getUsablePages(), and wfDeprecated().

Referenced by SpecialSpecialpages\getPageGroups().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialPage::getUser ( )

Shortcut to get the User executing this instance.

Returns:
User
Since:
1.18

Definition at line 713 of file SpecialPage.php.

Referenced by LoginForm\addNewAccount(), LoginForm\addNewAccountInternal(), SpecialRevisionDelete\addUsageText(), LoginForm\attemptAutoCreate(), EmailConfirmation\attemptConfirm(), EmailInvalidation\attemptInvalidate(), LoginForm\authenticateUserData(), SpecialRecentChanges\buildMainQueryConds(), UserrightsPage\changeableGroups(), SpecialRecentChanges\checkLastModified(), SpecialEditWatchlist\cleanupWatchlist(), SpecialEditWatchlist\clearWatchlist(), SpecialWatchlist\countItems(), SpecialUndelete\diffHeader(), LoginForm\displaySuccessfulLogin(), SpecialImport\doImport(), SpecialRecentchangeslinked\doMainQuery(), SpecialRecentChanges\doMainQuery(), UserrightsPage\doSaveUserGroups(), MovePageForm\doSubmit(), SpecialPreferences\execute(), SpecialEditWatchlist\execute(), SpecialUserlogout\execute(), SpecialChangePassword\execute(), SpecialWatchlist\execute(), SpecialContributions\execute(), SpecialChangeEmail\execute(), MovePageForm\execute(), EmailConfirmation\execute(), SpecialLog\execute(), SpecialImport\execute(), UserrightsPage\execute(), SpecialEmailUser\execute(), SpecialRevisionDelete\execute(), SpecialUpload\execute(), DeletedContributionsPage\execute(), QueryPage\execute(), SpecialUndelete\execute(), FormSpecialPage\execute(), UserrightsPage\fetchUser(), SpecialNewpages\filterLinks(), SpecialUndelete\formatFileRow(), UnwatchedpagesPage\formatResult(), BrokenRedirectsPage\formatResult(), FileDuplicateSearchPage\formatResult(), SpecialUndelete\formatRevisionRow(), SpecialProtectedpages\formatRow(), ContribsPager\formatRow(), SpecialRecentChanges\getDefaultOptions(), LoginForm\getDescription(), SpecialUndelete\getFileLink(), SpecialEmailUser\getFormFields(), SpecialPasswordReset\getFormFields(), SpecialBlock\getFormFields(), SpecialSpecialpages\getPageGroups(), SpecialUndelete\getPageLink(), ContribsPager\getQueryInfo(), SpecialMypage\getRedirect(), SpecialMytalk\getRedirect(), SpecialMycontributions\getRedirect(), SpecialMyuploads\getRedirect(), DeletedContributionsPage\getSubTitle(), SpecialContributions\getUserLinks(), SpecialUpload\getWatchCheck(), SpecialEditWatchlist\getWatchlist(), SpecialEditWatchlist\getWatchlistInfo(), SpecialPasswordReset\isListed(), SpecialSearch\load(), SpecialUpload\loadRequest(), SpecialUndelete\loadRequest(), SpecialMergeHistory\loadRequestParams(), LoginForm\mailPasswordInternal(), LoginForm\mainLoginForm(), SpecialLockdb\onSubmit(), SpecialPasswordReset\onSubmit(), SpecialPasswordReset\onSuccess(), SpecialRecentChanges\optionsPanel(), SpecialNewpages\patrollable(), LoginForm\processLogin(), SpecialUpload\processUpload(), SpecialNewpages\setup(), SpecialRevisionDelete\showConvenienceLinks(), UserrightsPage\showEditUserGroupsForm(), SpecialUndelete\showFileConfirmationForm(), SpecialChangeEmail\showForm(), MovePageForm\showForm(), SpecialChangePassword\showForm(), SpecialImport\showForm(), SpecialRevisionDelete\showForm(), SpecialMergeHistory\showHistory(), SpecialUndelete\showHistory(), SpecialBlockList\showList(), EmailConfirmation\showRequestForm(), SpecialUndelete\showRevision(), SpecialUpload\showViewDeletedLinks(), SpecialRevisionDelete\submit(), SpecialEditWatchlist\submitRaw(), SpecialPreferences\submitReset(), LoginForm\successfulCreation(), LoginForm\successfulLogin(), SpecialRevisionDelete\tryShowFile(), SpecialUndelete\undelete(), 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:
$xMixed
Returns:
Mixed
Deprecated:
since 1.18

Definition at line 496 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

Here is the call graph for this function:

SpecialPage::including ( $  x = null)

Whether the special page is being evaluated via transclusion.

Parameters:
$xBool
Returns:
Bool

Definition at line 503 of file SpecialPage.php.

References wfSetVar().

Referenced by SpecialRecentchangeslinked\doMainQuery(), SpecialRecentChanges\doMainQuery(), SpecialNewFiles\execute(), SpecialListFiles\execute(), WantedPagesPage\execute(), SpecialPrefixindex\execute(), SpecialNewpages\execute(), SpecialRecentChanges\execute(), SpecialNewpages\formatRow(), SpecialRecentChanges\getOptions(), SpecialAllpages\showChunk(), SpecialPrefixindex\showPrefixChunk(), SpecialAllpages\showToplevel(), and SpecialRecentChanges\webOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

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:
$nameString: name of the special page, as seen in links and URLs
$restrictionString: user right required, e.g. "block" or "delete"
$listedBool: whether the page is listed in Special:Specialpages
$functionCallback|Bool: function called by execute(). By default it is constructed from $name
$fileString: file which is included by execute(). It is also constructed from $name by default
$includableBool: whether the page can be included in normal pages

Definition at line 345 of file SpecialPage.php.

References $file.

static SpecialPage::initAliasList ( ) [static]
Deprecated:
since 1.18

Definition at line 77 of file SpecialPage.php.

References wfDeprecated().

Here is the call graph for this function:

static SpecialPage::initList ( ) [static]

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

Deprecated:
since 1.18

Definition at line 69 of file SpecialPage.php.

References wfDeprecated().

Here is the call graph for this function:

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, UnusedtemplatesPage, UnwatchedpagesPage, ListredirectsPage, MIMEsearchPage, BrokenRedirectsPage, DoubleRedirectsPage, FewestrevisionsPage, AncientPagesPage, DisambiguationsPage, PopularPagesPage, UnusedimagesPage, and UnusedCategoriesPage.

Definition at line 525 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 449 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 423 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 536 of file SpecialPage.php.

References $wgGroupPermissions.

SpecialPage::listed ( $  x = null)

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

Since:
r11308 (v1.6)
Parameters:
$xBool
Returns:
Bool

Definition at line 441 of file SpecialPage.php.

References wfSetVar().

Here is the call graph for this function:

SpecialPage::msg ( )

Wrapper around wfMessage that sets the current context.

Returns:
Message
See also:
wfMessage

Definition at line 765 of file SpecialPage.php.

Referenced by ContribsPager\__construct(), LoginForm\addNewAccount(), LoginForm\addNewAccountInternal(), LoginForm\addNewAccountMailPassword(), SpecialUnlockdb\alterForm(), SpecialLockdb\alterForm(), SpecialChangePassword\attemptReset(), SpecialEditWatchlist\buildRemoveLine(), SpecialComparePages\checkExistingRevision(), SpecialComparePages\checkExistingTitle(), SpecialContributions\contributionsSub(), SpecialWatchlist\cutoffLinks(), SpecialWatchlist\daysLink(), SpecialUndelete\diffHeader(), LoginForm\displaySuccessfulLogin(), SpecialRecentchangeslinked\doMainQuery(), SpecialCategories\execute(), SpecialEditWatchlist\execute(), SpecialBlockme\execute(), SpecialUnblock\execute(), SpecialChangePassword\execute(), SpecialWatchlist\execute(), SpecialTags\execute(), SpecialContributions\execute(), SpecialPrefixindex\execute(), SpecialBlockList\execute(), EmailConfirmation\execute(), SpecialWhatLinksHere\execute(), SpecialAllpages\execute(), SpecialEmailUser\execute(), FileDuplicateSearchPage\execute(), DeletedContributionsPage\execute(), QueryPage\execute(), SpecialUndelete\execute(), SpecialRevisionDelete\failure(), QueryPage\feedDesc(), SpecialUndelete\formatFileRow(), WantedCategoriesPage\formatResult(), PopularPagesPage\formatResult(), MostcategoriesPage\formatResult(), FewestrevisionsPage\formatResult(), MostlinkedCategoriesPage\formatResult(), DoubleRedirectsPage\formatResult(), ShortPagesPage\formatResult(), BrokenRedirectsPage\formatResult(), MostlinkedPage\formatResult(), DisambiguationsPage\formatResult(), WantedQueryPage\formatResult(), SpecialUndelete\formatRevisionRow(), SpecialNewpages\formatRow(), ContribsPager\formatRow(), MostimagesPage\getCellHtml(), LoginForm\getDescription(), SpecialUndelete\getFileComment(), SpecialUndelete\getFileUser(), SpecialContributions\getForm(), DeletedContributionsPage\getForm(), FormSpecialPage\getForm(), SpecialBlock\getFormFields(), SpecialEditWatchlist\getNormalForm(), DeadendPagesPage\getPageHeader(), UnusedCategoriesPage\getPageHeader(), DisambiguationsPage\getPageHeader(), BrokenRedirectsPage\getPageHeader(), DoubleRedirectsPage\getPageHeader(), DisambiguationsPage\getQueryInfo(), SpecialEditWatchlist\getRawForm(), DeletedContributionsPage\getSubTitle(), SpecialContributions\getUserLinks(), LoginForm\mailPasswordInternal(), LoginForm\mainLoginForm(), SpecialBookSources\makeForm(), LoginForm\makeLanguageSelector(), MostlinkedTemplatesPage\makeWlhLink(), WantedQueryPage\makeWlhLink(), SpecialAllpages\namespaceForm(), LoginForm\onCookieRedirectCheck(), SpecialUnlockdb\onSuccess(), SpecialLockdb\onSuccess(), SpecialChangeEmail\pretty(), SpecialChangePassword\pretty(), LoginForm\processLogin(), SpecialSearch\setupPage(), SpecialAllpages\showChunk(), SpecialUndelete\showFileConfirmationForm(), SpecialChangeEmail\showForm(), MovePageForm\showForm(), SpecialChangePassword\showForm(), SpecialWatchlist\showHideLink(), SpecialUndelete\showHistory(), SpecialAllpages\showline(), SpecialBlockList\showList(), SpecialBookSources\showList(), SpecialUndelete\showList(), EmailConfirmation\showRequestForm(), SpecialUndelete\showRevision(), SpecialUndelete\showSearchForm(), SpecialEditWatchlist\showTitles(), SpecialAllpages\showToplevel(), SpecialEditWatchlist\submitNormal(), SpecialEditWatchlist\submitRaw(), SpecialRevisionDelete\success(), LoginForm\throttleHit(), SpecialUndelete\undelete(), and LoginForm\userBlockedMessage().

SpecialPage::name ( $  x = null)

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

So don't use them.

Parameters:
$xMixed
Returns:
Mixed
Deprecated:
since 1.18

Definition at line 460 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

Here is the call graph for this function:

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:
$summaryMessageKeyString: message key of the summary

Definition at line 623 of file SpecialPage.php.

References $wgContLang.

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

Here is the caller graph for this function:

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:
$nameString the page to remove

Definition at line 155 of file SpecialPage.php.

References SpecialPageFactory\getList(), and wfDeprecated().

Here is the call graph for this function:

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

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

Returns false if there is no such alias.

Parameters:
$aliasString
Returns:
String or false
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 90 of file SpecialPage.php.

References wfDeprecated().

Referenced by resolveAliasWithSubpage().

Here is the call graph for this function:

Here is the caller graph for this function:

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:
$aliasString
Returns:
Array
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 105 of file SpecialPage.php.

References resolveAlias().

Here is the call graph for this function:

SpecialPage::restriction ( $  x = null)

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

So don't use them.

Parameters:
$xMixed
Returns:
Mixed
Deprecated:
since 1.18

Definition at line 469 of file SpecialPage.php.

References wfDeprecated(), and wfSetVar().

Here is the call graph for this function:

SpecialPage::setContext ( $  context)

Sets the context this SpecialPage is executed in.

Parameters:
$contextIContextSource
Since:
1.18

Definition at line 668 of file SpecialPage.php.

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

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

Parameters:
$pageMixed: SpecialPage or string
$groupString
Returns:
null
Deprecated:
since 1.18 call SpecialPageFactory method directly

Definition at line 130 of file SpecialPage.php.

References $page, SpecialPageFactory\setGroup(), and wfDeprecated().

Here is the call graph for this function:

SpecialPage::setHeaders ( )

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

Definition at line 587 of file SpecialPage.php.

References $out.

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

SpecialPage::setListed ( $  listed)

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

Since:
r3583 (v1.3)
Parameters:
$listedBool
Returns:
Bool

Definition at line 432 of file SpecialPage.php.

References wfSetVar().

Here is the call graph for this function:

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:
$userUser: the user to check
Returns:
Boolean: does the user have permission to view the page?

Reimplemented in SpecialUpload, SpecialPasswordReset, and UserrightsPage.

Definition at line 550 of file SpecialPage.php.

References User\isAllowed().

Referenced by DeletedContributionsPage\execute(), and QueryPage\execute().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

SpecialPage::$mContext [protected]

Definition at line 62 of file SpecialPage.php.

SpecialPage::$mFile [private]

Definition at line 50 of file SpecialPage.php.

SpecialPage::$mFunction [private]

Definition at line 47 of file SpecialPage.php.

SpecialPage::$mIncludable [protected]

Definition at line 56 of file SpecialPage.php.

SpecialPage::$mIncluding [protected]

Definition at line 53 of file SpecialPage.php.

SpecialPage::$mListed [private]

Definition at line 44 of file SpecialPage.php.

SpecialPage::$mLocalName [private]

Definition at line 37 of file SpecialPage.php.

SpecialPage::$mName [protected]

Definition at line 34 of file SpecialPage.php.

SpecialPage::$mRestriction [private]

Definition at line 41 of file SpecialPage.php.

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