SpecialAllpages Class Reference

Implements Special:Allpages. More...

Inheritance diagram for SpecialAllpages:

Collaboration diagram for SpecialAllpages:

List of all members.

Public Member Functions
	__construct ($name= 'Allpages')
	Constructor.
	execute ($par)
	Entry point : initialise variables and call subfunctions.
	namespaceForm ($namespace=NS_MAIN, $from= '', $to= '', $hideredirects=false)
	HTML for the top form.
	showChunk ($namespace=NS_MAIN, $from=false, $to=false, $hideredirects=false)
	showline ($inpoint, $outpoint, $namespace=NS_MAIN, $hideRedirects=false)
	Show a line of "ABC to DEF" ranges of articles.
	showToplevel ($namespace=NS_MAIN, $from= '', $to= '', $hideredirects=false)
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'.
	getNamespaceKeyAndText ($ns, $text)
Protected Attributes
int	$maxLineCount = 100
	Maximum number of pages to show on single index subpage.
int	$maxPageLength = 70
	Maximum number of chars to show for an entry.
int	$maxPerPage = 345
	Maximum number of pages to show on single subpage.
	$maxTopLevelPages = 50000
	Maximum number of pages in a hierarchical ("top level") list.
string	$nsfromMsg = 'allpagesfrom'
	Determines, which message describes the input field 'nsfrom'.

---

Detailed Description

Implements Special:Allpages.

Definition at line 29 of file SpecialAllpages.php.

---

Constructor & Destructor Documentation

SpecialAllpages::__construct

(

$

name = 'Allpages'

)

Constructor.

Parameters:

string

$name

name of the special page, as seen in links and URLs (default: 'Allpages')

Definition at line 70 of file SpecialAllpages.php.

---

Member Function Documentation

SpecialAllpages::execute

(

$

par

)

Entry point : initialise variables and call subfunctions.

Parameters:

string

$par

becomes "FOO" when called like Special:Allpages/FOO (default NULL)

Reimplemented from SpecialPage.

Reimplemented in SpecialPrefixindex.

Definition at line 79 of file SpecialAllpages.php.

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

Reimplemented in SpecialPrefixindex.

Definition at line 585 of file SpecialAllpages.php.

SpecialAllpages::getNamespaceKeyAndText	(	$	ns,
		$	text
	)		[protected]

Parameters:

	$ns	Integer: the namespace of the article
string	$text	the name of the article

Returns:

array( int namespace, string dbkey, string pagename ) or NULL on error

Definition at line 562 of file SpecialAllpages.php.

Referenced by SpecialPrefixindex\showPrefixChunk().

SpecialAllpages::namespaceForm	(	$	namespace = NS_MAIN,
		$	from = '',
		$	to = '',
		$	hideredirects = false
	)

HTML for the top form.

Parameters:

	$namespace	Integer: a namespace constant (default NS_MAIN).
string	$from	dbKey we are starting listing at.
string	$to	dbKey we are ending listing at.
bool	$hideredirects	dont show redirects (default FALSE)

Returns:

string

Definition at line 120 of file SpecialAllpages.php.

SpecialAllpages::showChunk	(	$	namespace = NS_MAIN,
		$	from = false,
		$	to = false,
		$	hideredirects = false
	)

Parameters:

int	$namespace	Namespace (Default NS_MAIN)
string	$from	list all pages from this name (default FALSE)
string	$to	list all pages to this name (default FALSE)
bool	$hideredirects	dont show redirects (default FALSE)

Definition at line 364 of file SpecialAllpages.php.

SpecialAllpages::showline	(	$	inpoint,
		$	outpoint,
		$	namespace = NS_MAIN,
		$	hideRedirects = false
	)

Show a line of "ABC to DEF" ranges of articles.

Parameters:

string	$inpoint	lower limit of pagenames
string	$outpoint	upper limit of pagenames
	$namespace	Integer (Default NS_MAIN)
bool	$hideRedirects	don't show redirects. Default: false

Returns:

string

Definition at line 323 of file SpecialAllpages.php.

SpecialAllpages::showToplevel	(	$	namespace = NS_MAIN,
		$	from = '',
		$	to = '',
		$	hideredirects = false
	)

Parameters:

	$namespace	Integer (default NS_MAIN)
string	$from	list all pages from this name
string	$to	list all pages to this name
bool	$hideredirects	dont show redirects (default FALSE)

Definition at line 178 of file SpecialAllpages.php.

---

Member Data Documentation

int SpecialAllpages::$maxLineCount = 100 [protected]

Maximum number of pages to show on single index subpage.

$maxLineCount

Definition at line 41 of file SpecialAllpages.php.

int SpecialAllpages::$maxPageLength = 70 [protected]

Maximum number of chars to show for an entry.

$maxPageLength

Definition at line 47 of file SpecialAllpages.php.

int SpecialAllpages::$maxPerPage = 345 [protected]

Maximum number of pages to show on single subpage.

$maxPerPage

Definition at line 35 of file SpecialAllpages.php.

SpecialAllpages::$maxTopLevelPages = 50000 [protected]

Maximum number of pages in a hierarchical ("top level") list.

Traversal of the entire page list by spidering the top levels is thought to require O(N^3) DB CPU time where N is the number of pages on the wiki. See bug 56840. If this limit is exceeded, the behaviour becomes like a simple alphabetic pager.

Definition at line 57 of file SpecialAllpages.php.

string SpecialAllpages::$nsfromMsg = 'allpagesfrom' [protected]

Determines, which message describes the input field 'nsfrom'.

$nsfromMsg

Definition at line 63 of file SpecialAllpages.php.

---

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

• includes/specials/SpecialAllpages.php