1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id: Xml.php 558 2008-07-20 23:10:38Z matt $
*
* @package Piwik_DataTable
*/
require_once "DataTable/Renderer/Php.php";
/**
* XML export of a given DataTable.
* See the tests cases for more information about the XML format (/tests/core/DataTable/Renderer.test.php)
* Or have a look at the API calls examples.
*
* Works with recursive DataTable (when a row can be associated with a subDataTable).
*
* @package Piwik_DataTable
* @subpackage Piwik_DataTable_Renderer
*/
class Piwik_DataTable_Renderer_Xml extends Piwik_DataTable_Renderer
{
function __construct($table = null, $renderSubTables = null)
{
parent::__construct($table, $renderSubTables);
}
function render()
{
// var_dump($this->table);exit;
return $this->renderTable($this->table);
}
protected function getArrayFromDataTable($table)
{
$renderer = new Piwik_DataTable_Renderer_Php($table, $this->renderSubTables, $serialize = false);
return $renderer->flatRender();
}
protected function renderTable($table, $returnOnlyDataTableXml = false, $prefixLines = '')
{
$array = $this->getArrayFromDataTable($table);
// var_dump($array);exit;
if($table instanceof Piwik_DataTable_Array)
{
$out = $this->renderDataTableArray($table, $array, $prefixLines);
if($returnOnlyDataTableXml)
{
return $out;
}
$out = "<results>\n$out</results>";
return $this->output($out);
}
// integer value of ZERO is a value we want to display
if($array != 0 && empty($array))
{
if($returnOnlyDataTableXml)
{
throw new Exception("Illegal state, what xml shall we return?");
}
$out = "<result />";
return $this->output($out);
}
if($table instanceof Piwik_DataTable_Simple)
{
if(is_array($array))
{
$out = $this->renderDataTableSimple($array);
}
else
{
$out = $array;
}
if($returnOnlyDataTableXml)
{
return $out;
}
if(is_array($array))
{
$out = "<result>\n".$out."</result>";
}
else
{
$out = "<result>".$out."</result>";
}
return $this->output($out);
}
if($table instanceof Piwik_DataTable)
{
$out = $this->renderDataTable($array);
if($returnOnlyDataTableXml)
{
return $out;
}
$out = "<result>\n$out</result>";
return $this->output($out);
}
}
protected function renderDataTableArray($table, $array, $prefixLines = "")
{
// CASE 1
//array
// 'day1' => string '14' (length=2)
// 'day2' => string '6' (length=1)
$firstTable = current($array);
if(!is_array( $firstTable ))
{
$xml = '';
$nameDescriptionAttribute = $table->getKeyName();
foreach($array as $valueAttribute => $value)
{
if(empty($value))
{
$xml .= $prefixLines . "\t<result $nameDescriptionAttribute=\"$valueAttribute\" />\n";
}
elseif($value instanceof Piwik_DataTable_Array )
{
$out = $this->renderTable($value, true);
//TODO somehow this code is not tested, cover this case
$xml .= "\t<result $nameDescriptionAttribute=\"$valueAttribute\">\n$out</result>\n";
}
else
{
$xml .= $prefixLines . "\t<result $nameDescriptionAttribute=\"$valueAttribute\">$value</result>\n";
}
}
return $xml;
}
$subTables = $table->getArray();
$firstTable = current($subTables);
// CASE 2
//array
// 'day1' =>
// array
// 'nb_uniq_visitors' => string '18'
// 'nb_visits' => string '101'
// 'day2' =>
// array
// 'nb_uniq_visitors' => string '28'
// 'nb_visits' => string '11'
if( $firstTable instanceof Piwik_DataTable_Simple)
{
$xml = '';
$nameDescriptionAttribute = $table->getKeyName();
foreach($array as $valueAttribute => $dataTableSimple)
{
if(count($dataTableSimple) == 0)
{
$xml .= $prefixLines . "\t<result $nameDescriptionAttribute=\"$valueAttribute\" />\n";
}
else
{
if(is_array($dataTableSimple))
{
$dataTableSimple = "\n" . $this->renderDataTableSimple($dataTableSimple, $prefixLines . "\t") . "\t" ;
}
$xml .= $prefixLines . "\t<result $nameDescriptionAttribute=\"$valueAttribute\">".$dataTableSimple. $prefixLines . "</result>\n";
}
}
return $xml;
}
// CASE 3
//array
// 'day1' =>
// array
// 0 =>
// array
// 'label' => string 'phpmyvisites'
// 'nb_uniq_visitors' => int 11
// 'nb_visits' => int 13
// 1 =>
// array
// 'label' => string 'phpmyvisits'
// 'nb_uniq_visitors' => int 2
// 'nb_visits' => int 2
// 'day2' =>
// array
// 0 =>
// array
// 'label' => string 'piwik'
// 'nb_uniq_visitors' => int 121
// 'nb_visits' => int 130
// 1 =>
// array
// 'label' => string 'piwik bis'
// 'nb_uniq_visitors' => int 20
// 'nb_visits' => int 120
if($firstTable instanceof Piwik_DataTable)
{
$xml = '';
$nameDescriptionAttribute = $table->getKeyName();
foreach($array as $keyName => $arrayForSingleDate)
{
$dataTableOut = $this->renderDataTable( $arrayForSingleDate, $prefixLines . "\t" );
if(empty($dataTableOut))
{
$xml .= $prefixLines . "\t<result $nameDescriptionAttribute=\"$keyName\" />\n";
}
else
{
$xml .= $prefixLines . "\t<result $nameDescriptionAttribute=\"$keyName\">\n";
$xml .= $dataTableOut;
$xml .= $prefixLines . "\t</result>\n";
}
}
return $xml;
}
if($firstTable instanceof Piwik_DataTable_Array)
{
$xml = '';
$tables = $table->getArray();
$nameDescriptionAttribute = $table->getKeyName();
foreach( $tables as $valueAttribute => $tableInArray)
{
$out = $this->renderTable($tableInArray, true, $prefixLines . "\t");
$xml .= $prefixLines . "\t<result $nameDescriptionAttribute=\"$valueAttribute\">\n".$out.$prefixLines."\t</result>\n";
}
return $xml;
}
}
protected function renderDataTable( $array, $prefixLine = "" )
{
$out = '';
foreach($array as $rowId => $row)
{
if(!is_array($row))
{
$value = $this->formatValue($row);
$out .= $prefixLine."\t\t<$rowId>".$value."</$rowId>\n";
continue;
}
$rowAttribute = '';
if(($equalFound = strstr($rowId, '=')) !== false)
{
$rowAttribute = explode('=', $rowId);
$rowAttribute = " " . $rowAttribute[0] . "='" . $rowAttribute[1] . "'";
}
$out .= $prefixLine."\t<row$rowAttribute>";
if(count($row) === 1
&& key($row) === 0)
{
$value = current($row);
$out .= $prefixLine . $value;
}
else
{
$out .= "\n";
foreach($row as $name => $value)
{
// handle the recursive dataTable case by XML outputting the recursive table
if(is_array($value))
{
$value = "\n".$this->renderDataTable($value, $prefixLine."\t\t");
$value .= $prefixLine."\t\t";
}
else
{
$value = $this->formatValue($value);
}
$out .= $prefixLine."\t\t<$name>".$value."</$name>\n";
}
$out .= "\t";
}
$out .= $prefixLine."</row>\n";
}
return $out;
}
protected function renderDataTableSimple( $array, $prefixLine = "")
{
$out = '';
foreach($array as $keyName => $value)
{
$out .= $prefixLine."\t<$keyName>".$this->formatValue($value)."</$keyName>\n";
}
return $out;
}
protected function formatValue($value)
{
if(is_string($value)
&& !is_numeric($value))
{
$value = html_entity_decode($value, ENT_COMPAT, 'UTF-8');
$value = htmlspecialchars($value);
}
return $value;
}
protected function output( $xml )
{
// silent fail because otherwise it throws an exception in the unit tests
@header("Content-Type: text/xml;charset=utf-8");
$xml = '<?xml version="1.0" encoding="utf-8" ?>' . "\n" . $xml;
return $xml;
}
}
|