4 * Created on Oct 22, 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 ApiFormatWddx
extends ApiFormatBase
{
36 public function __construct( $main, $format ) {
37 parent
:: __construct( $main, $format );
40 public function getMimeType() {
44 public function execute() {
45 // Some versions of PHP have a broken wddx_serialize_value, see
46 // PHP bug 45314. Test encoding an affected character (U+00A0)
48 $expected = "<wddxPacket version='1.0'><header/><data><string>\xc2\xa0</string></data></wddxPacket>";
49 if ( function_exists( 'wddx_serialize_value' )
50 && !$this->getIsHtml()
51 && wddx_serialize_value( "\xc2\xa0" ) == $expected ) {
52 $this->printText( wddx_serialize_value( $this->getResultData() ) );
54 // Don't do newlines and indentation if we weren't asked
56 $nl = ( $this->getIsHtml() ?
"" : "\n" );
58 $this->printText( "<?xml version=\"1.0\"?>$nl" );
59 $this->printText( "<wddxPacket version=\"1.0\">$nl" );
60 $this->printText( "$indstr<header/>$nl" );
61 $this->printText( "$indstr<data>$nl" );
62 $this->slowWddxPrinter( $this->getResultData(), 4 );
63 $this->printText( "$indstr</data>$nl" );
64 $this->printText( "</wddxPacket>$nl" );
69 * Recursively go through the object and output its data in WDDX format.
71 function slowWddxPrinter( $elemValue, $indent = 0 ) {
72 $indstr = ( $this->getIsHtml() ?
"" : str_repeat( ' ', $indent ) );
73 $indstr2 = ( $this->getIsHtml() ?
"" : str_repeat( ' ', $indent +
2 ) );
74 $nl = ( $this->getIsHtml() ?
"" : "\n" );
75 switch ( gettype( $elemValue ) ) {
77 // Check whether we've got an associative array (<struct>)
78 // or a regular array (<array>)
79 $cnt = count( $elemValue );
80 if ( $cnt == 0 ||
array_keys( $elemValue ) === range( 0, $cnt - 1 ) ) {
82 $this->printText( $indstr . Xml
::element( 'array', array(
83 'length' => $cnt ), null ) . $nl );
84 foreach ( $elemValue as $subElemValue )
85 $this->slowWddxPrinter( $subElemValue, $indent +
2 );
86 $this->printText( "$indstr</array>$nl" );
88 // Associative array (<struct>)
89 $this->printText( "$indstr<struct>$nl" );
90 foreach ( $elemValue as $subElemName => $subElemValue ) {
91 $this->printText( $indstr2 . Xml
::element( 'var', array(
92 'name' => $subElemName
94 $this->slowWddxPrinter( $subElemValue, $indent +
4 );
95 $this->printText( "$indstr2</var>$nl" );
97 $this->printText( "$indstr</struct>$nl" );
102 $this->printText( $indstr . Xml
::element( 'number', null, $elemValue ) . $nl );
105 $this->printText( $indstr . Xml
::element( 'string', null, $elemValue ) . $nl );
108 ApiBase
:: dieDebug( __METHOD__
, 'Unknown type ' . gettype( $elemValue ) );
112 public function getDescription() {
113 return 'Output data in WDDX format' . parent
:: getDescription();
116 public function getVersion() {
117 return __CLASS__
. ': $Id$';