Implements Special:Whatlinkshere. More...

Inherits MediaWiki\SpecialPage\FormSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialWhatLinksHere:

[legend]

Public Member Functions
	__construct (IConnectionProvider $dbProvider, LinkBatchFactory $linkBatchFactory, IContentHandlerFactory $contentHandlerFactory, SearchEngineFactory $searchEngineFactory, NamespaceInfo $namespaceInfo, TitleFactory $titleFactory, LinksMigration $linksMigration)

	onSubmit (array $data)
	Process the form on submission.

	onSuccess ()
	We want the result displayed after the form, so we use this instead of onSubmit()

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

	requiresPost ()
	Whether this action should using POST method to submit, default to true.

Public Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage
	execute ( $par)
	Basic SpecialPage workflow: get a form, send it to the user; get some data back,.

	requiresUnblock ()
	Whether this action cannot be executed by a blocked user, default to requiresPost()

	requiresWrite ()
	Whether this action requires the wiki not to be locked, default to requiresPost()

Public Member Functions inherited from MediaWiki\SpecialPage\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 POST requests to this special page require write access to the wiki.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	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 canonical, unlocalized name of this special page without namespace.

	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.

	getShortDescription (string $path='')
	Similar to getDescription, but takes into account subpages and designed for display in tabs.

	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.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	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.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false)
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	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)

	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
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

	getDisplayFormat ()
	Get display format for the form.

	getFormFields ()
	Get an HTMLForm descriptor array.

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

	getShowAlways ()
	Whether the form should always be shown despite the success of submission.

	getSubpageField ()
	Override this function to set the field name used in the subpage syntax.

	listEnd ()

	listStart ( $level)

	setParameter ( $par)
	Get a better-looking target title from the subpage syntax.

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

Protected Member Functions inherited from MediaWiki\SpecialPage\FormSpecialPage
	checkExecutePermissions (User $user)
	Called from execute() to check if the given user can perform this action.

	getForm ()
	Get the HTMLForm to control behavior.

	getMessagePrefix ()
	Get message prefix for HTMLForm.

	postHtml ()
	Add post-HTML to the form.

	postText ()
	Add post-text to the form.

	preHtml ()
	Add pre-HTML to the form.

	preText ()
	Add pre-text to the form.

	setReauthPostData (array $data)
	Preserve POST data across reauthentication.

Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

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

	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 By 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!

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

Protected Attributes
FormOptions	$opts

Title	$target

Protected Attributes inherited from MediaWiki\SpecialPage\FormSpecialPage
string null	$par = null
	The subpage of the special page.

array null	$reauthPostData = null
	POST data preserved across re-authentication.

Protected Attributes inherited from MediaWiki\SpecialPage\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 as the message key for the default.

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

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\SpecialPage\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	newSearchPage (User $user)
	Get the users preferred search page.

Static Protected Member Functions inherited from MediaWiki\SpecialPage\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 50 of file SpecialWhatLinksHere.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialWhatLinksHere::__construct	(	IConnectionProvider	$dbProvider,
		LinkBatchFactory	$linkBatchFactory,
		IContentHandlerFactory	$contentHandlerFactory,
		SearchEngineFactory	$searchEngineFactory,
		NamespaceInfo	$namespaceInfo,
		TitleFactory	$titleFactory,
		LinksMigration	$linksMigration )

Parameters

IConnectionProvider	$dbProvider
LinkBatchFactory	$linkBatchFactory
IContentHandlerFactory	$contentHandlerFactory
SearchEngineFactory	$searchEngineFactory
NamespaceInfo	$namespaceInfo
TitleFactory	$titleFactory
LinksMigration	$linksMigration

Definition at line 76 of file SpecialWhatLinksHere.php.

Member Function Documentation

◆ alterForm()

MediaWiki\Specials\SpecialWhatLinksHere::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 699 of file SpecialWhatLinksHere.php.

References MediaWiki\HTMLForm\HTMLForm\addFields(), NS_FILE, and MediaWiki\HTMLForm\HTMLForm\setWrapperLegendMsg().

◆ getDisplayFormat()

MediaWiki\Specials\SpecialWhatLinksHere::getDisplayFormat ( )

protected

Get display format for the form.

See HTMLForm documentation for available values.

Since: 1.25

Returns: string

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 739 of file SpecialWhatLinksHere.php.

◆ getFormFields()

MediaWiki\Specials\SpecialWhatLinksHere::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 645 of file SpecialWhatLinksHere.php.

◆ getGroupName()

MediaWiki\Specials\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 MediaWiki\SpecialPage\SpecialPage.

Definition at line 755 of file SpecialWhatLinksHere.php.

◆ getShowAlways()

MediaWiki\Specials\SpecialWhatLinksHere::getShowAlways ( )

protected

Whether the form should always be shown despite the success of submission.

Since: 1.40

Returns: bool

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 723 of file SpecialWhatLinksHere.php.

◆ getSubpageField()

MediaWiki\Specials\SpecialWhatLinksHere::getSubpageField ( )

protected

Override this function to set the field name used in the subpage syntax.

Since: 1.40

Returns: false|string

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 727 of file SpecialWhatLinksHere.php.

◆ listEnd()

MediaWiki\Specials\SpecialWhatLinksHere::listEnd ( )

protected

Definition at line 582 of file SpecialWhatLinksHere.php.

References MediaWiki\Html\Html\closeElement().

◆ listStart()

MediaWiki\Specials\SpecialWhatLinksHere::listStart ( $level )

protected

Definition at line 517 of file SpecialWhatLinksHere.php.

References MediaWiki\Html\Html\openElement().

◆ onSubmit()

MediaWiki\Specials\SpecialWhatLinksHere::onSubmit ( array $data )

Process the form on submission.

@phpcs:disable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Parameters

array	$data
HTMLForm \| null	$form

Returns: bool|string|array|Status As documented for HTMLForm::trySubmit. @phpcs:enable MediaWiki.Commenting.FunctionComment.ExtraParamComment

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 731 of file SpecialWhatLinksHere.php.

◆ onSuccess()

MediaWiki\Specials\SpecialWhatLinksHere::onSuccess ( )

We want the result displayed after the form, so we use this instead of onSubmit()

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 111 of file SpecialWhatLinksHere.php.

References MediaWiki\Specials\SpecialWhatLinksHere\$opts, MediaWiki\Html\FormOptions\add(), MediaWiki\Html\FormOptions\fetchValuesFromRequest(), MediaWiki\SpecialPage\SpecialPage\getConfig(), MediaWiki\SpecialPage\SpecialPage\getOutput(), MediaWiki\SpecialPage\SpecialPage\getRequest(), MediaWiki\SpecialPage\SpecialPage\getSkin(), MediaWiki\Html\FormOptions\getValue(), MediaWiki\SpecialPage\SpecialPage\msg(), MediaWiki\MainConfigNames\QueryPageDefaultLimit, MediaWiki\Html\FormOptions\setValue(), and MediaWiki\Html\FormOptions\validateIntBounds().

◆ prefixSearchSubpages()

MediaWiki\Specials\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 MediaWiki\SpecialPage\SpecialPage.

Definition at line 751 of file SpecialWhatLinksHere.php.

◆ requiresPost()

MediaWiki\Specials\SpecialWhatLinksHere::requiresPost ( )

Whether this action should using POST method to submit, default to true.

Since: 1.40

Returns: bool

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 735 of file SpecialWhatLinksHere.php.

◆ setParameter()

MediaWiki\Specials\SpecialWhatLinksHere::setParameter ( $par )

protected

Get a better-looking target title from the subpage syntax.

Parameters

string | null $par

Reimplemented from MediaWiki\SpecialPage\FormSpecialPage.

Definition at line 100 of file SpecialWhatLinksHere.php.

References MediaWiki\SpecialPage\FormSpecialPage\$par.

◆ wlhLink()

MediaWiki\Specials\SpecialWhatLinksHere::wlhLink	(	Title	$target,
			$text,
			$editText )

protected

Definition at line 586 of file SpecialWhatLinksHere.php.

References MediaWiki\Title\Title\getContentModel(), and MediaWiki\Title\Title\getPrefixedText().

Member Data Documentation

◆ $opts

FormOptions MediaWiki\Specials\SpecialWhatLinksHere::$opts

protected

Definition at line 52 of file SpecialWhatLinksHere.php.

Referenced by MediaWiki\Specials\SpecialWhatLinksHere\onSuccess().

◆ $target

Title MediaWiki\Specials\SpecialWhatLinksHere::$target

protected

Definition at line 55 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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ getDisplayFormat()

◆ getFormFields()

◆ getGroupName()

◆ getShowAlways()

◆ getSubpageField()

◆ listEnd()

◆ listStart()

◆ onSubmit()

◆ onSuccess()

◆ prefixSearchSubpages()

◆ requiresPost()

◆ setParameter()

◆ wlhLink()

Member Data Documentation

◆ $opts

◆ $target