Implements Special:Prefixindex. More...

Collaboration diagram for SpecialPrefixindex:

[legend]

Public Member Functions
	__construct (ILoadBalancer $loadBalancer, LinkCache $linkCache)

	execute ( $par)
	Entry point : initialise variables and call subfunctions.

Public Member Functions inherited from SpecialAllPages
	__construct (ILoadBalancer $loadBalancer=null, SearchEngineFactory $searchEngineFactory=null, PageStore $pageStore=null)

	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.

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

	getShortDescription (string $path='')
	Similar to getDescription but takes into account sub pages 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.

	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.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	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)

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

	namespacePrefixForm ( $namespace=NS_MAIN, $from='')
	HTML for the top form.

	showPrefixChunk ( $namespace, $prefix, $from=null)

Protected Member Functions inherited from SpecialAllPages
	getNamespaceKeyAndText ( $ns, $text)

	outputHTMLForm ( $namespace=NS_MAIN, $from='', $to='', $hideRedirects=false)
	Outputs the HTMLForm used on this page.

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
	$hideRedirects = false

	$stripPrefix = false
	Whether to remove the searched prefix from the displayed link.

Protected Attributes inherited from SpecialAllPages
int	$maxPerPage = 345
	Maximum number of pages to show on single subpage.

string	$nsfromMsg = 'allpagesfrom'
	Determines, which message describes the input field 'nsfrom'.

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.

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	newSearchPage (User $user)
	Get the users preferred search page.

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:Prefixindex.

Definition at line 33 of file SpecialPrefixindex.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPrefixindex::__construct	(	ILoadBalancer	$loadBalancer,
		LinkCache	$linkCache )

Parameters

ILoadBalancer	$loadBalancer
LinkCache	$linkCache

Definition at line 55 of file SpecialPrefixindex.php.

Member Function Documentation

◆ execute()

SpecialPrefixindex::execute ( $par )

Entry point : initialise variables and call subfunctions.

Parameters

string | null $par Becomes "FOO" when called like Special:Prefixindex/FOO

Reimplemented from SpecialAllPages.

Definition at line 69 of file SpecialPrefixindex.php.

References SpecialPage\getContentLanguage(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\including(), SpecialPage\msg(), namespacePrefixForm(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), and showPrefixChunk().

◆ getGroupName()

SpecialPrefixindex::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 SpecialAllPages.

Definition at line 300 of file SpecialPrefixindex.php.

◆ namespacePrefixForm()

SpecialPrefixindex::namespacePrefixForm	(		$namespace = NS_MAIN,
			$from = '' )

protected

HTML for the top form.

Parameters

int	$namespace	A namespace constant (default NS_MAIN).
string	$from	DbKey we are starting listing at.

Returns: string

Definition at line 117 of file SpecialPrefixindex.php.

References SpecialPage\getContext(), and SpecialPage\getPageTitle().

Referenced by execute(), and showPrefixChunk().

◆ showPrefixChunk()

SpecialPrefixindex::showPrefixChunk	(	$namespace,
		$prefix,
		$from = null )

protected

Parameters

int	$namespace
string	$prefix
string \| null	$from	List all pages from this name (default false)

Definition at line 160 of file SpecialPrefixindex.php.

References $dbr, $hideRedirects, $res, $stripPrefix, $title, SpecialPage\getContentLanguage(), SpecialPage\getLinkRenderer(), SpecialAllPages\getNamespaceKeyAndText(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\including(), SpecialPage\msg(), namespacePrefixForm(), and NS_MAIN.

Referenced by execute().

Member Data Documentation

◆ $hideRedirects

SpecialPrefixindex::$hideRedirects = false

protected

Definition at line 41 of file SpecialPrefixindex.php.

Referenced by showPrefixChunk().

◆ $stripPrefix

SpecialPrefixindex::$stripPrefix = false

protected

Whether to remove the searched prefix from the displayed link.

Useful for inclusion of a set of sub pages in a root page.

Definition at line 39 of file SpecialPrefixindex.php.

Referenced by showPrefixChunk().

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

includes/specials/SpecialPrefixindex.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getGroupName()

◆ namespacePrefixForm()

◆ showPrefixChunk()

Member Data Documentation

◆ $hideRedirects

◆ $stripPrefix