-<?php\r
-\r
-/*\r
- * Created on Oct 05, 2007\r
- *\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
- // Eclipse helper - will be ignored in production\r
- require_once ("ApiBase.php");\r
-}\r
-\r
-/**\r
- * @addtogroup API\r
- */\r
-class ApiExpandTemplates extends ApiBase {\r
-\r
- public function __construct($main, $action) {\r
- parent :: __construct($main, $action);\r
- }\r
-\r
- public function execute() {\r
- // Get parameters\r
- $params = $this->extractRequestParams();\r
- $text = $params['text'];\r
- $title = $params['title'];\r
- $retval = '';\r
-\r
- //Create title for parser\r
- $title_obj = Title :: newFromText($params['title']);\r
- if(!$title_obj)\r
- $title_obj = Title :: newFromText("API"); // Default title is "API". For example, ExpandTemplates uses "ExpendTemplates" for it\r
-\r
- // Parse text\r
- global $wgParser;\r
- $retval = $wgParser->preprocess( $text, $title_obj, new ParserOptions() );\r
-\r
- // Return result\r
- $result = $this->getResult();\r
- $retval_array = array();\r
- $result->setContent( $retval_array, $retval );\r
- $result->addValue( null, 'expandtemplates', $retval_array );\r
- }\r
-\r
- protected function getAllowedParams() {\r
- return array (\r
- 'title' => array( \r
- ApiBase :: PARAM_DFLT => 'API',\r
- ),\r
- 'text' => null\r
- );\r
- }\r
-\r
- protected function getParamDescription() {\r
- return array (\r
- 'text' => 'Wikitext to convert',\r
- 'title' => 'Title of page',\r
- );\r
- }\r
-\r
- protected function getDescription() {\r
- return 'This module expand all templates in wikitext';\r
- }\r
-\r
- protected function getExamples() {\r
- return array (\r
- 'api.php?action=expandtemplates&text={{Project:Sandbox}}'\r
- );\r
- }\r
-\r
- public function getVersion() {\r
- return __CLASS__ . ': $Id$';\r
- }\r
-}\r
-\r
+<?php
+/**
+ * API for MediaWiki 1.8+
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.,
+ * 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" );
+}
+
+/**
+ * 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 execute() {
+ // Cache may vary on $wgUser because ParserOptions gets data from it
+ $this->getMain()->setCacheMode( 'anon-public-user-private' );
+
+ // Get parameters
+ $params = $this->extractRequestParams();
+
+ // Create title for parser
+ $title_obj = Title::newFromText( $params['title'] );
+ if ( !$title_obj ) {
+ $title_obj = Title::newFromText( 'API' ); // default
+ }
+
+ $result = $this->getResult();
+
+ // Parse text
+ global $wgParser;
+ $options = new ParserOptions();
+
+ 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
+ $retval_array = array();
+ $result->setContent( $retval_array, $retval );
+ $result->addValue( null, $this->getModuleName(), $retval_array );
+ }
+
+ public function getAllowedParams() {
+ return array(
+ 'title' => array(
+ ApiBase::PARAM_DFLT => 'API',
+ ),
+ 'text' => null,
+ 'generatexml' => false,
+ );
+ }
+
+ public function getParamDescription() {
+ return array(
+ 'text' => 'Wikitext to convert',
+ 'title' => 'Title of page',
+ 'generatexml' => 'Generate XML parse tree',
+ );
+ }
+
+ public function getDescription() {
+ return 'This module expand all templates in wikitext';
+ }
+
+ protected function getExamples() {
+ return array(
+ 'api.php?action=expandtemplates&text={{Project:Sandbox}}'
+ );
+ }
+
+ public function getVersion() {
+ return __CLASS__ . ': $Id$';
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff