MediaWiki  REL1_23
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
SpecialExpandTemplates Class Reference
SpecialPage

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

Inheritance diagram for SpecialExpandTemplates:
Inheritance graph
[legend]
Collaboration diagram for SpecialExpandTemplates:
Collaboration graph
[legend]

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

boolean $generateRawHtml
 whether or not to show the raw HTML code *
boolean $generateXML
 whether or not to show the XML parse tree *
boolean $removeComments
 whether or not to remove comments in the expanded wikitext *
boolean $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, $html, 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.

Reimplemented from SpecialPage.

Definition at line 50 of file SpecialExpandTemplates.php.

References $options, $out, $output, $title, $wgParser, array(), generateHtml(), SpecialPage\getContext(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), global, makeForm(), makeOutput(), ParserOptions\newFromContext(), Title\newFromText(), SpecialPage\setHeaders(), showHtmlPreview(), and MWTidy\tidy().

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

Renders the supplied wikitext as html.

Parameters:
Title$title
string$text
Returns:
string

Definition at line 223 of file SpecialExpandTemplates.php.

Referenced by execute().

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$titleValue for context title field
string$inputValue for input textbox
Returns:
string

Definition at line 134 of file SpecialExpandTemplates.php.

Referenced by execute().

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

Generate a nice little box with a heading for output.

Parameters:
string$outputWiki text output
string$heading
Returns:
string

Definition at line 203 of file SpecialExpandTemplates.php.

Referenced by execute().

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

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

Parameters:
Title$title
string$html
OutputPage$out

Definition at line 240 of file SpecialExpandTemplates.php.

Referenced by execute().

Member Data Documentation

boolean SpecialExpandTemplates::$generateRawHtml [protected]

whether or not to show the raw HTML code *

Definition at line 34 of file SpecialExpandTemplates.php.

boolean SpecialExpandTemplates::$generateXML [protected]

whether or not to show the XML parse tree *

Definition at line 32 of file SpecialExpandTemplates.php.

boolean SpecialExpandTemplates::$removeComments [protected]

whether or not to remove comments in the expanded wikitext *

Definition at line 36 of file SpecialExpandTemplates.php.

boolean 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: