Implements Special:Whatlinkshere. More...

Inheritance diagram for SpecialWhatLinksHere:

[legend]

Collaboration diagram for SpecialWhatLinksHere:

[legend]

Public Member Functions
	__construct ()

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

	getFilterPanel ()
	Create filter panel.

	getPrevNext ( $prevId, $nextId)

	makeSelfLink ( $text, $query)

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

	showIndirectLinks ( $level, $target, $limit, $from=0, $back=0)

	whatlinkshereForm ()

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.

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

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

	getConfig ()
	Shortcut to get main config object.

	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.

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

	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)
	Wrapper around wfMessage that sets the current context.

	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.

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

	run ( $subPage)
	Entry point.

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

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

	setLinkRenderer (LinkRenderer $linkRenderer)

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

	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.

	getCacheTTL ()

	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.

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

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	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.

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

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 31 of file SpecialWhatlinkshere.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialWhatLinksHere::__construct ( )

Definition at line 42 of file SpecialWhatlinkshere.php.

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

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 46 of file SpecialWhatlinkshere.php.

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

◆ getFilterPanel()

SpecialWhatLinksHere::getFilterPanel ( )

Create filter panel.

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

Definition at line 546 of file SpecialWhatlinkshere.php.

References $type, as, SpecialPage\getLanguage(), makeSelfLink(), SpecialPage\msg(), NS_FILE, and text.

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

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 588 of file SpecialWhatlinkshere.php.

◆ getPrevNext()

SpecialWhatLinksHere::getPrevNext	(	$prevId,
		$nextId
	)

Definition at line 450 of file SpecialWhatlinkshere.php.

References $lang, as, SpecialPage\getLanguage(), makeSelfLink(), and SpecialPage\msg().

Referenced by showIndirectLinks().

◆ listEnd()

SpecialWhatLinksHere::listEnd ( )

protected

Definition at line 388 of file SpecialWhatlinkshere.php.

Referenced by showIndirectLinks().

◆ listItem()

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

protected

Definition at line 329 of file SpecialWhatlinkshere.php.

References $link, $query, $target, as, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\msg(), and wlhLink().

Referenced by showIndirectLinks().

◆ listStart()

SpecialWhatLinksHere::listStart ( $level )

protected

Definition at line 325 of file SpecialWhatlinkshere.php.

Referenced by showIndirectLinks().

◆ makeSelfLink()

SpecialWhatLinksHere::makeSelfLink	(	$text,
		$query
	)

Definition at line 437 of file SpecialWhatlinkshere.php.

References $query, and 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	$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 584 of file SpecialWhatlinkshere.php.

References SpecialPage\prefixSearchString().

◆ showIndirectLinks()

SpecialWhatLinksHere::showIndirectLinks	(	$level,
		$target,
		$limit,
		$from = `0`,
		$back = `0`
	)

Parameters

int	$level	Recursion level
Title	$target	Target title
int	$limit	Number of entries to display
int	$from	Display from this article ID (default: 0)
int	$back	Display from this article ID at backwards scrolling (default: 0)

Definition at line 108 of file SpecialWhatlinkshere.php.

References $dbr, $link, $out, $rows, $target, as, DB_REPLICA, SpecialPage\getConfig(), Title\getDBkey(), getFilterPanel(), SpecialPage\getLinkRenderer(), Title\getNamespace(), SpecialPage\getOutput(), getPrevNext(), SpecialPage\including(), listEnd(), listItem(), listStart(), SpecialPage\msg(), NS_FILE, showIndirectLinks(), use, wfGetDB(), and whatlinkshereForm().

Referenced by execute(), and showIndirectLinks().

◆ whatlinkshereForm()

SpecialWhatLinksHere::whatlinkshereForm ( )

Definition at line 480 of file SpecialWhatlinkshere.php.

References $f, $name, $target, $value, as, SpecialPage\getPageTitle(), Title\getPrefixedText(), SpecialPage\msg(), text, and wfScript().

Referenced by execute(), and showIndirectLinks().

◆ wlhLink()

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

protected

Definition at line 392 of file SpecialWhatlinkshere.php.

References SpecialPage\$linkRenderer, $target, $title, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getPageTitle(), Title\getPrefixedText(), and SpecialPage\getUser().

Referenced by listItem().

Member Data Documentation

◆ $limits

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

protected

Definition at line 40 of file SpecialWhatlinkshere.php.

◆ $opts

FormOptions SpecialWhatLinksHere::$opts

protected

Definition at line 33 of file SpecialWhatlinkshere.php.

Referenced by execute().

◆ $selfTitle

SpecialWhatLinksHere::$selfTitle

protected

Definition at line 35 of file SpecialWhatlinkshere.php.

◆ $target

Title SpecialWhatLinksHere::$target

protected

Definition at line 38 of file SpecialWhatlinkshere.php.

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

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

includes/specials/SpecialWhatlinkshere.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getFilterPanel()

◆ getGroupName()

◆ getPrevNext()

◆ listEnd()

◆ listItem()

◆ listStart()

◆ makeSelfLink()

◆ prefixSearchSubpages()

◆ showIndirectLinks()

◆ whatlinkshereForm()

◆ wlhLink()

Member Data Documentation

◆ $limits

◆ $opts

◆ $selfTitle

◆ $target