War on wfElement() and friends. Call the Xml members directly, rather than using...

[lhc/web/wiklou.git] / includes / api / ApiFormatXml.php

diff --git a/includes/api/ApiFormatXml.php b/includes/api/ApiFormatXml.php
index 11efcf9..5004f1a 100644 (file)
--- a/includes/api/ApiFormatXml.php
+++ b/includes/api/ApiFormatXml.php
@@ -1,12 +1,11 @@
 <?php
 
-
 /*
  * Created on Sep 19, 2006
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Copyright (C) 2006 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
@@ -29,8 +28,14 @@ if (!defined('MEDIAWIKI')) {
        require_once ('ApiFormatBase.php');
 }
 
+/**
+ * @ingroup API
+ */
 class ApiFormatXml extends ApiFormatBase {
 
+       private $mRootElemName = 'api';
+       private $mDoubleQuote = false;
+
        public function __construct($main, $format) {
                parent :: __construct($main, $format);
        }
@@ -43,21 +48,20 @@ class ApiFormatXml extends ApiFormatBase {
                return true;
        }
 
-       public function execute() {
-               $xmlindent = null;
-               extract($this->extractRequestParams());
+       public function setRootElement($rootElemName) {
+               $this->mRootElemName = $rootElemName;
+       }
 
-               if ($xmlindent || $this->getIsHtml())
-                       $xmlindent = -2;
-               else
-                       $xmlindent = null;
+       public function execute() {
+               $params = $this->extractRequestParams();
+               $this->mDoubleQuote = $params['xmldoublequote'];
 
-               $this->printText('<?xml version="1.0" encoding="utf-8"?>');
-               $this->recXmlPrint('api', $this->getResultData(), $xmlindent);
+               $this->printText('<?xml version="1.0"?>');
+               $this->recXmlPrint($this->mRootElemName, $this->getResultData(), $this->getIsHtml() ? -2 : null);
        }
 
        /**
-       * This method takes an array and converts it into an xml.
+       * This method takes an array and converts it to XML.
        * There are several noteworthy cases:
        *
        *  If array contains a key '_element', then the code assumes that ALL other keys are not important and replaces them with the value['_element'].
@@ -76,12 +80,14 @@ class ApiFormatXml extends ApiFormatBase {
                } else {
                        $indstr = '';
                }
+               $elemName = str_replace(' ', '_', $elemName);
 
                switch (gettype($elemValue)) {
                        case 'array' :
-
                                if (isset ($elemValue['*'])) {
                                        $subElemContent = $elemValue['*'];
+                                       if ($this->mDoubleQuote)
+                                               $subElemContent = $this->doubleQuote($subElemContent);
                                        unset ($elemValue['*']);
                                } else {
                                        $subElemContent = null;
@@ -97,9 +103,18 @@ class ApiFormatXml extends ApiFormatBase {
                                $indElements = array ();
                                $subElements = array ();
                                foreach ($elemValue as $subElemId => & $subElemValue) {
+                                       if (is_string($subElemValue) && $this->mDoubleQuote)
+                                               $subElemValue = $this->doubleQuote($subElemValue);
+                                       
+                                       // Replace spaces with underscores
+                                       $newSubElemId = str_replace(' ', '_', $subElemId);
+                                       if($newSubElemId != $subElemId) {
+                                               $elemValue[$newSubElemId] = $subElemValue;
+                                               unset($elemValue[$subElemId]);
+                                               $subElemId = $newSubElemId;
+                                       }
+
                                        if (gettype($subElemId) === 'integer') {
-                                               if (!is_array($subElemValue))
-                                                       ApiBase :: dieDebug(__METHOD__, "($elemName, ...) has a scalar indexed value.");
                                                $indElements[] = $subElemValue;
                                                unset ($elemValue[$subElemId]);
                                        } elseif (is_array($subElemValue)) {
@@ -108,18 +123,18 @@ class ApiFormatXml extends ApiFormatBase {
                                        }
                                }
 
-                               if (is_null($subElemIndName) && !empty ($indElements))
-                                       ApiBase :: dieDebug(__METHOD__, "($elemName, ...) has integer keys without _element value");
+                               if (is_null($subElemIndName) && count($indElements))
+                                       ApiBase :: dieDebug(__METHOD__, "($elemName, ...) has integer keys without _element value. Use ApiResult::setIndexedTagName().");
 
-                               if (!empty ($subElements) && !empty ($indElements) && !is_null($subElemContent))
+                               if (count($subElements) && count($indElements) && !is_null($subElemContent))
                                        ApiBase :: dieDebug(__METHOD__, "($elemName, ...) has content and subelements");
 
                                if (!is_null($subElemContent)) {
-                                       $this->printText($indstr . wfElement($elemName, $elemValue, $subElemContent));
-                               } elseif (empty ($indElements) && empty ($subElements)) {
-                                               $this->printText($indstr . wfElement($elemName, $elemValue));
+                                       $this->printText($indstr . Xml::element($elemName, $elemValue, $subElemContent));
+                               } elseif (!count($indElements) && !count($subElements)) {
+                                               $this->printText($indstr . Xml::element($elemName, $elemValue));
                                } else {
-                                       $this->printText($indstr . wfElement($elemName, $elemValue, null));
+                                       $this->printText($indstr . Xml::element($elemName, $elemValue, null));
 
                                        foreach ($subElements as $subElemId => & $subElemValue)
                                                $this->recXmlPrint($subElemId, $subElemValue, $indent);
@@ -127,35 +142,39 @@ class ApiFormatXml extends ApiFormatBase {
                                        foreach ($indElements as $subElemId => & $subElemValue)
                                                $this->recXmlPrint($subElemIndName, $subElemValue, $indent);
 
-                                       $this->printText($indstr . wfCloseElement($elemName));
+                                       $this->printText($indstr . Xml::closeElement($elemName));
                                }
                                break;
                        case 'object' :
                                // ignore
                                break;
                        default :
-                               $this->printText($indstr . wfElement($elemName, null, $elemValue));
+                               $this->printText($indstr . Xml::element($elemName, null, $elemValue));
                                break;
                }
        }
-       protected function getDescription() {
-               return 'Output data in XML format';
+       private function doubleQuote( $text ) {
+               return Sanitizer::encodeAttribute( $text );
        }
 
-       protected function getAllowedParams() {
+       public function getAllowedParams() {
                return array (
-                       'xmlindent' => false
+                       'xmldoublequote' => false
                );
        }
 
-       protected function getParamDescription() {
+       public function getParamDescription() {
                return array (
-                       'xmlindent' => 'Enable XML indentation'
+                       'xmldoublequote' => 'If specified, double quotes all attributes and content.',
                );
        }
 
+
+       public function getDescription() {
+               return 'Output data in XML format' . parent :: getDescription();
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
 }
-?>
\ No newline at end of file