MediaWiki
1.28.0
|
A special page that expands submitted templates, parser functions, and variables, allowing easier debugging of these. More...
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... | |
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... | |
getTitle ($subpage=false) | |
Get a self-referential title object. 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 () | |
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... | |
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... | |
getLinkRenderer () | |
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... | |
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... | |
A special page that expands submitted templates, parser functions, and variables, allowing easier debugging of these.
Definition at line 30 of file SpecialExpandTemplates.php.
SpecialExpandTemplates::__construct | ( | ) |
Definition at line 47 of file SpecialExpandTemplates.php.
SpecialExpandTemplates::execute | ( | $subpage | ) |
Show the special page.
string | null | $subpage |
Definition at line 55 of file SpecialExpandTemplates.php.
References $options, $out, $output, $request, $title, $wgParser, generateHtml(), SpecialPage\getConfig(), SpecialPage\getContext(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), global, makeForm(), makeOutput(), ParserOptions\newFromContext(), Title\newFromText(), Parser\OT_PREPROCESS, SpecialPage\setHeaders(), showHtmlPreview(), and MWTidy\tidy().
|
private |
Renders the supplied wikitext as html.
Title | $title | |
string | $text |
Definition at line 242 of file SpecialExpandTemplates.php.
References $wgParser, SpecialPage\getContext(), Title\getPageLanguage(), global, and ParserOptions\newFromContext().
Referenced by execute().
|
protected |
Definition at line 293 of file SpecialExpandTemplates.php.
|
private |
Generate a form allowing users to enter information.
string | $title | Value for context title field |
string | $input | Value for input textbox |
Definition at line 156 of file SpecialExpandTemplates.php.
References $generateRawHtml, $generateXML, $removeComments, $removeNowiki, $title, HTMLForm\factory(), SpecialPage\getContext(), and SpecialPage\msg().
Referenced by execute().
|
private |
Generate a nice little box with a heading for output.
string | $output | Wiki text output |
string | $heading |
Definition at line 222 of file SpecialExpandTemplates.php.
References $out, $output, SpecialPage\msg(), and Xml\textarea().
Referenced by execute().
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.
array | $values | The values submitted to the HTMLForm |
Definition at line 141 of file SpecialExpandTemplates.php.
References $status, StatusValue\newFatal(), and StatusValue\newGood().
|
private |
Wraps the provided html code in a div and outputs it to the page.
Title | $title | |
ParserOutput | $pout | |
OutputPage | $out |
Definition at line 257 of file SpecialExpandTemplates.php.
References $lang, $request, $user, OutputPage\addHTML(), OutputPage\addParserOutputContent(), Html\closeElement(), ParserOutput\getCategories(), SpecialPage\getConfig(), Title\getPageViewLanguage(), SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\msg(), Html\openElement(), OutputPage\setCategoryLinks(), and OutputPage\wrapWikiMsg().
Referenced by execute().
|
protected |
Whether or not to show the raw HTML code.
Definition at line 36 of file SpecialExpandTemplates.php.
Referenced by makeForm().
|
protected |
Whether or not to show the XML parse tree.
Definition at line 33 of file SpecialExpandTemplates.php.
Referenced by makeForm().
|
protected |
Whether or not to remove comments in the expanded wikitext.
Definition at line 39 of file SpecialExpandTemplates.php.
Referenced by makeForm().
|
protected |
Whether or not to remove <nowiki> tags in the expanded wikitext.
Definition at line 42 of file SpecialExpandTemplates.php.
Referenced by makeForm().