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)
	Show a line of "ABC to DEF" ranges of articles.
	showToplevel ($namespace=NS_MAIN, $from= '', $to= '', $hideredirects=false)
Protected Member Functions
	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.
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:

$name

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

Definition at line 60 of file SpecialAllpages.php.

---

Member Function Documentation

SpecialAllpages::execute

(

$

par

)

Entry point : initialise variables and call subfunctions.

Parameters:

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

Reimplemented from SpecialPage.

Reimplemented in SpecialPrefixindex.

Definition at line 69 of file SpecialAllpages.php.

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

Parameters:

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

Returns:

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

Definition at line 517 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).
$from	String: dbKey we are starting listing at.
$to	String: dbKey we are ending listing at.
$hideredirects	Bool: dont show redirects (default FALSE)

Returns:

string

Definition at line 111 of file SpecialAllpages.php.

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

Parameters:

$namespace	Integer (Default NS_MAIN)
$from	String: list all pages from this name (default FALSE)
$to	String: list all pages to this name (default FALSE)
$hideredirects	Bool: dont show redirects (default FALSE)

Definition at line 330 of file SpecialAllpages.php.

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

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

Parameters:

$inpoint	String: lower limit of pagenames
$outpoint	String: upper limit of pagenames
$namespace	Integer (Default NS_MAIN)
$hideredirects	Bool: dont show redirects (default FALSE)

Returns:

string

Definition at line 299 of file SpecialAllpages.php.

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

Parameters:

$namespace	Integer (default NS_MAIN)
$from	String: list all pages from this name
$to	String: list all pages to this name
$hideredirects	Bool: dont show redirects (default FALSE)

Definition at line 168 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.

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

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

$nsfromMsg

Definition at line 53 of file SpecialAllpages.php.

---

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

• includes/specials/SpecialAllpages.php