MediaWiki  1.23.13
ApiExpandTemplates.php
Go to the documentation of this file.
1 <?php
34 class ApiExpandTemplates extends ApiBase {
35 
36  public function execute() {
37  // Cache may vary on $wgUser because ParserOptions gets data from it
38  $this->getMain()->setCacheMode( 'anon-public-user-private' );
39 
40  // Get parameters
41  $params = $this->extractRequestParams();
42 
43  // Create title for parser
44  $title_obj = Title::newFromText( $params['title'] );
45  if ( !$title_obj || $title_obj->isExternal() ) {
46  $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
47  }
48 
49  $result = $this->getResult();
50 
51  // Parse text
54 
55  if ( $params['includecomments'] ) {
56  $options->setRemoveComments( false );
57  }
58 
59  if ( $params['generatexml'] ) {
60  $wgParser->startExternalParse( $title_obj, $options, OT_PREPROCESS );
61  $dom = $wgParser->preprocessToDom( $params['text'] );
62  if ( is_callable( array( $dom, 'saveXML' ) ) ) {
63  $xml = $dom->saveXML();
64  } else {
65  $xml = $dom->__toString();
66  }
67  $xml_result = array();
68  ApiResult::setContent( $xml_result, $xml );
69  $result->addValue( null, 'parsetree', $xml_result );
70  }
71  $retval = $wgParser->preprocess( $params['text'], $title_obj, $options );
72 
73  // Return result
74  $retval_array = array();
75  ApiResult::setContent( $retval_array, $retval );
76  $result->addValue( null, $this->getModuleName(), $retval_array );
77  }
78 
79  public function getAllowedParams() {
80  return array(
81  'title' => array(
82  ApiBase::PARAM_DFLT => 'API',
83  ),
84  'text' => array(
85  ApiBase::PARAM_TYPE => 'string',
87  ),
88  'generatexml' => false,
89  'includecomments' => false,
90  );
91  }
92 
93  public function getParamDescription() {
94  return array(
95  'text' => 'Wikitext to convert',
96  'title' => 'Title of page',
97  'generatexml' => 'Generate XML parse tree',
98  'includecomments' => 'Whether to include HTML comments in the output',
99  );
100  }
101 
102  public function getResultProperties() {
103  return array(
104  '' => array(
105  '*' => 'string'
106  )
107  );
108  }
109 
110  public function getDescription() {
111  return 'Expands all templates in wikitext.';
112  }
113 
114  public function getPossibleErrors() {
115  return array_merge( parent::getPossibleErrors(), array(
116  array( 'invalidtitle', 'title' ),
117  ) );
118  }
119 
120  public function getExamples() {
121  return array(
122  'api.php?action=expandtemplates&text={{Project:Sandbox}}'
123  );
124  }
125 
126  public function getHelpUrls() {
127  return 'https://www.mediawiki.org/wiki/API:Parsing_wikitext#expandtemplates';
128  }
129 }
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. $title:Title object for the current page $request:WebRequest $ignoreRedirect:boolean to skip redirect check $target:Title/string of redirect target $article:Article object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) $article:article(object) being checked 'IsTrustedProxy':Override the result of wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of User::isValidEmailAddr(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LinkBegin':Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1528
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:189
ContextSource\getContext
getContext()
Get the RequestContext object.
Definition: ContextSource.php:40
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
Definition: ApiBase.php:62
ApiExpandTemplates\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiExpandTemplates.php:110
ApiResult\setContent
static setContent(&$arr, $value, $subElemName=null)
Adds a content element to an array.
Definition: ApiResult.php:201
ApiBase\dieUsageMsg
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition: ApiBase.php:1933
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
ApiExpandTemplates\getResultProperties
getResultProperties()
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiExpandTemplates.php:102
OT_PREPROCESS
const OT_PREPROCESS
Definition: Defines.php:232
$params
$params
Definition: styleTest.css.php:40
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
ApiExpandTemplates\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiExpandTemplates.php:79
ApiExpandTemplates\getHelpUrls
getHelpUrls()
Definition: ApiExpandTemplates.php:126
ApiExpandTemplates\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiExpandTemplates.php:120
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
ApiExpandTemplates\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiExpandTemplates.php:93
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1530
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
ParserOptions\newFromContext
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
Definition: ParserOptions.php:396
ApiExpandTemplates\getPossibleErrors
getPossibleErrors()
Returns a list of all possible errors returned by the module.
Definition: ApiExpandTemplates.php:114
ApiExpandTemplates
API module that functions as a shortcut to the wikitext preprocessor.
Definition: ApiExpandTemplates.php:34
$wgParser
$wgParser
Definition: Setup.php:587
ApiExpandTemplates\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiExpandTemplates.php:36
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:46
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiBase\getMain
getMain()
Get the main module.
Definition: ApiBase.php:188
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:237