Implements Special:Whatlinkshere. More...

Inheritance diagram for SpecialWhatLinksHere:

[legend]

Collaboration diagram for SpecialWhatLinksHere:

[legend]

Public Member Functions
	__construct (ILoadBalancer $loadBalancer, LinkBatchFactory $linkBatchFactory, IContentHandlerFactory $contentHandlerFactory, SearchEngineFactory $searchEngineFactory, NamespaceInfo $namespaceInfo)

	execute ( $par)
	Default execute method Checks user permissions.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

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

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.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

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

	doesWrites ()
	Indicates whether this special page may perform database writes.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	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.

	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.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	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.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	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.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	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.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

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

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

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

	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.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

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

	getAuthManager ()

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	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.

	prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

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

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
	$limits = [ 20, 50, 100, 250, 500 ]

FormOptions	$opts

	$selfTitle

Title	$target

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Private Member Functions
	getFilterPanel ()
	Create filter panel.

	getPrevNext ( $prevNamespace, $prevPageId, $nextNamespace, $nextPageId)

	makeSelfLink ( $text, $query)

	parseOffsetAndDir (FormOptions $opts)
	Parse the offset and direction parameters.

	showIndirectLinks ( $level, $target, $limit, $offsetNamespace=0, $offsetPageID=0, $dir='next')

	whatlinkshereForm ()

Private Attributes
IContentHandlerFactory	$contentHandlerFactory

LinkBatchFactory	$linkBatchFactory

ILoadBalancer	$loadBalancer

NamespaceInfo	$namespaceInfo

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.

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.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

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

Detailed Description

Implements Special:Whatlinkshere.

Definition at line 36 of file SpecialWhatLinksHere.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

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

Definition at line 69 of file SpecialWhatLinksHere.php.

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

Member Function Documentation

◆ execute()

SpecialWhatLinksHere::execute ( $subPage )

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stability: stable: to override

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 84 of file SpecialWhatLinksHere.php.

References $opts, FormOptions\add(), SpecialPage\addHelpLink(), FormOptions\fetchValuesFromRequest(), SpecialPage\getConfig(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\getSkin(), FormOptions\getValue(), SpecialPage\including(), SpecialPage\msg(), SpecialPage\outputHeader(), parseOffsetAndDir(), SpecialPage\setHeaders(), FormOptions\setValue(), showIndirectLinks(), FormOptions\validateIntBounds(), and whatlinkshereForm().

◆ getFilterPanel()

SpecialWhatLinksHere::getFilterPanel ( )

private

Create filter panel.

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

Definition at line 711 of file SpecialWhatLinksHere.php.

References $type, and NS_FILE.

◆ 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'.

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 753 of file SpecialWhatLinksHere.php.

◆ getPrevNext()

SpecialWhatLinksHere::getPrevNext	(	$prevNamespace,
		$prevPageId,
		$nextNamespace,
		$nextPageId
	)

private

Definition at line 613 of file SpecialWhatLinksHere.php.

References $lang, and Message\rawParam().

◆ listEnd()

SpecialWhatLinksHere::listEnd ( )

protected

Definition at line 562 of file SpecialWhatLinksHere.php.

◆ listItem()

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

protected

Definition at line 504 of file SpecialWhatLinksHere.php.

References Title\createFragmentTarget().

◆ listStart()

SpecialWhatLinksHere::listStart ( $level )

protected

Definition at line 500 of file SpecialWhatLinksHere.php.

◆ makeSelfLink()

SpecialWhatLinksHere::makeSelfLink	(	$text,
		$query
	)

private

Definition at line 604 of file SpecialWhatLinksHere.php.

◆ parseOffsetAndDir()

SpecialWhatLinksHere::parseOffsetAndDir ( FormOptions $opts )

private

Parse the offset and direction parameters.

Three parameter kinds are supported:

from=123 (legacy), where page ID 123 is the first included one
offset=123&dir=next/prev (legacy), where page ID 123 is the last excluded one
offset=0|123&dir=next/prev (current), where namespace 0 page ID 123 is the last excluded one

Parameters

FormOptions $opts

Returns: array

Definition at line 157 of file SpecialWhatLinksHere.php.

Referenced by execute().

◆ prefixSearchSubpages()

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

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

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 749 of file SpecialWhatLinksHere.php.

◆ showIndirectLinks()

SpecialWhatLinksHere::showIndirectLinks	(	$level,
		$target,
		$limit,
		$offsetNamespace = `0`,
		$offsetPageID = `0`,
		$dir = `'next'`
	)

private

Parameters

int	$level	Recursion level
Title	$target	Target title
int	$limit	Number of entries to display
int	$offsetNamespace	Display from this namespace number (included)
int	$offsetPageID	Display from this article ID (excluded)
string	$dir	'next' or 'prev'

Definition at line 201 of file SpecialWhatLinksHere.php.

References $dbr, Title\getDBkey(), Title\getNamespace(), if, NS_FILE, and Message\numParam().

Referenced by execute().

◆ whatlinkshereForm()

SpecialWhatLinksHere::whatlinkshereForm ( )

private

Definition at line 643 of file SpecialWhatLinksHere.php.

References Title\getPrefixedText(), and wfScript().

Referenced by execute().

◆ wlhLink()

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

protected

Definition at line 566 of file SpecialWhatLinksHere.php.

References $title, getAuthority(), Title\getContentModel(), and Title\getPrefixedText().

Member Data Documentation

◆ $contentHandlerFactory

IContentHandlerFactory SpecialWhatLinksHere::$contentHandlerFactory

private

Definition at line 52 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $limits

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

protected

Definition at line 60 of file SpecialWhatLinksHere.php.

◆ $linkBatchFactory

LinkBatchFactory SpecialWhatLinksHere::$linkBatchFactory

private

Definition at line 49 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $loadBalancer

ILoadBalancer SpecialWhatLinksHere::$loadBalancer

private

Definition at line 46 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $namespaceInfo

NamespaceInfo SpecialWhatLinksHere::$namespaceInfo

private

Definition at line 58 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $opts

FormOptions SpecialWhatLinksHere::$opts

protected

Definition at line 38 of file SpecialWhatLinksHere.php.

Referenced by execute().

◆ $searchEngineFactory

SearchEngineFactory SpecialWhatLinksHere::$searchEngineFactory

private

Definition at line 55 of file SpecialWhatLinksHere.php.

Referenced by __construct().

◆ $selfTitle

SpecialWhatLinksHere::$selfTitle

protected

Definition at line 40 of file SpecialWhatLinksHere.php.

◆ $target

Title SpecialWhatLinksHere::$target

protected

Definition at line 43 of file SpecialWhatLinksHere.php.

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

includes/specials/SpecialWhatLinksHere.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getFilterPanel()

◆ getGroupName()

◆ getPrevNext()

◆ listEnd()

◆ listItem()

◆ listStart()

◆ makeSelfLink()

◆ parseOffsetAndDir()

◆ prefixSearchSubpages()

◆ showIndirectLinks()

◆ whatlinkshereForm()

◆ wlhLink()

Member Data Documentation

◆ $contentHandlerFactory

◆ $limits

◆ $linkBatchFactory

◆ $loadBalancer

◆ $namespaceInfo

◆ $opts

◆ $searchEngineFactory

◆ $selfTitle

◆ $target