MediaWiki  master
SpecialDiff Class Reference

Redirect from Special:Diff/### to index.php?diff=### and from Special:Diff/###/### to index.php?oldid=###&diff=###. More...

Inheritance diagram for SpecialDiff:
Collaboration diagram for SpecialDiff:

Public Member Functions

 __construct ()
 
 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...
 
 getName ()
 Get the name of this Special Page. More...
 
 getRedirect ( $subpage)
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. More...
 
 onFormSubmit ( $formData)
 
- Public Member Functions inherited from RedirectSpecialPage
 execute ( $subpage)
 Stable to override. 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...
 
- 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...
 
 getContentLanguage ()
 Shortcut to get content language. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. 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...
 
 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...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. 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...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 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

 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...
 
 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...
 
 getAuthManager ()
 
 getCacheTTL ()
 Stable to override. 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...
 
 getSpecialPageFactory ()
 
 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, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. 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...
 

Private Member Functions

 showForm ()
 

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...
 
- Protected Attributes inherited from RedirectSpecialPage
array $mAddedRedirectParams = []
 Query parameters added by redirects. More...
 
array $mAllowedRedirectParams = []
 Query parameters that can be passed through redirects. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Detailed Description

Redirect from Special:Diff/### to index.php?diff=### and from Special:Diff/###/### to index.php?oldid=###&diff=###.

All of the following are valid usages:

  • [[Special:Diff/12345]] (diff of a revision with the previous one)
  • [[Special:Diff/12345/prev]] (diff of a revision with the previous one as well)
  • [[Special:Diff/12345/next]] (diff of a revision with the next one)
  • [[Special:Diff/12345/cur]] (diff of a revision with the latest one of that page)
  • [[Special:Diff/12345/98765]] (diff between arbitrary two revisions)
Since
1.23

Definition at line 39 of file SpecialDiff.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialDiff::__construct ( )

Definition at line 40 of file SpecialDiff.php.

Member Function Documentation

◆ getDescription()

SpecialDiff::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 behavior.

Stable to override

Returns
string

Reimplemented from SpecialPage.

Definition at line 121 of file SpecialDiff.php.

References SpecialPage\msg().

◆ getGroupName()

SpecialDiff::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'.

Stable to override

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 134 of file SpecialDiff.php.

◆ getName()

SpecialDiff::getName ( )

Get the name of this Special Page.

Returns
string

Reimplemented from SpecialPage.

Definition at line 126 of file SpecialDiff.php.

◆ getRedirect()

SpecialDiff::getRedirect (   $subpage)
Parameters
string | null$subpage
Returns
Title|bool

Reimplemented from RedirectSpecialPage.

Definition at line 49 of file SpecialDiff.php.

◆ isListed()

SpecialDiff::isListed ( )

Whether this special page is listed in Special:SpecialPages Stable to override.

Since
1.3 (r3583)
Returns
bool

Reimplemented from UnlistedSpecialPage.

Definition at line 130 of file SpecialDiff.php.

◆ onFormSubmit()

SpecialDiff::onFormSubmit (   $formData)

Definition at line 107 of file SpecialDiff.php.

References $title, SpecialPage\getOutput(), and SpecialPage\getPageTitle().

◆ showForm()

SpecialDiff::showForm ( )
private

Definition at line 72 of file SpecialDiff.php.

References HTMLForm\factory(), SpecialPage\getContext(), and SpecialPage\msg().

Referenced by showNoRedirectPage().

◆ showNoRedirectPage()

SpecialDiff::showNoRedirectPage ( )
protected

Stable to override.

Reimplemented from RedirectSpecialPage.

Definition at line 65 of file SpecialDiff.php.

References SpecialPage\addHelpLink(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), and showForm().


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