4 * Created on Oct 05, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ("ApiBase.php");
32 * API module that functions as a shortcut to the wikitext preprocessor. Expands
33 * any templates in a provided string, and returns the result of this expansion
38 class ApiExpandTemplates
extends ApiBase
{
40 public function __construct($main, $action) {
41 parent
:: __construct($main, $action);
44 public function execute() {
46 extract( $this->extractRequestParams() );
49 //Create title for parser
50 $title_obj = Title
:: newFromText( $title );
52 $title_obj = Title
:: newFromText( "API" ); // Default title is "API". For example, ExpandTemplates uses "ExpendTemplates" for it
54 $result = $this->getResult();
58 $options = new ParserOptions();
61 $wgParser->startExternalParse( $title_obj, $options, OT_PREPROCESS
);
62 $dom = $wgParser->preprocessToDom( $text );
63 if ( is_callable( array( $dom, 'saveXML' ) ) ) {
64 $xml = $dom->saveXML();
66 $xml = $dom->__toString();
68 $xml_result = array();
69 $result->setContent( $xml_result, $xml );
70 $result->addValue( null, 'parsetree', $xml_result);
72 $retval = $wgParser->preprocess( $text, $title_obj, $options );
75 $retval_array = array();
76 $result->setContent( $retval_array, $retval );
77 $result->addValue( null, $this->getModuleName(), $retval_array );
80 public function getAllowedParams() {
83 ApiBase
:: PARAM_DFLT
=> 'API',
86 'generatexml' => false,
90 public function getParamDescription() {
92 'text' => 'Wikitext to convert',
93 'title' => 'Title of page',
94 'generatexml' => 'Generate XML parse tree',
98 public function getDescription() {
99 return 'This module expand all templates in wikitext';
102 protected function getExamples() {
104 'api.php?action=expandtemplates&text={{Project:Sandbox}}'
108 public function getVersion() {
109 return __CLASS__
. ': $Id$';