4 * Created on Sep 19, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiFormatBase.php');
34 class ApiFormatXml
extends ApiFormatBase
{
36 private $mRootElemName = 'api';
37 private $mDoubleQuote = false;
39 public function __construct($main, $format) {
40 parent
:: __construct($main, $format);
43 public function getMimeType() {
47 public function getNeedsRawData() {
51 public function setRootElement($rootElemName) {
52 $this->mRootElemName
= $rootElemName;
55 public function execute() {
56 $params = $this->extractRequestParams();
57 $this->mDoubleQuote
= $params['xmldoublequote'];
59 $this->printText('<?xml version="1.0" encoding="utf-8"?>');
60 $this->recXmlPrint($this->mRootElemName
, $this->getResultData(), $this->getIsHtml() ?
-2 : null);
64 * This method takes an array and converts it into an xml.
65 * There are several noteworthy cases:
67 * If array contains a key '_element', then the code assumes that ALL other keys are not important and replaces them with the value['_element'].
68 * Example: name='root', value = array( '_element'=>'page', 'x', 'y', 'z') creates <root> <page>x</page> <page>y</page> <page>z</page> </root>
70 * If any of the array's element key is '*', then the code treats all other key->value pairs as attributes, and the value['*'] as the element's content.
71 * Example: name='root', value = array( '*'=>'text', 'lang'=>'en', 'id'=>10) creates <root lang='en' id='10'>text</root>
73 * If neither key is found, all keys become element names, and values become element content.
74 * The method is recursive, so the same rules apply to any sub-arrays.
76 function recXmlPrint($elemName, $elemValue, $indent) {
77 if (!is_null($indent)) {
79 $indstr = "\n" . str_repeat(" ", $indent);
84 switch (gettype($elemValue)) {
86 if (isset ($elemValue['_attribs'])) {
87 $attribValues = $elemValue['_attribs'];
88 unset( $elemValue['_attribs'] );
93 if (isset ($elemValue['*'])) {
94 $subElemContent = $elemValue['*'];
95 if ($this->mDoubleQuote
)
96 $subElemContent = $this->doubleQuote($subElemContent);
97 unset ($elemValue['*']);
99 $subElemContent = null;
102 if (isset ($elemValue['_element'])) {
103 $subElemIndName = $elemValue['_element'];
104 unset ($elemValue['_element']);
106 $subElemIndName = null;
109 $indElements = array ();
110 $subElements = array ();
111 foreach ($elemValue as $subElemId => & $subElemValue) {
112 if (is_string($subElemValue) && $this->mDoubleQuote
)
113 $subElemValue = $this->doubleQuote($subElemValue);
115 if (gettype($subElemId) === 'integer') {
116 $indElements[] = $subElemValue;
117 unset ($elemValue[$subElemId]);
118 } elseif (is_array($subElemValue)) {
119 $subElements[$subElemId] = $subElemValue;
120 unset ($elemValue[$subElemId]);
124 $elemValue = wfArrayMerge( $attribValues, $elemValue ); // wtf
126 if (is_null($subElemIndName) && !empty ($indElements))
127 ApiBase
:: dieDebug(__METHOD__
, "($elemName, ...) has integer keys without _element value. Use ApiResult::setIndexedTagName().");
129 if (!empty ($subElements) && !empty ($indElements) && !is_null($subElemContent))
130 ApiBase
:: dieDebug(__METHOD__
, "($elemName, ...) has content and subelements");
132 if (!is_null($subElemContent)) {
133 $this->printText($indstr . wfElement($elemName, $elemValue, $subElemContent));
134 } elseif (empty ($indElements) && empty ($subElements)) {
135 $this->printText($indstr . wfElement($elemName, $elemValue));
137 $this->printText($indstr . wfElement($elemName, $elemValue, null));
139 foreach ($subElements as $subElemId => & $subElemValue)
140 $this->recXmlPrint($subElemId, $subElemValue, $indent);
142 foreach ($indElements as $subElemId => & $subElemValue)
143 $this->recXmlPrint($subElemIndName, $subElemValue, $indent);
145 $this->printText($indstr . wfCloseElement($elemName));
152 $this->printText($indstr . wfElement($elemName, null, $elemValue));
156 private function doubleQuote( $text ) {
157 return Sanitizer
::encodeAttribute( $text );
160 public function getAllowedParams() {
162 'xmldoublequote' => false
166 public function getParamDescription() {
168 'xmldoublequote' => 'If specified, double quotes all attributes and content.',
173 public function getDescription() {
174 return 'Output data in XML format' . parent
:: getDescription();
177 public function getVersion() {
178 return __CLASS__
. ': $Id$';