MediaWiki  1.23.12
SpecialRedirect Class Reference

A special page that redirects to: the user for a numeric user id, the file for a given filename, or the page for a given revision id. More...

Inheritance diagram for SpecialRedirect:
Collaboration diagram for SpecialRedirect:

Public Member Functions

 __construct ()
 
 dispatch ()
 Use appropriate dispatch* method to obtain a redirection URL, and either: redirect, set a 404 error code and error message, or do nothing (if $mValue wasn't set) allowing the form to be displayed. More...
 
 dispatchFile ()
 Handle Special:Redirect/file/xxxx. More...
 
 dispatchPage ()
 Handle Special:Redirect/page/xxx (by redirecting to index.php?curid=xxx) More...
 
 dispatchRevision ()
 Handle Special:Redirect/revision/xxx (by redirecting to index.php?oldid=xxx) More...
 
 dispatchUser ()
 Handle Special:Redirect/user/xxxx (by redirecting to User:YYYY) More...
 
 onSubmit (array $data)
 Process the form on POST submission. More...
 
 onSuccess ()
 Do something exciting on successful processing of the form, most likely to show a confirmation message. More...
 
 setParameter ( $subpage)
 Set $mType and $mValue based on parsed value of $subpage. More...
 
- Public Member Functions inherited from FormSpecialPage
 execute ( $par)
 Basic SpecialPage workflow: get a form, send it to the user; get some data back,. More...
 
 requiresUnblock ()
 Whether this action cannot be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='default', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the <h1> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFile ()
 Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLang ()
 Shortcut to get user's language. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 msg ()
 Wrapper around wfMessage that sets the current context. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 requireLogin ( $reasonMsg=null, $titleMsg=null)
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 alterForm (HTMLForm $form)
 Play with the HTMLForm if you need to more substantially. More...
 
 getFormFields ()
 Get an HTMLForm descriptor array. More...
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
- Protected Member Functions inherited from FormSpecialPage
 checkExecutePermissions (User $user)
 Called from execute() to check if the given user can perform this action. More...
 
 getForm ()
 Get the HTMLForm to control behavior. More...
 
 getMessagePrefix ()
 Get message prefix for HTMLForm. More...
 
 postText ()
 Add post-text to the form. More...
 
 preText ()
 Add pre-text to the form. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 

Protected Attributes

string $mType
 
string $mValue
 
- Protected Attributes inherited from FormSpecialPage
string $par = null
 The sub-page of the special page. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 

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

Detailed Description

A special page that redirects to: the user for a numeric user id, the file for a given filename, or the page for a given revision id.

Since
1.22

Definition at line 32 of file SpecialRedirect.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialRedirect::__construct ( )

Definition at line 48 of file SpecialRedirect.php.

Member Function Documentation

◆ alterForm()

SpecialRedirect::alterForm ( HTMLForm  $form)
protected

Play with the HTMLForm if you need to more substantially.

Parameters
$formHTMLForm

Reimplemented from FormSpecialPage.

Definition at line 253 of file SpecialRedirect.php.

References FormSpecialPage\getMessagePrefix(), SpecialPage\outputHeader(), HTMLForm\setMethod(), and HTMLForm\setSubmitTextMsg().

◆ dispatch()

SpecialRedirect::dispatch ( )

Use appropriate dispatch* method to obtain a redirection URL, and either: redirect, set a 404 error code and error message, or do nothing (if $mValue wasn't set) allowing the form to be displayed.

Returns
bool true if a redirect was successfully handled.

Definition at line 167 of file SpecialRedirect.php.

References dispatchFile(), dispatchPage(), dispatchRevision(), dispatchUser(), FormSpecialPage\getMessagePrefix(), SpecialPage\getOutput(), and Status\newFatal().

Referenced by onSubmit().

◆ dispatchFile()

SpecialRedirect::dispatchFile ( )

Handle Special:Redirect/file/xxxx.

Returns
string|null url to redirect to, or null if $mValue is not found.

Definition at line 88 of file SpecialRedirect.php.

References $file, $title, array(), SpecialPage\getRequest(), Title\makeTitleSafe(), NS_FILE, and wfFindFile().

Referenced by dispatch().

◆ dispatchPage()

SpecialRedirect::dispatchPage ( )

Handle Special:Redirect/page/xxx (by redirecting to index.php?curid=xxx)

Returns
string|null url to redirect to, or null if $mValue is invalid.

Definition at line 144 of file SpecialRedirect.php.

References $mValue, array(), wfAppendQuery(), and wfScript().

Referenced by dispatch().

◆ dispatchRevision()

SpecialRedirect::dispatchRevision ( )

Handle Special:Redirect/revision/xxx (by redirecting to index.php?oldid=xxx)

Returns
string|null url to redirect to, or null if $mValue is invalid.

Definition at line 124 of file SpecialRedirect.php.

References $mValue, array(), wfAppendQuery(), and wfScript().

Referenced by dispatch().

◆ dispatchUser()

SpecialRedirect::dispatchUser ( )

Handle Special:Redirect/user/xxxx (by redirecting to User:YYYY)

Returns
string|null url to redirect to, or null if $mValue is invalid.

Definition at line 69 of file SpecialRedirect.php.

References $user, Title\makeTitle(), User\newFromId(), NS_USER, and PROTO_CURRENT.

Referenced by dispatch().

◆ getFormFields()

SpecialRedirect::getFormFields ( )
protected

Get an HTMLForm descriptor array.

Returns
Array

Reimplemented from FormSpecialPage.

Definition at line 203 of file SpecialRedirect.php.

References $mType, $mValue, $n, array(), as, FormSpecialPage\getMessagePrefix(), and SpecialPage\msg().

◆ getGroupName()

SpecialRedirect::getGroupName ( )
protected

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

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 263 of file SpecialRedirect.php.

◆ onSubmit()

SpecialRedirect::onSubmit ( array  $data)

Process the form on POST submission.

Parameters
$dataArray
Returns
Bool|Array true for success, false for didn't-try, array of errors on failure

Reimplemented from FormSpecialPage.

Definition at line 240 of file SpecialRedirect.php.

References dispatch(), and setParameter().

◆ onSuccess()

SpecialRedirect::onSuccess ( )

Do something exciting on successful processing of the form, most likely to show a confirmation message.

Since
1.22 Default is to do nothing

Reimplemented from FormSpecialPage.

Definition at line 249 of file SpecialRedirect.php.

◆ setParameter()

SpecialRedirect::setParameter (   $subpage)

Set $mType and $mValue based on parsed value of $subpage.

Reimplemented from FormSpecialPage.

Definition at line 57 of file SpecialRedirect.php.

Referenced by onSubmit().

Member Data Documentation

◆ $mType

string SpecialRedirect::$mType
protected

Definition at line 39 of file SpecialRedirect.php.

Referenced by getFormFields().

◆ $mValue

string SpecialRedirect::$mValue
protected

Definition at line 46 of file SpecialRedirect.php.

Referenced by dispatchPage(), dispatchRevision(), and getFormFields().


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