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

Inheritance diagram for SpecialExpandTemplates:

[legend]

Collaboration diagram for SpecialExpandTemplates:

[legend]

Public Member Functions
	__construct (Parser $parser, UserOptionsLookup $userOptionsLookup, TidyDriverBase $tidy)

	execute ( $subpage)
	Show the special page.

	onSubmitInput (array $values)
	Callback for the HTMLForm used in self::makeForm.

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	doesWrites ()
	Indicates whether this special page may perform database writes.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page.

	getName ()
	Get the name of this Special Page.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode.

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	isListed ()
	Whether this special page is listed in Special:SpecialPages.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

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 Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.

	getAuthManager ()

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSpecialPageFactory ()

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

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.

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

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.

Private Attributes
Parser	$parser

TidyDriverBase	$tidy

UserOptionsLookup	$userOptionsLookup

Additional Inherited Members
Static Public Member Functions inherited from SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Detailed Description

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

Definition at line 33 of file SpecialExpandTemplates.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialExpandTemplates::__construct	(	Parser	$parser,
		UserOptionsLookup	$userOptionsLookup,
		TidyDriverBase	$tidy
	)

Parameters

Parser	$parser
UserOptionsLookup	$userOptionsLookup
TidyDriverBase	$tidy

Definition at line 64 of file SpecialExpandTemplates.php.

References $parser, $tidy, and $userOptionsLookup.

Member Function Documentation

◆ execute()

SpecialExpandTemplates::execute ( $subpage )

Show the special page.

Parameters

string | null $subpage

Reimplemented from SpecialPage.

Definition at line 79 of file SpecialExpandTemplates.php.

References $title, SpecialPage\addHelpLink(), generateHtml(), SpecialPage\getConfig(), SpecialPage\getContext(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), makeForm(), makeOutput(), Parser\OT_PREPROCESS, SpecialPage\setHeaders(), and showHtmlPreview().

◆ generateHtml()

SpecialExpandTemplates::generateHtml	(	Title	$title,
			$text
	)

private

Renders the supplied wikitext as html.

Parameters

Title	$title
string	$text

Returns: ParserOutput

Definition at line 269 of file SpecialExpandTemplates.php.

References $title, and SpecialPage\getContext().

Referenced by execute().

◆ getGroupName()

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

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 318 of file SpecialExpandTemplates.php.

◆ makeForm()

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

Definition at line 179 of file SpecialExpandTemplates.php.

References $generateRawHtml, $generateXML, $removeComments, $removeNowiki, $title, SpecialPage\getContext(), and SpecialPage\msg().

Referenced by execute().

◆ makeOutput()

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 245 of file SpecialExpandTemplates.php.

References SpecialPage\msg().

Referenced by execute().

◆ onSubmitInput()

SpecialExpandTemplates::onSubmitInput ( array $values )

Callback for the HTMLForm used in self::makeForm.

Checks, if the input was given, and if not, returns a fatal Status object with an error message.

Parameters

array $values The values submitted to the HTMLForm

Returns: Status

Definition at line 165 of file SpecialExpandTemplates.php.

◆ showHtmlPreview()

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 282 of file SpecialExpandTemplates.php.

References $lang, $title, OutputPage\addHTML(), OutputPage\addParserOutputContent(), ParserOutput\getCategories(), SpecialPage\getConfig(), SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\msg(), OutputPage\setCategoryLinks(), and OutputPage\wrapWikiMsg().

Referenced by execute().

Member Data Documentation

◆ $generateRawHtml

bool SpecialExpandTemplates::$generateRawHtml

protected

Whether or not to show the raw HTML code.

Definition at line 39 of file SpecialExpandTemplates.php.

Referenced by makeForm().

◆ $generateXML

bool SpecialExpandTemplates::$generateXML

protected

Whether or not to show the XML parse tree.

Definition at line 36 of file SpecialExpandTemplates.php.

Referenced by makeForm().

◆ $parser

Parser SpecialExpandTemplates::$parser

private

Initial value:

=

private const MAX_INCLUDE_SIZE 50000000

Definition at line 51 of file SpecialExpandTemplates.php.

Referenced by __construct().

◆ $removeComments

bool SpecialExpandTemplates::$removeComments

protected

Whether or not to remove comments in the expanded wikitext.

Definition at line 42 of file SpecialExpandTemplates.php.

Referenced by makeForm().

◆ $removeNowiki

bool SpecialExpandTemplates::$removeNowiki

protected

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

Definition at line 45 of file SpecialExpandTemplates.php.

Referenced by makeForm().

◆ $tidy

TidyDriverBase SpecialExpandTemplates::$tidy

private

Definition at line 57 of file SpecialExpandTemplates.php.

Referenced by __construct().

◆ $userOptionsLookup

UserOptionsLookup SpecialExpandTemplates::$userOptionsLookup

private

Definition at line 54 of file SpecialExpandTemplates.php.

Referenced by __construct().

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

includes/specials/SpecialExpandTemplates.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ generateHtml()

◆ getGroupName()

◆ makeForm()

◆ makeOutput()

◆ onSubmitInput()

◆ showHtmlPreview()

Member Data Documentation

◆ $generateRawHtml

◆ $generateXML

◆ $parser

◆ $removeComments

◆ $removeNowiki

◆ $tidy

◆ $userOptionsLookup