MediaWiki  master
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:

Public Member Functions

 __construct ()
 
 execute ( $subpage)
 Show the special page. More...
 
 onSubmitInput (array $values)
 Callback for the HTMLForm used in self::makeForm. More...
 
- 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. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 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. More...
 
 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. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 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. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 getGroupName ()
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 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'. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

bool $generateRawHtml
 Whether or not to show the raw HTML code. More...
 
bool $generateXML
 Whether or not to show the XML parse tree. More...
 
bool $removeComments
 Whether or not to remove comments in the expanded wikitext. More...
 
bool $removeNowiki
 Whether or not to remove <nowiki> tags in the expanded wikitext. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Private Member Functions

 generateHtml (Title $title, $text)
 Renders the supplied wikitext as html. More...
 
 makeForm ( $title, $input)
 Generate a form allowing users to enter information. More...
 
 makeOutput ( $output, $heading='expand_templates_output')
 Generate a nice little box with a heading for output. More...
 
 showHtmlPreview (Title $title, ParserOutput $pout, OutputPage $out)
 Wraps the provided html code in a div and outputs it to the page. More...
 

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. More...
 
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. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- 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). More...
 

Detailed Description

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

Definition at line 32 of file SpecialExpandTemplates.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialExpandTemplates::__construct ( )

Definition at line 49 of file SpecialExpandTemplates.php.

Member Function Documentation

◆ execute()

◆ generateHtml()

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

Renders the supplied wikitext as html.

Parameters
Title$title
string$text
Returns
ParserOutput

Definition at line 251 of file SpecialExpandTemplates.php.

References SpecialPage\getContext(), Title\getPageLanguage(), and ParserOptions\newFromContext().

Referenced by execute().

◆ getGroupName()

SpecialExpandTemplates::getGroupName ( )
protected

Definition at line 303 of file SpecialExpandTemplates.php.

◆ makeForm()

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

Definition at line 161 of file SpecialExpandTemplates.php.

References $generateRawHtml, $generateXML, $removeComments, $removeNowiki, $title, HTMLForm\factory(), 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$outputWiki text output
string$heading
Returns
string

Definition at line 227 of file SpecialExpandTemplates.php.

References SpecialPage\getUser(), SpecialPage\msg(), and Xml\textarea().

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$valuesThe values submitted to the HTMLForm
Returns
Status

Definition at line 147 of file SpecialExpandTemplates.php.

References StatusValue\newFatal(), and StatusValue\newGood().

◆ showHtmlPreview()

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

Member Data Documentation

◆ $generateRawHtml

bool SpecialExpandTemplates::$generateRawHtml
protected

Whether or not to show the raw HTML code.

Definition at line 38 of file SpecialExpandTemplates.php.

Referenced by makeForm().

◆ $generateXML

bool SpecialExpandTemplates::$generateXML
protected

Whether or not to show the XML parse tree.

Definition at line 35 of file SpecialExpandTemplates.php.

Referenced by makeForm().

◆ $removeComments

bool SpecialExpandTemplates::$removeComments
protected

Whether or not to remove comments in the expanded wikitext.

Definition at line 41 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 44 of file SpecialExpandTemplates.php.

Referenced by makeForm().


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