blob: 61ff4da6d8c608946e301846ae3f644ab9909434 (
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
|
<?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: Simple.php 168 2008-01-14 05:26:43Z matt $
*
* @package Piwik_DataTable
*/
/**
* The DataTable_Array is a way to store an array of dataTable.
* The Piwik_DataTable_Array implements some of the features of the Piwik_DataTable such as queueFilter, getRowsCount.
*
* @package Piwik_DataTable
*/
class Piwik_DataTable_Array
{
/**
* Used to store additional information about the DataTable Array.
* For example if the Array is used to store multiple DataTable of UserCountry,
* we can add the metadata of the 'idSite' they refer to, so we can access it later if necessary.
*
* @var array of mixed
*/
public $metaData = array();
/**
* Array containing the DataTable withing this Piwik_DataTable_Array
*
* @var array of Piwik_DataTable
*/
protected $array = array();
/**
* This is the label used to index the tables.
* For example if the tables are indexed using the timestamp of each period
* eg. $this->array[1045886960] = new Piwik_DataTable;
* the nameKey would be 'timestamp'.
*
* This label is used in the Renderer (it becomes a column name or the XML description tag)
*
* @var string
*/
protected $nameKey = 'defaultKeyName';
/**
* Returns the nameKey string @see self::$nameKey
*
* @return string
*/
public function getNameKey()
{
return $this->nameKey;
}
/**
* Set the nameKey @see self::$nameKey
*
* @param string $name
*/
public function setNameKey($name)
{
$this->nameKey = $name;
}
/**
* Returns the number of DataTable in this DataTable_Array
*
* @return int
*/
public function getRowsCount()
{
return count($this->array);
}
/**
* Queue a filter to the DataTable_Array will queue this filter to every DataTable of the DataTable_Array.
*
* @param string $className Filter name, eg. Piwik_DataTable_Filter_Limit
* @param array $parameters Filter parameters, eg. array( 50, 10 )
*
* @return void
*/
public function queueFilter( $className, $parameters = array() )
{
foreach($this->array as $table)
{
$table->queueFilter($className, $parameters);
}
}
/**
* Apply the filters previously queued to each of the DataTable of this DataTable_Array.
*
* @return void
*/
public function applyQueuedFilters()
{
foreach($this->array as $table)
{
$table->applyQueuedFilters();
}
}
/**
* Returns the array of DataTable
*
* @return array of Piwik_DataTable
*/
public function getArray()
{
return $this->array;
}
/**
* Adds a new DataTable to the DataTable_Array
*
* @param Piwik_DataTable $table
* @param string $label Label used to index this table in the array
*/
public function addTable( Piwik_DataTable $table, $label )
{
$this->array[$label] = $table;
}
/**
* Returns a string output of this DataTable_Array (applying the default renderer to every DataTable
* of this DataTable_Array).
*
* @return string
*/
public function __toString()
{
$renderer = new Piwik_DataTable_Renderer_Console($this);
return (string)$renderer;
}
/**
* @see Piwik_DataTable::enableRecursiveSort()
*/
public function enableRecursiveSort()
{
foreach($this->array as $table)
{
$table->enableRecursiveSort();
}
}
}
|
