MediaWiki  master
RedirectSpecialPage Class Reference

Shortcut to construct a special page alias. More...

Inheritance diagram for RedirectSpecialPage:
Collaboration diagram for RedirectSpecialPage:

Public Member Functions

 execute ( $subpage)
 Stable to override. More...
 
 getRedirect ( $subpage)
 If the special page is a redirect, then get the Title object it redirects to. More...
 
 getRedirectQuery ( $subpage)
 Return part of the request string for a special redirect page This allows passing, e.g. More...
 
 personallyIdentifiableTarget ()
 Indicate if the target of this redirect can be used to identify a particular user of this wiki (e.g., if the redirect is to the user page of a User). More...
 
- Public Member Functions inherited from UnlistedSpecialPage
 __construct ( $name, $restriction='', $function=false, $file='default')
 Stable to call. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. More...
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page Stable to override. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 showNoRedirectPage ()
 Stable to override. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have Stable to override. More...
 
 getCacheTTL ()
 Stable to override. More...
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! Stable to override. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

 $mAddedRedirectParams = []
 
 $mAllowedRedirectParams = []
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 

Detailed Description

Shortcut to construct a special page alias.

Stable to extend

Definition at line 31 of file RedirectSpecialPage.php.

Member Function Documentation

◆ execute()

RedirectSpecialPage::execute (   $subpage)

Stable to override.

Parameters
string | null$subpage

Reimplemented from SpecialPage.

Definition at line 42 of file RedirectSpecialPage.php.

References SpecialPage\getOutput(), getRedirect(), getRedirectQuery(), showNoRedirectPage(), wfAppendQuery(), and wfScript().

◆ getRedirect()

RedirectSpecialPage::getRedirect (   $subpage)
abstract

If the special page is a redirect, then get the Title object it redirects to.

False otherwise.

Parameters
string | null$subpage
Returns
Title|bool

Reimplemented in SpecialRedirectToSpecial, SpecialDiff, SpecialMyLanguage, SpecialRedirectWithAction, SpecialMycontributions, SpecialAllMyUploads, SpecialMyuploads, SpecialMypage, SpecialMytalk, SpecialPermanentLink, SpecialNewSection, and SpecialFilepath.

Referenced by execute(), and RedirectSpecialArticle\getRedirectQuery().

◆ getRedirectQuery()

RedirectSpecialPage::getRedirectQuery (   $subpage)

Return part of the request string for a special redirect page This allows passing, e.g.

action=history to Special:Mypage, etc.

Stable to override

Parameters
string | null$subpage
Returns
array|bool

Reimplemented in RedirectSpecialArticle.

Definition at line 76 of file RedirectSpecialPage.php.

References SpecialPage\getRequest().

Referenced by execute().

◆ personallyIdentifiableTarget()

RedirectSpecialPage::personallyIdentifiableTarget ( )

Indicate if the target of this redirect can be used to identify a particular user of this wiki (e.g., if the redirect is to the user page of a User).

See T109724.

Stable to override

Since
1.27
Returns
bool

Reimplemented in SpecialMyLanguage, SpecialMypage, SpecialMytalk, SpecialAllMyUploads, SpecialMycontributions, and SpecialMyuploads.

Definition at line 108 of file RedirectSpecialPage.php.

◆ showNoRedirectPage()

RedirectSpecialPage::showNoRedirectPage ( )
protected

Stable to override.

Reimplemented in SpecialDiff, SpecialRedirectWithAction, SpecialPermanentLink, and SpecialNewSection.

Definition at line 115 of file RedirectSpecialPage.php.

Referenced by execute().

Member Data Documentation

◆ $mAddedRedirectParams

RedirectSpecialPage::$mAddedRedirectParams = []
protected

Definition at line 36 of file RedirectSpecialPage.php.

◆ $mAllowedRedirectParams

RedirectSpecialPage::$mAllowedRedirectParams = []
protected

Definition at line 33 of file RedirectSpecialPage.php.


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