Merge "Api method documentation tweaks"
[lhc/web/wiklou.git] / includes / api / ApiFormatWddx.php
index a075626..1bc9d02 100644 (file)
@@ -1,12 +1,10 @@
 <?php
-
-
-/*
- * Created on Oct 22, 2006
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Created on Oct 22, 2006
+ *
+ * Copyright © 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
  *
  * 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 ('ApiFormatBase.php');
-}
-
+/**
+ * API WDDX output formatter
+ * @ingroup API
+ */
 class ApiFormatWddx extends ApiFormatBase {
 
-       public function __construct($main, $format) {
-               parent :: __construct($main, $format);
+       public function __construct( $main, $format ) {
+               parent::__construct( $main, $format );
        }
 
        public function getMimeType() {
@@ -40,50 +39,81 @@ class ApiFormatWddx extends ApiFormatBase {
        }
 
        public function execute() {
-               if (function_exists('wddx_serialize_value')) {
-                       $this->printText(wddx_serialize_value($this->getResultData()));
+               // Some versions of PHP have a broken wddx_serialize_value, see
+               // PHP bug 45314. Test encoding an affected character (U+00A0)
+               // to avoid this.
+               $expected = "<wddxPacket version='1.0'><header/><data><string>\xc2\xa0</string></data></wddxPacket>";
+               if ( function_exists( 'wddx_serialize_value' )
+                               && !$this->getIsHtml()
+                               && wddx_serialize_value( "\xc2\xa0" ) == $expected ) {
+                       $this->printText( wddx_serialize_value( $this->getResultData() ) );
                } else {
-                       $this->printText('<?xml version="1.0" encoding="utf-8"?>');
-                       $this->printText('<wddxPacket version="1.0"><header/><data>');
-                       $this->slowWddxPrinter($this->getResultData());
-                       $this->printText('</data></wddxPacket>');
+                       // Don't do newlines and indentation if we weren't asked
+                       // for pretty output
+                       $nl = ( $this->getIsHtml() ? '' : "\n" );
+                       $indstr = ' ';
+                       $this->printText( "<?xml version=\"1.0\"?>$nl" );
+                       $this->printText( "<wddxPacket version=\"1.0\">$nl" );
+                       $this->printText( "$indstr<header/>$nl" );
+                       $this->printText( "$indstr<data>$nl" );
+                       $this->slowWddxPrinter( $this->getResultData(), 4 );
+                       $this->printText( "$indstr</data>$nl" );
+                       $this->printText( "</wddxPacket>$nl" );
                }
        }
 
        /**
-       * Recursivelly go through the object and output its data in WDDX format.
-       */
-       function slowWddxPrinter($elemValue) {
-               switch (gettype($elemValue)) {
-                       case 'array' :
-                               $this->printText('<struct>');
-                               foreach ($elemValue as $subElemName => $subElemValue) {
-                                       $this->printText(wfElement('var', array (
-                                               'name' => $subElemName
-                                       ), null));
-                                       $this->slowWddxPrinter($subElemValue);
-                                       $this->printText('</var>');
+        * Recursively go through the object and output its data in WDDX format.
+        * @param $elemValue
+        * @param $indent int
+        */
+       function slowWddxPrinter( $elemValue, $indent = 0 ) {
+               $indstr = ( $this->getIsHtml() ? '' : str_repeat( ' ', $indent ) );
+               $indstr2 = ( $this->getIsHtml() ? '' : str_repeat( ' ', $indent + 2 ) );
+               $nl = ( $this->getIsHtml() ? '' : "\n" );
+               switch ( gettype( $elemValue ) ) {
+                       case 'array':
+                               // Check whether we've got an associative array (<struct>)
+                               // or a regular array (<array>)
+                               $cnt = count( $elemValue );
+                               if ( $cnt == 0 || array_keys( $elemValue ) === range( 0, $cnt - 1 ) ) {
+                                       // Regular array
+                                       $this->printText( $indstr . Xml::element( 'array', array(
+                                               'length' => $cnt ), null ) . $nl );
+                                       foreach ( $elemValue as $subElemValue ) {
+                                               $this->slowWddxPrinter( $subElemValue, $indent + 2 );
+                                       }
+                                       $this->printText( "$indstr</array>$nl" );
+                               } else {
+                                       // Associative array (<struct>)
+                                       $this->printText( "$indstr<struct>$nl" );
+                                       foreach ( $elemValue as $subElemName => $subElemValue ) {
+                                               $this->printText( $indstr2 . Xml::element( 'var', array(
+                                                       'name' => $subElemName
+                                               ), null ) . $nl );
+                                               $this->slowWddxPrinter( $subElemValue, $indent + 4 );
+                                               $this->printText( "$indstr2</var>$nl" );
+                                       }
+                                       $this->printText( "$indstr</struct>$nl" );
                                }
-                               $this->printText('</struct>');
                                break;
-                       case 'integer' :
-                       case 'double' :
-                               $this->printText(wfElement('number', null, $elemValue));
+                       case 'integer':
+                       case 'double':
+                               $this->printText( $indstr . Xml::element( 'number', null, $elemValue ) . $nl );
                                break;
-                       case 'string' :
-                               $this->printText(wfElement('string', null, $elemValue));
+                       case 'string':
+                               $this->printText( $indstr . Xml::element( 'string', null, $elemValue ) . $nl );
                                break;
-                       default :
-                               ApiBase :: dieDebug(__METHOD__, 'Unknown type ' . gettype($elemValue));
+                       default:
+                               ApiBase::dieDebug( __METHOD__, 'Unknown type ' . gettype( $elemValue ) );
                }
        }
 
-       protected function getDescription() {
-               return 'Output data in WDDX format';
+       public function getDescription() {
+               return 'Output data in WDDX format' . parent::getDescription();
        }
 
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
 }
-?>
\ No newline at end of file