SpecialPrefixindex Class Reference

Implements Special:Prefixindex. More...

Inheritance diagram for SpecialPrefixindex:

Collaboration diagram for SpecialPrefixindex:

List of all members.

Public Member Functions
	__construct ()
	execute ($par)
	Entry point : initialise variables and call subfunctions.
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=NS_MAIN, $prefix, $from=null)
Protected Attributes
	$columns = 3
	$hideRedirects = false
	$stripPrefix = false
	Whether to remove the searched prefix from the displayed link.

---

Detailed Description

Implements Special:Prefixindex.

Definition at line 29 of file SpecialPrefixindex.php.

---

Constructor & Destructor Documentation

SpecialPrefixindex::__construct

(

)

Definition at line 44 of file SpecialPrefixindex.php.

---

Member Function Documentation

SpecialPrefixindex::execute

(

$

par

)

Entry point : initialise variables and call subfunctions.

Parameters:

string

$par

Becomes "FOO" when called like Special:Prefixindex/FOO (default null)

Reimplemented from SpecialAllPages.

Definition at line 52 of file SpecialPrefixindex.php.

References $from, $namespaces, $out, $wgContLang, columns, SpecialPage\getOutput(), SpecialPage\getRequest(), global, SpecialPage\including(), SpecialPage\msg(), namespacePrefixForm(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), and showPrefixChunk().

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

Returns:

string

Since:

1.21

Reimplemented from SpecialAllPages.

Definition at line 301 of file SpecialPrefixindex.php.

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 103 of file SpecialPrefixindex.php.

References $from, $out, array(), Xml\checkLabel(), Xml\closeElement(), Xml\element(), SpecialPage\getConfig(), SpecialPage\getPageTitle(), Html\hidden(), Xml\input(), label, SpecialPage\msg(), Html\namespaceSelector(), Xml\openElement(), Xml\submitButton(), and text.

Referenced by execute(), and showPrefixChunk().

SpecialPrefixindex::showPrefixChunk	(	$	namespace = NS_MAIN,
		$	prefix,
		$	from = null
	)		[protected]

Parameters:

int	$namespace	Default NS_MAIN
string	$prefix
string	$from	List all pages from this name (default false)

Definition at line 158 of file SpecialPrefixindex.php.

References $conds, $dbr, $from, $link, $n, $namespaces, $out, $query, $res, $s, $self, $t, $wgContLang, array(), Xml\closeElement(), columns, Html\element(), SpecialAllPages\getNamespaceKeyAndText(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), global, SpecialPage\including(), Linker\linkKnown(), list, Title\makeTitle(), SpecialPage\msg(), namespacePrefixForm(), Xml\openElement(), Html\rawElement(), and wfGetDB().

Referenced by execute().

---

Member Data Documentation

SpecialPrefixindex::$columns = 3 [protected]

Definition at line 40 of file SpecialPrefixindex.php.

SpecialPrefixindex::$hideRedirects = false [protected]

Definition at line 37 of file SpecialPrefixindex.php.

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 35 of file SpecialPrefixindex.php.

---

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

• includes/specials/SpecialPrefixindex.php