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  * @addtogroup 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                 $text = $params['text'];
  48                 $title = $params['title'];
  49                 $retval = '';
  50
  51                 //Create title for parser
  52                 $title_obj = Title :: newFromText($params['title']);
  53                 if(!$title_obj)
  54                         $title_obj = Title :: newFromText("API");       //  Default title is "API". For example, ExpandTemplates uses "ExpendTemplates" for it
  55
  56                 // Parse text
  57                 global $wgParser;
  58                 $retval = $wgParser->preprocess( $text, $title_obj, new ParserOptions() );
  59
  60                 // Return result
  61                 $result = $this->getResult();
  62                 $retval_array = array();
  63                 $result->setContent( $retval_array, $retval );
  64                 $result->addValue( null, $this->getModuleName(), $retval_array );
  65         }
  66
  67         public function getAllowedParams() {
  68                 return array (
  69                         'title' => array(
  70                                 ApiBase :: PARAM_DFLT => 'API',
  71                         ),
  72                         'text' => null
  73                 );
  74         }
  75
  76         public function getParamDescription() {
  77                 return array (
  78                         'text' => 'Wikitext to convert',
  79                         'title' => 'Title of page',
  80                 );
  81         }
  82
  83         public function getDescription() {
  84                 return 'This module expand all templates in wikitext';
  85         }
  86
  87         protected function getExamples() {
  88                 return array (
  89                         'api.php?action=expandtemplates&text={{Project:Sandbox}}'
  90                 );
  91         }
  92
  93         public function getVersion() {
  94                 return __CLASS__ . ': $Id$';
  95         }
  96 }