blob: 0e00028904ec0daadcc35ac5b0689d0db6334d47 (
plain)
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
|
<?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$
*
* @package Piwik_DataTable
*/
require_once "DataTable/Renderer/Php.php";
/**
* CSV export
*
* When rendered using the default settings, a CSV report has the following characteristics:
* The first record contains headers for all the columns in the report.
* All rows have the same number of columns.
* The default field delimiter string is a comma (,).
* Formatting and layout are ignored.
*
* Note that CSV output doesn't handle recursive dataTable. It will output only the first parent level of the tables.
*
* @package Piwik_DataTable
* @subpackage Piwik_DataTable_Renderer
*
*/
class Piwik_DataTable_Renderer_Csv extends Piwik_DataTable_Renderer
{
/**
* Column separator
*
* @var string
*/
public $separator = ',';
/**
* Line end
*
* @var string
*/
public $lineEnd = "\n";
/**
* 'details' columns will be exported, prefixed by 'detail_'
*
* @var bool
*/
public $exportDetail = true;
/**
* idSubtable will be exported in a column called 'idsubdatatable'
*
* @var bool
*/
public $exportIdSubtable = true;
function __construct($table = null)
{
parent::__construct($table);
}
function render()
{
return $this->renderTable($this->table);
}
protected function renderTable($table)
{
if($table instanceof Piwik_DataTable_Array)
{
$str = $header = '';
$prefixColumns = $table->getNameKey() . $this->separator;
foreach($table->getArray() as $currentLinePrefix => $dataTable)
{
$returned = explode("\n",$this->renderTable($dataTable));
// get the columns names
if(empty($header))
{
$header = $returned[0];
}
$returned = array_slice($returned,1);
// case empty datatable we dont print anything in the CSV export
// when in xml we would output <result date="2008-01-15" />
if(!empty($returned))
{
foreach($returned as &$row)
{
$row = $currentLinePrefix . $this->separator . $row;
}
$str .= "\n" . implode("\n", $returned);
}
}
// var_dump($header);exit;
if(!empty($header))
{
$str = $prefixColumns . $header . $str;
}
}
else
{
$str = $this->renderDataTable($table);
}
return $this->output($str);
}
protected function renderDataTable( $table )
{
if($table instanceof Piwik_DataTable_Simple
&& $table->getRowsCount() ==1)
{
$str = 'value' . $this->lineEnd . $table->getRowFromId(0)->getColumn('value');
return $str;
}
$csv = array();
// keep track of all the existing columns in the csv file
$allColumns = array();
foreach($table->getRows() as $row)
{
$csvRow = array();
// COLUMNS
$columns = $row->getColumns();
foreach($columns as $name => $value)
{
if(!isset($allColumns[$name]))
{
$allColumns[$name] = true;
}
$csvRow[$name] = $value;
}
if($this->exportDetail)
{
// DETAILS
$details = $row->getDetails();
foreach($details as $name => $value)
{
//if a detail and a column have the same name make sure they dont overwrite
$name = 'detail_'.$name;
$allColumns[$name] = true;
$csvRow[$name] = $value;
}
}
if($this->exportIdSubtable)
{
// ID SUB DATATABLE
$idsubdatatable = $row->getIdSubDataTable();
if($idsubdatatable !== false)
{
$csvRow['idsubdatatable'] = $idsubdatatable;
}
}
$csv[] = $csvRow;
}
// now we make sure that all the rows in the CSV array have all the columns
foreach($csv as &$row)
{
foreach($allColumns as $columnName => $true)
{
if(!isset($row[$columnName]))
{
$row[$columnName] = '';
}
}
}
// var_dump($csv);exit;
$str = '';
// specific case, we have only one column and this column wasn't named properly (indexed by a number)
// we don't print anything in the CSV file => an empty line
if(sizeof($allColumns) == 1
&& reset($allColumns)
&& !is_string(key($allColumns)))
{
$str .= '';
}
else
{
$keys = array_keys($allColumns);
$str .= implode($this->separator, $keys);
}
// we render the CSV
foreach($csv as $theRow)
{
$rowStr = '';
foreach($allColumns as $columnName => $true)
{
$rowStr .= $theRow[$columnName] . $this->separator;
}
// remove the last separator
$rowStr = substr_replace($rowStr,"",-strlen($this->separator));
$str .= $this->lineEnd . $rowStr;
}
return $str;
}
protected function output( $str )
{
if(empty($str))
{
return 'No data available';
}
// silent fail otherwise unit tests fail
@header("Content-type: application/vnd.ms-excel");
@header("Content-Disposition: attachment; filename=piwik-report-export.csv");
return $str;
}
}
|
