MediaWiki  master
SpecialWhatLinksHere Class Reference

Implements Special:Whatlinkshere. More...

Inheritance diagram for SpecialWhatLinksHere:
Collaboration diagram for SpecialWhatLinksHere:

Public Member Functions

 __construct (ILoadBalancer $loadBalancer, LinkBatchFactory $linkBatchFactory, PermissionManager $permissionManager, IContentHandlerFactory $contentHandlerFactory, SearchEngineFactory $searchEngineFactory, NamespaceInfo $namespaceInfo)
 
 execute ( $par)
 Default execute method Checks user permissions. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
- Public Member Functions inherited from IncludableSpecialPage
 __construct ( $name, $restriction='', $listed=true, $function=false, $file='default')
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}} 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...
 
 getContentLanguage ()
 Shortcut to get content language. 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...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages 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...
 
 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...
 
 listEnd ()
 
 listItem ( $row, $nt, $target, $notClose=false)
 
 listStart ( $level)
 
 wlhLink (Title $target, $text, $editText)
 
- 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...
 

Protected Attributes

 $limits = [ 20, 50, 100, 250, 500 ]
 
FormOptions $opts
 
 $selfTitle
 
Title $target
 
- 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...
 

Private Member Functions

 getFilterPanel ()
 Create filter panel. More...
 
 getPrevNext ( $prevId, $nextId)
 
 makeSelfLink ( $text, $query)
 
 showIndirectLinks ( $level, $target, $limit, $from=0, $back=0)
 
 whatlinkshereForm ()
 

Private Attributes

IContentHandlerFactory $contentHandlerFactory
 
LinkBatchFactory $linkBatchFactory
 
ILoadBalancer $loadBalancer
 
NamespaceInfo $namespaceInfo
 
PermissionManager $permissionManager
 
SearchEngineFactory $searchEngineFactory
 

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

Implements Special:Whatlinkshere.

Definition at line 35 of file SpecialWhatLinksHere.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialWhatLinksHere::__construct ( ILoadBalancer  $loadBalancer,
LinkBatchFactory  $linkBatchFactory,
PermissionManager  $permissionManager,
IContentHandlerFactory  $contentHandlerFactory,
SearchEngineFactory  $searchEngineFactory,
NamespaceInfo  $namespaceInfo 
)
Parameters
ILoadBalancer$loadBalancer
LinkBatchFactory$linkBatchFactory
PermissionManager$permissionManager
IContentHandlerFactory$contentHandlerFactory
SearchEngineFactory$searchEngineFactory
NamespaceInfo$namespaceInfo

Definition at line 72 of file SpecialWhatLinksHere.php.

References $contentHandlerFactory, $linkBatchFactory, $loadBalancer, $namespaceInfo, $permissionManager, and $searchEngineFactory.

Member Function Documentation

◆ execute()

SpecialWhatLinksHere::execute (   $subPage)

◆ getFilterPanel()

SpecialWhatLinksHere::getFilterPanel ( )
private

Create filter panel.

Returns
string HTML fieldset and filter panel with the show/hide links

Definition at line 614 of file SpecialWhatLinksHere.php.

References $type, Xml\fieldset(), SpecialPage\getLanguage(), makeSelfLink(), SpecialPage\msg(), and NS_FILE.

Referenced by showIndirectLinks().

◆ getGroupName()

SpecialWhatLinksHere::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 656 of file SpecialWhatLinksHere.php.

◆ getPrevNext()

SpecialWhatLinksHere::getPrevNext (   $prevId,
  $nextId 
)
private

◆ listEnd()

SpecialWhatLinksHere::listEnd ( )
protected

Definition at line 467 of file SpecialWhatLinksHere.php.

References Xml\closeElement().

Referenced by showIndirectLinks().

◆ listItem()

SpecialWhatLinksHere::listItem (   $row,
  $nt,
  $target,
  $notClose = false 
)
protected

◆ listStart()

SpecialWhatLinksHere::listStart (   $level)
protected

Definition at line 405 of file SpecialWhatLinksHere.php.

References Xml\openElement().

Referenced by showIndirectLinks().

◆ makeSelfLink()

SpecialWhatLinksHere::makeSelfLink (   $text,
  $query 
)
private

Definition at line 509 of file SpecialWhatLinksHere.php.

References SpecialPage\getLinkRenderer().

Referenced by getFilterPanel(), and getPrevNext().

◆ prefixSearchSubpages()

SpecialWhatLinksHere::prefixSearchSubpages (   $search,
  $limit,
  $offset 
)

Return an array of subpages beginning with $search that this special page will accept.

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 652 of file SpecialWhatLinksHere.php.

References SpecialPage\prefixSearchString().

◆ showIndirectLinks()

SpecialWhatLinksHere::showIndirectLinks (   $level,
  $target,
  $limit,
  $from = 0,
  $back = 0 
)
private
Parameters
int$levelRecursion level
Title$targetTarget title
int$limitNumber of entries to display
int$fromDisplay from this article ID (default: 0)
int$backDisplay from this article ID at backwards scrolling (default: 0)

Definition at line 151 of file SpecialWhatLinksHere.php.

References $dbr, $target, Xml\closeElement(), DB_REPLICA, SpecialPage\getConfig(), Title\getDBkey(), getFilterPanel(), SpecialPage\getLinkRenderer(), Title\getNamespace(), SpecialPage\getOutput(), getPrevNext(), SpecialPage\including(), listEnd(), listItem(), listStart(), Title\makeTitle(), SpecialPage\msg(), NS_FILE, Message\numParam(), and whatlinkshereForm().

Referenced by execute().

◆ whatlinkshereForm()

◆ wlhLink()

SpecialWhatLinksHere::wlhLink ( Title  $target,
  $text,
  $editText 
)
protected

Member Data Documentation

◆ $contentHandlerFactory

IContentHandlerFactory SpecialWhatLinksHere::$contentHandlerFactory
private

Definition at line 54 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $limits

SpecialWhatLinksHere::$limits = [ 20, 50, 100, 250, 500 ]
protected

Definition at line 62 of file SpecialWhatLinksHere.php.

◆ $linkBatchFactory

LinkBatchFactory SpecialWhatLinksHere::$linkBatchFactory
private

Definition at line 48 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $loadBalancer

ILoadBalancer SpecialWhatLinksHere::$loadBalancer
private

Definition at line 45 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $namespaceInfo

NamespaceInfo SpecialWhatLinksHere::$namespaceInfo
private

Definition at line 60 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $opts

FormOptions SpecialWhatLinksHere::$opts
protected

Definition at line 37 of file SpecialWhatLinksHere.php.

Referenced by execute().

◆ $permissionManager

PermissionManager SpecialWhatLinksHere::$permissionManager
private

Definition at line 51 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $searchEngineFactory

SearchEngineFactory SpecialWhatLinksHere::$searchEngineFactory
private

Definition at line 57 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $selfTitle

SpecialWhatLinksHere::$selfTitle
protected

Definition at line 39 of file SpecialWhatLinksHere.php.

◆ $target

Title SpecialWhatLinksHere::$target
protected

Definition at line 42 of file SpecialWhatLinksHere.php.

Referenced by listItem(), showIndirectLinks(), whatlinkshereForm(), and wlhLink().


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