5 * Created on Oct 22, 2006
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * API WDDX output formatter
31 class ApiFormatWddx
extends ApiFormatBase
{
33 public function getMimeType() {
37 public function execute() {
38 // Some versions of PHP have a broken wddx_serialize_value, see
39 // PHP bug 45314. Test encoding an affected character (U+00A0)
41 $expected = "<wddxPacket version='1.0'><header/><data><string>\xc2\xa0</string></data></wddxPacket>";
42 if ( function_exists( 'wddx_serialize_value' )
43 && !$this->getIsHtml()
44 && wddx_serialize_value( "\xc2\xa0" ) == $expected ) {
45 $this->printText( wddx_serialize_value( $this->getResultData() ) );
47 // Don't do newlines and indentation if we weren't asked
49 $nl = ( $this->getIsHtml() ?
'' : "\n" );
51 $this->printText( "<?xml version=\"1.0\"?>$nl" );
52 $this->printText( "<wddxPacket version=\"1.0\">$nl" );
53 $this->printText( "$indstr<header/>$nl" );
54 $this->printText( "$indstr<data>$nl" );
55 $this->slowWddxPrinter( $this->getResultData(), 4 );
56 $this->printText( "$indstr</data>$nl" );
57 $this->printText( "</wddxPacket>$nl" );
62 * Recursively go through the object and output its data in WDDX format.
66 function slowWddxPrinter( $elemValue, $indent = 0 ) {
67 $indstr = ( $this->getIsHtml() ?
'' : str_repeat( ' ', $indent ) );
68 $indstr2 = ( $this->getIsHtml() ?
'' : str_repeat( ' ', $indent +
2 ) );
69 $nl = ( $this->getIsHtml() ?
'' : "\n" );
70 switch ( gettype( $elemValue ) ) {
72 // Check whether we've got an associative array (<struct>)
73 // or a regular array (<array>)
74 $cnt = count( $elemValue );
75 if ( $cnt == 0 ||
array_keys( $elemValue ) === range( 0, $cnt - 1 ) ) {
77 $this->printText( $indstr . Xml
::element( 'array', array(
78 'length' => $cnt ), null ) . $nl );
79 foreach ( $elemValue as $subElemValue ) {
80 $this->slowWddxPrinter( $subElemValue, $indent +
2 );
82 $this->printText( "$indstr</array>$nl" );
84 // Associative array (<struct>)
85 $this->printText( "$indstr<struct>$nl" );
86 foreach ( $elemValue as $subElemName => $subElemValue ) {
87 $this->printText( $indstr2 . Xml
::element( 'var', array(
88 'name' => $subElemName
90 $this->slowWddxPrinter( $subElemValue, $indent +
4 );
91 $this->printText( "$indstr2</var>$nl" );
93 $this->printText( "$indstr</struct>$nl" );
98 $this->printText( $indstr . Xml
::element( 'number', null, $elemValue ) . $nl );
101 $this->printText( $indstr . Xml
::element( 'string', null, $elemValue ) . $nl );
104 ApiBase
::dieDebug( __METHOD__
, 'Unknown type ' . gettype( $elemValue ) );
108 public function getDescription() {
109 return 'Output data in WDDX format' . parent
::getDescription();