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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
<?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
*/
/**
* A DataTable is composed of rows.
*
* A row is composed of:
* - columns often at least a 'label' column containing the description
* of the row, and some numeric values ('nb_visits', etc.)
* - details: other information never to be shown as 'columns'
* - idSubtable: a row can be linked to a SubTable
*
* IMPORTANT: Make sure that the column named 'label' contains at least one non-numeric character.
* Otherwise the method addDataTable() or sumRow() would fail because they would consider
* the 'label' as being a numeric column to sum.
*
* @package Piwik_DataTable
* @subpackage Piwik_DataTable_Row
*
*/
class Piwik_DataTable_Row
{
/**
* This array contains the row information:
* - array indexed by self::COLUMNS contains the columns, pairs of (column names, value)
* - (optional) array indexed by self::DETAILS contains the details, pairs of (detail names, value)
* - (optional) integer indexed by self::DATATABLE_ASSOCIATED contains the ID of the Piwik_DataTable associated to this row.
* This ID can be used to read the DataTable from the DataTable_Manager.
*
* @var array
* @see constructor for more information
*/
public $c = array();
const COLUMNS = 0;
const DETAILS = 1;
const DATATABLE_ASSOCIATED = 3;
/**
* Efficient load of the Row structure from a well structured php array
*
* @param array The row array has the structure
* array(
* Piwik_DataTable_Row::COLUMNS => array(
* 'label' => 'Piwik',
* 'column1' => 42,
* 'visits' => 657,
* 'time_spent' => 155744,
* ),
* Piwik_DataTable_Row::DETAILS => array(
* 'logo' => 'test.png'
* ),
* Piwik_DataTable_Row::DATATABLE_ASSOCIATED => #Piwik_DataTable object (but in the row only the ID will be stored)
* )
*/
public function __construct( $row = array() )
{
$this->c[self::COLUMNS] = array();
$this->c[self::DETAILS] = array();
$this->c[self::DATATABLE_ASSOCIATED] = null;
if(isset($row[self::COLUMNS]))
{
$this->c[self::COLUMNS] = $row[self::COLUMNS];
}
if(isset($row[self::DETAILS]))
{
$this->c[self::DETAILS] = $row[self::DETAILS];
}
if(isset($row[self::DATATABLE_ASSOCIATED])
&& $row[self::DATATABLE_ASSOCIATED] instanceof Piwik_DataTable)
{
$this->c[self::DATATABLE_ASSOCIATED] = $row[self::DATATABLE_ASSOCIATED]->getId();
}
}
/**
* When destroyed, a row destroys its associated subTable if there is one
*/
public function __destruct()
{
$idSubtable = $this->c[self::DATATABLE_ASSOCIATED];
if($idSubtable !== null)
{
unset($idSubtable);
}
}
/**
* Applys a basic rendering to the Row and returns the output
*
* @return string characterizing the row. Example: - 1 ['label' => 'piwik', 'nb_uniq_visitors' => 1685, 'nb_visits' => 1861, 'nb_actions' => 2271, 'max_actions' => 13, 'sum_visit_length' => 920131, 'bounce_count' => 1599] [] [idsubtable = 1375]
*/
public function __toString()
{
$columns = array();
foreach($this->getColumns() as $column => $value)
{
if(is_string($value)) $value = "'$value'";
$columns[] = "'$column' => $value";
}
$columns = implode(", ", $columns);
$details=array();
foreach($this->getDetails() as $detail => $value)
{
if(is_string($value)) $value = "'$value'";
$details[] = "'$detail' => $value";
}
$details = implode(", ", $details);
$output = "# [".$columns."] [".$details."] [idsubtable = "
. $this->getIdSubDataTable()."]<br>\n";
return $output;
}
/**
* Deletes the given column
*
* @param string Column name
* @return bool True on success, false if the column didn't exist
*/
public function deleteColumn( $name )
{
if(!isset($this->c[self::COLUMNS][$name]))
{
return false;
}
unset($this->c[self::COLUMNS][$name]);
return true;
}
/**
* Returns the given column
*
* @param string Column name
* @return mixed|false The column value
*/
public function getColumn( $name )
{
if(!isset($this->c[self::COLUMNS][$name]))
{
return false;
}
return $this->c[self::COLUMNS][$name];
}
/**
* Returns the given detail
*
* @param string Detail name
* @return mixed|false The detail value
*/
public function getDetail( $name )
{
if(!isset($this->c[self::DETAILS][$name]))
{
return false;
}
return $this->c[self::DETAILS][$name];
}
/**
* Returns the array containing all the columns
*
* @return array Example: array(
* 'column1' => VALUE,
* 'label' => 'www.php.net'
* 'nb_visits' => 15894,
* )
*/
public function getColumns()
{
return $this->c[self::COLUMNS];
}
/**
* Returns the array containing all the details
*
* @return array Example: array(
* 'logo' => 'images/logo/www.google.png',
* 'url' => 'www.google.com'
* )
*/
public function getDetails()
{
return $this->c[self::DETAILS];
}
/**
* Returns the ID of the subDataTable.
* If there is no such a table, returns null.
*
* @return int|null
*/
public function getIdSubDataTable()
{
return $this->c[self::DATATABLE_ASSOCIATED];
}
/**
* Sums a DataTable to this row subDataTable.
* If this row doesn't have a SubDataTable yet, we create a new one.
* Then we add the values of the given DataTable to this row's DataTable.
*
* @param Piwik_DataTable Table to sum to this row's subDatatable
* @see Piwik_DataTable::addDataTable() for the algorithm used for the sum
*/
public function sumSubtable(Piwik_DataTable $subTable)
{
$thisSubtableID = $this->getIdSubDataTable();
if($thisSubtableID === null)
{
$thisSubTable = new Piwik_DataTable;
$this->addSubtable($thisSubTable);
}
else
{
$thisSubTable = Piwik_DataTable_Manager::getInstance()->getTable( $thisSubtableID );
}
$thisSubTable->addDataTable($subTable);
}
/**
* Set a DataTable to be associated to this row.
* If the row already has a DataTable associated to it, throws an Exception.
*
* @param Piwik_DataTable DataTable to associate to this row
* @throws Exception
*
*/
public function addSubtable(Piwik_DataTable $subTable)
{
if(!is_null($this->c[self::DATATABLE_ASSOCIATED]))
{
throw new Exception("Adding a subtable to the row, but it already has a subtable associated.");
}
$this->c[self::DATATABLE_ASSOCIATED] = $subTable->getId();
}
/**
* Set a DataTable to this row. If there is already
* a DataTable associated, it is simply overwritten.
*
* @param Piwik_DataTable DataTable to associate to this row
*/
public function setSubtable(Piwik_DataTable $subTable)
{
$this->c[self::DATATABLE_ASSOCIATED] = $subTable->getId();
}
/**
* Set all the columns at once. Overwrites previously set columns.
*
* @param array array(
* 'label' => 'www.php.net'
* 'nb_visits' => 15894,
* )
*/
public function setColumns( $columns )
{
$this->c[self::COLUMNS] = $columns;
}
/**
* Set the value $value to the column called $name.
*
* @param string $name of the column to set
* @param mixed $value of the column to set
*/
public function setColumn($name, $value)
{
if(isset($this->c[self::COLUMNS][$name])
|| $name != 'label')
{
$this->c[self::COLUMNS][$name] = $value;
}
// we make sure when adding the label it goes first in the table
else
{
$this->c[self::COLUMNS] = array($name => $value) + $this->c[self::COLUMNS];
}
}
/**
* Add a new column to the row. If the column already exists, throws an exception
*
* @param string $name of the column to add
* @param mixed $value of the column to set
* @throws Exception
*/
public function addColumn($name, $value)
{
if(isset($this->c[self::COLUMNS][$name]))
{
throw new Exception("Column $name already in the array!");
}
$this->c[self::COLUMNS][$name] = $value;
}
/**
* Add a new detail to the row. If the column already exists, throws an exception.
*
* @param string $name of the detail to add
* @param mixed $value of the detail to set
* @throws Exception
*/
public function addDetail($name, $value)
{
if(isset($this->c[self::DETAILS][$name]))
{
throw new Exception("Detail $name already in the array!");
}
$this->c[self::DETAILS][$name] = $value;
}
/**
* Sums the given $row columns values to the existing row' columns values.
* It will sum only the int or float values of $row.
* It will not sum the column 'label' even if it has a numeric value.
*
* If a given column doesn't exist in $this then it is added with the value of $row.
* If the column already exists in $this then we have
* this.columns[idThisCol] += $row.columns[idThisCol]
*/
public function sumRow( Piwik_DataTable_Row $rowToSum )
{
foreach($rowToSum->getColumns() as $name => $value)
{
if($name != 'label'
&& Piwik::isNumeric($value))
{
$current = $this->getColumn($name);
if($current === false)
{
$current = 0;
}
$this->setColumn( $name, $current + $value);
}
}
}
/**
* Helper function to test if two rows are equal.
*
* Two rows are equal
* - if they have exactly the same columns / details
* - if they have a subDataTable associated, then we check that both of them are the same.
*
* @param Piwik_DataTable_Row row1 to compare
* @param Piwik_DataTable_Row row2 to compare
*
* @return bool
*/
static public function isEqual( Piwik_DataTable_Row $row1, Piwik_DataTable_Row $row2 )
{
//same columns
$cols1 = $row1->getColumns();
$cols2 = $row2->getColumns();
uksort($cols1, 'strnatcasecmp');
uksort($cols2, 'strnatcasecmp');
if($cols1 != $cols2)
{
return false;
}
$dets1 = $row1->getDetails();
$dets2 = $row2->getDetails();
ksort($dets1);
ksort($dets2);
// same details
if($dets1 != $dets2)
{
return false;
}
// either both are null
// or both have a value
if( !(is_null($row1->getIdSubDataTable())
&& is_null($row2->getIdSubDataTable())
)
)
{
$subtable1 = Piwik_DataTable_Manager::getInstance()->getTable($row1->getIdSubDataTable());
$subtable2 = Piwik_DataTable_Manager::getInstance()->getTable($row2->getIdSubDataTable());
if(!Piwik_DataTable::isEqual($subtable1, $subtable2))
{
return false;
}
}
return true;
}
}
require_once "Row/DataTableSummary.php";
|