MediaWiki REL1_28
Go to the documentation of this file.
36 public function execute() {
37 // Cache may vary on the user because ParserOptions gets data from it
38 $this->getMain()->setCacheMode( 'anon-public-user-private' );
40 // Get parameters
42 $this->requireMaxOneParameter( $params, 'prop', 'generatexml' );
44 if ( $params['prop'] === null ) {
45 $this->logFeatureUsage( 'action=expandtemplates&!prop' );
46 $this->setWarning( 'Because no values have been specified for the prop parameter, a ' .
47 'legacy format has been used for the output. This format is deprecated, and in ' .
48 'the future, a default value will be set for the prop parameter, causing the new' .
49 'format to always be used.' );
50 $prop = [];
51 } else {
52 $prop = array_flip( $params['prop'] );
53 }
55 // Get title and revision ID for parser
56 $revid = $params['revid'];
57 if ( $revid !== null ) {
58 $rev = Revision::newFromId( $revid );
59 if ( !$rev ) {
60 $this->dieUsage( "There is no revision ID $revid", 'missingrev' );
61 }
62 $title_obj = $rev->getTitle();
63 } else {
64 $title_obj = Title::newFromText( $params['title'] );
65 if ( !$title_obj || $title_obj->isExternal() ) {
66 $this->dieUsageMsg( [ 'invalidtitle', $params['title'] ] );
67 }
68 }
70 $result = $this->getResult();
72 // Parse text
76 if ( $params['includecomments'] ) {
77 $options->setRemoveComments( false );
78 }
80 $reset = null;
81 $suppressCache = false;
82 Hooks::run( 'ApiMakeParserOptions',
83 [ $options, $title_obj, $params, $this, &$reset, &$suppressCache ] );
85 $retval = [];
87 if ( isset( $prop['parsetree'] ) || $params['generatexml'] ) {
88 $wgParser->startExternalParse( $title_obj, $options, Parser::OT_PREPROCESS );
89 $dom = $wgParser->preprocessToDom( $params['text'] );
90 if ( is_callable( [ $dom, 'saveXML' ] ) ) {
91 $xml = $dom->saveXML();
92 } else {
93 $xml = $dom->__toString();
94 }
95 if ( isset( $prop['parsetree'] ) ) {
96 unset( $prop['parsetree'] );
97 $retval['parsetree'] = $xml;
98 } else {
99 // the old way
100 $result->addValue( null, 'parsetree', $xml );
101 $result->addValue( null, ApiResult::META_BC_SUBELEMENTS, [ 'parsetree' ] );
102 }
103 }
105 // if they didn't want any output except (probably) the parse tree,
106 // then don't bother actually fully expanding it
107 if ( $prop || $params['prop'] === null ) {
108 $wgParser->startExternalParse( $title_obj, $options, Parser::OT_PREPROCESS );
109 $frame = $wgParser->getPreprocessor()->newFrame();
110 $wikitext = $wgParser->preprocess( $params['text'], $title_obj, $options, $revid, $frame );
111 if ( $params['prop'] === null ) {
112 // the old way
113 ApiResult::setContentValue( $retval, 'wikitext', $wikitext );
114 } else {
115 $p_output = $wgParser->getOutput();
116 if ( isset( $prop['categories'] ) ) {
117 $categories = $p_output->getCategories();
118 if ( $categories ) {
119 $categories_result = [];
120 foreach ( $categories as $category => $sortkey ) {
121 $entry = [];
122 $entry['sortkey'] = $sortkey;
123 ApiResult::setContentValue( $entry, 'category', (string)$category );
124 $categories_result[] = $entry;
125 }
126 ApiResult::setIndexedTagName( $categories_result, 'category' );
127 $retval['categories'] = $categories_result;
128 }
129 }
130 if ( isset( $prop['properties'] ) ) {
131 $properties = $p_output->getProperties();
132 if ( $properties ) {
133 ApiResult::setArrayType( $properties, 'BCkvp', 'name' );
134 ApiResult::setIndexedTagName( $properties, 'property' );
135 $retval['properties'] = $properties;
136 }
137 }
138 if ( isset( $prop['volatile'] ) ) {
139 $retval['volatile'] = $frame->isVolatile();
140 }
141 if ( isset( $prop['ttl'] ) && $frame->getTTL() !== null ) {
142 $retval['ttl'] = $frame->getTTL();
143 }
144 if ( isset( $prop['wikitext'] ) ) {
145 $retval['wikitext'] = $wikitext;
146 }
147 if ( isset( $prop['modules'] ) ) {
148 $retval['modules'] = array_values( array_unique( $p_output->getModules() ) );
149 $retval['modulescripts'] = array_values( array_unique( $p_output->getModuleScripts() ) );
150 $retval['modulestyles'] = array_values( array_unique( $p_output->getModuleStyles() ) );
151 }
152 if ( isset( $prop['jsconfigvars'] ) ) {
153 $retval['jsconfigvars'] =
154 ApiResult::addMetadataToResultVars( $p_output->getJsConfigVars() );
155 }
156 if ( isset( $prop['encodedjsconfigvars'] ) ) {
157 $retval['encodedjsconfigvars'] = FormatJson::encode(
158 $p_output->getJsConfigVars(), false, FormatJson::ALL_OK
159 );
160 $retval[ApiResult::META_SUBELEMENTS][] = 'encodedjsconfigvars';
161 }
162 if ( isset( $prop['modules'] ) &&
163 !isset( $prop['jsconfigvars'] ) && !isset( $prop['encodedjsconfigvars'] ) ) {
164 $this->setWarning( "Property 'modules' was set but not 'jsconfigvars' " .
165 "or 'encodedjsconfigvars'. Configuration variables are necessary " .
166 'for proper module usage.' );
167 }
168 }
169 }
170 ApiResult::setSubelementsList( $retval, [ 'wikitext', 'parsetree' ] );
171 $result->addValue( null, $this->getModuleName(), $retval );
172 }
174 public function getAllowedParams() {
175 return [
176 'title' => [
177 ApiBase::PARAM_DFLT => 'API',
178 ],
179 'text' => [
180 ApiBase::PARAM_TYPE => 'text',
182 ],
183 'revid' => [
184 ApiBase::PARAM_TYPE => 'integer',
185 ],
186 'prop' => [
188 'wikitext',
189 'categories',
190 'properties',
191 'volatile',
192 'ttl',
193 'modules',
194 'jsconfigvars',
195 'encodedjsconfigvars',
196 'parsetree',
197 ],
200 ],
201 'includecomments' => false,
202 'generatexml' => [
203 ApiBase::PARAM_TYPE => 'boolean',
205 ],
206 ];
207 }
209 protected function getExamplesMessages() {
210 return [
211 'action=expandtemplates&text={{Project:Sandbox}}'
212 => 'apihelp-expandtemplates-example-simple',
213 ];
214 }
216 public function getHelpUrls() {
217 return '';
218 }
Definition Setup.php:821
This abstract class implements many basic API functions, and is the base of all API classes.
Definition ApiBase.php:39
(boolean) Is the parameter required?
Definition ApiBase.php:112
(boolean) Is the parameter deprecated (will show a warning)?
Definition ApiBase.php:106
Get the main module.
Definition ApiBase.php:480
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:88
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:50
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:685
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:157
dieUsageMsg( $error)
Output the error message related to a certain array.
Definition ApiBase.php:2203
setWarning( $warning)
Set warning section for this module.
Definition ApiBase.php:1554
Get the result object.
Definition ApiBase.php:584
requireMaxOneParameter( $params, $required)
Die if more than one of a certain set of parameters is set and not false.
Definition ApiBase.php:747
logFeatureUsage( $feature)
Write logging information for API features to a debug log, for usage analysis.
Definition ApiBase.php:2304
Get the name of the module being executed by this instance.
Definition ApiBase.php:464
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition ApiBase.php:1585
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:53
API module that functions as a shortcut to the wikitext preprocessor.
Returns usage examples for this module.
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Evaluates the parameters, performs the requested query, and sets up the result.
Return links to more detailed help pages about the module.
static setArrayType(array &$arr, $type, $kvpKeyName=null)
Set the array data type.
static addMetadataToResultVars( $vars, $forceHash=true)
Add the correct metadata to an array of vars we want to export through the API.
Key for the 'subelements' metadata item.
Definition ApiResult.php:76
static setSubelementsList(array &$arr, $names)
Causes the elements with the specified names to be output as subelements rather than attributes.
Key for the 'BC subelements' metadata item.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
static setContentValue(array &$arr, $name, $value, $flags=0)
Add an output value to the array by name and mark as META_CONTENT.
Get the base IContextSource object.
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition Revision.php:110
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
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. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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. '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) '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 '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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. 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:1937
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 local account incomplete not yet checked for validity & $retval
Definition hooks.txt:268
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition hooks.txt:1096
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1734
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37