SpecialExpandTemplates Class Reference

A special page that expands submitted templates, parser functions, and variables, allowing easier debugging of these. More...

Inheritance diagram for SpecialExpandTemplates:

Collaboration diagram for SpecialExpandTemplates:

List of all members.

Public Member Functions
	__construct ()
	execute ($subpage)
	Show the special page.
Public Attributes
const	MAX_INCLUDE_SIZE = 50000000
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'.
Protected Attributes
bool	$generateRawHtml
	Whether or not to show the raw HTML code *.
bool	$generateXML
	Whether or not to show the XML parse tree *.
bool	$removeComments
	Whether or not to remove comments in the expanded wikitext *.
bool	$removeNowiki
	Whether or not to remove <nowiki> tags in the expanded wikitext *.
Private Member Functions
	generateHtml (Title $title, $text)
	Renders the supplied wikitext as html.
	makeForm ($title, $input)
	Generate a form allowing users to enter information.
	makeOutput ($output, $heading= 'expand_templates_output')
	Generate a nice little box with a heading for output.
	showHtmlPreview (Title $title, ParserOutput $pout, OutputPage $out)
	Wraps the provided html code in a div and outputs it to the page.

---

Detailed Description

A special page that expands submitted templates, parser functions, and variables, allowing easier debugging of these.

Definition at line 30 of file SpecialExpandTemplates.php.

---

Constructor & Destructor Documentation

SpecialExpandTemplates::__construct

(

)

Definition at line 43 of file SpecialExpandTemplates.php.

---

Member Function Documentation

SpecialExpandTemplates::execute

(

$

subpage

)

Show the special page.

Parameters:

string | null

$subpage

Reimplemented from SpecialPage.

Definition at line 51 of file SpecialExpandTemplates.php.

SpecialExpandTemplates::generateHtml	(	Title $	title,
		$	text
	)		[private]

Renders the supplied wikitext as html.

Parameters:

Title	$title
string	$text

Returns:

ParserOutput

Definition at line 225 of file SpecialExpandTemplates.php.

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

Definition at line 252 of file SpecialExpandTemplates.php.

SpecialExpandTemplates::makeForm	(	$	title,
		$	input
	)		[private]

Generate a form allowing users to enter information.

Parameters:

string	$title	Value for context title field
string	$input	Value for input textbox

Returns:

string

Definition at line 136 of file SpecialExpandTemplates.php.

SpecialExpandTemplates::makeOutput	(	$	output,
		$	heading = 'expand_templates_output'
	)		[private]

Generate a nice little box with a heading for output.

Parameters:

string	$output	Wiki text output
string	$heading

Returns:

string

Definition at line 205 of file SpecialExpandTemplates.php.

SpecialExpandTemplates::showHtmlPreview	(	Title $	title,
		ParserOutput $	pout,
		OutputPage $	out
	)		[private]

Wraps the provided html code in a div and outputs it to the page.

Parameters:

Title	$title
ParserOutput	$pout
OutputPage	$out

Definition at line 240 of file SpecialExpandTemplates.php.

---

Member Data Documentation

bool SpecialExpandTemplates::$generateRawHtml [protected]

Whether or not to show the raw HTML code *.

Definition at line 34 of file SpecialExpandTemplates.php.

bool SpecialExpandTemplates::$generateXML [protected]

Whether or not to show the XML parse tree *.

Definition at line 32 of file SpecialExpandTemplates.php.

bool SpecialExpandTemplates::$removeComments [protected]

Whether or not to remove comments in the expanded wikitext *.

Definition at line 36 of file SpecialExpandTemplates.php.

bool SpecialExpandTemplates::$removeNowiki [protected]

Whether or not to remove <nowiki> tags in the expanded wikitext *.

Definition at line 38 of file SpecialExpandTemplates.php.

const SpecialExpandTemplates::MAX_INCLUDE_SIZE = 50000000

Definition at line 41 of file SpecialExpandTemplates.php.

---

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

• includes/specials/SpecialExpandTemplates.php