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