<?php
-
-/*
- * Created on Oct 05, 2007
+/**
*
- * API for MediaWiki 1.8+
*
- * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Oct 05, 2007
+ *
+ * Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
-if (!defined('MEDIAWIKI')) {
- // Eclipse helper - will be ignored in production
- require_once ("ApiBase.php");
-}
-
/**
- * @addtogroup API
+ * API module that functions as a shortcut to the wikitext preprocessor. Expands
+ * any templates in a provided string, and returns the result of this expansion
+ * to the caller.
+ *
+ * @ingroup API
*/
class ApiExpandTemplates extends ApiBase {
- public function __construct($main, $action) {
- parent :: __construct($main, $action);
+ public function __construct( $main, $action ) {
+ parent::__construct( $main, $action );
}
public function execute() {
+ // Cache may vary on $wgUser because ParserOptions gets data from it
+ $this->getMain()->setCacheMode( 'anon-public-user-private' );
+
// Get parameters
$params = $this->extractRequestParams();
- $text = $params['text'];
- $title = $params['title'];
- $retval = '';
- //Create title for parser
- $title_obj = Title :: newFromText($params['title']);
- if(!$title_obj)
- $title_obj = Title :: newFromText("API"); // Default title is "API". For example, ExpandTemplates uses "ExpendTemplates" for it
+ // Create title for parser
+ $title_obj = Title::newFromText( $params['title'] );
+ if ( !$title_obj ) {
+ $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
+ }
+
+ $result = $this->getResult();
// Parse text
global $wgParser;
- $retval = $wgParser->preprocess( $text, $title_obj, new ParserOptions() );
+ $options = ParserOptions::newFromContext( $this->getContext() );
+
+ if ( $params['includecomments'] ) {
+ $options->setRemoveComments( false );
+ }
+
+ if ( $params['generatexml'] ) {
+ $wgParser->startExternalParse( $title_obj, $options, OT_PREPROCESS );
+ $dom = $wgParser->preprocessToDom( $params['text'] );
+ if ( is_callable( array( $dom, 'saveXML' ) ) ) {
+ $xml = $dom->saveXML();
+ } else {
+ $xml = $dom->__toString();
+ }
+ $xml_result = array();
+ $result->setContent( $xml_result, $xml );
+ $result->addValue( null, 'parsetree', $xml_result );
+ }
+ $retval = $wgParser->preprocess( $params['text'], $title_obj, $options );
// Return result
- $result = $this->getResult();
$retval_array = array();
$result->setContent( $retval_array, $retval );
- $result->addValue( null, 'expandtemplates', $retval_array );
+ $result->addValue( null, $this->getModuleName(), $retval_array );
}
- protected function getAllowedParams() {
- return array (
- 'title' => array(
- ApiBase :: PARAM_DFLT => 'API',
+ public function getAllowedParams() {
+ return array(
+ 'title' => array(
+ ApiBase::PARAM_DFLT => 'API',
),
- 'text' => null
+ 'text' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_REQUIRED => true,
+ ),
+ 'generatexml' => false,
+ 'includecomments' => false,
);
}
- protected function getParamDescription() {
- return array (
+ public function getParamDescription() {
+ return array(
'text' => 'Wikitext to convert',
'title' => 'Title of page',
+ 'generatexml' => 'Generate XML parse tree',
+ 'includecomments' => 'Whether to include HTML comments in the output',
+ );
+ }
+
+ public function getResultProperties() {
+ return array(
+ '' => array(
+ '*' => 'string'
+ )
);
}
- protected function getDescription() {
- return 'This module expand all templates in wikitext';
+ public function getDescription() {
+ return 'Expands all templates in wikitext';
+ }
+
+ public function getPossibleErrors() {
+ return array_merge( parent::getPossibleErrors(), array(
+ array( 'invalidtitle', 'title' ),
+ ) );
}
- protected function getExamples() {
- return array (
+ public function getExamples() {
+ return array(
'api.php?action=expandtemplates&text={{Project:Sandbox}}'
);
}
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/API:Parsing_wikitext#expandtemplates';
+ }
+
public function getVersion() {
return __CLASS__ . ': $Id$';
}
}
-