includes/api/ApiExpandTemplates.php

   1 <?php
   2
   3 /*
   4  * Created on Oct 05, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( "ApiBase.php" );
  29 }
  30
  31 /**
  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
  34  * to the caller.
  35  *
  36  * @ingroup API
  37  */
  38 class ApiExpandTemplates extends ApiBase {
  39
  40         public function __construct( $main, $action ) {
  41                 parent :: __construct( $main, $action );
  42         }
  43
  44         public function execute() {
  45                 // Get parameters
  46                 $params = $this->extractRequestParams();
  47
  48                 // Create title for parser
  49                 $title_obj = Title :: newFromText( $params['title'] );
  50                 if ( !$title_obj )
  51                         $title_obj = Title :: newFromText( "API" ); // default
  52
  53                 $result = $this->getResult();
  54
  55                 // Parse text
  56                 global $wgParser;
  57                 $options = new ParserOptions();
  58
  59                 if ( $params['generatexml'] )
  60                 {
  61                         $wgParser->startExternalParse( $title_obj, $options, OT_PREPROCESS );
  62                         $dom = $wgParser->preprocessToDom( $params['text'] );
  63                         if ( is_callable( array( $dom, 'saveXML' ) ) ) {
  64                                 $xml = $dom->saveXML();
  65                         } else {
  66                                 $xml = $dom->__toString();
  67                         }
  68                         $xml_result = array();
  69                         $result->setContent( $xml_result, $xml );
  70                         $result->addValue( null, 'parsetree', $xml_result );
  71                 }
  72                 $retval = $wgParser->preprocess( $params['text'], $title_obj, $options );
  73
  74                 // Return result
  75                 $retval_array = array();
  76                 $result->setContent( $retval_array, $retval );
  77                 $result->addValue( null, $this->getModuleName(), $retval_array );
  78         }
  79
  80         public function getAllowedParams() {
  81                 return array (
  82                         'title' => array(
  83                                 ApiBase :: PARAM_DFLT => 'API',
  84                         ),
  85                         'text' => null,
  86                         'generatexml' => false,
  87                 );
  88         }
  89
  90         public function getParamDescription() {
  91                 return array (
  92                         'text' => 'Wikitext to convert',
  93                         'title' => 'Title of page',
  94                         'generatexml' => 'Generate XML parse tree',
  95                 );
  96         }
  97
  98         public function getDescription() {
  99                 return 'This module expand all templates in wikitext';
 100         }
 101
 102         protected function getExamples() {
 103                 return array (
 104                         'api.php?action=expandtemplates&text={{Project:Sandbox}}'
 105                 );
 106         }
 107
 108         public function getVersion() {
 109                 return __CLASS__ . ': $Id$';
 110         }
 111 }