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
|
<?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
*/
require_once 'Period.php';
require_once 'Date.php';
require_once 'ArchiveProcessing.php';
require_once 'Archive/Single.php';
/**
* Architecture
* - *ArchiveProcessing* entity : handle all the computation on an archive / create & delete archive
* - *Archive* entity:
* contains the information on an archive,
* uses the ArchiveProcessing if necessary
* small overhead so we can instanciate many objects of this class for example one for each day
* of the month
* - *Website* entity: getId, getUrls, getFirstDay, etc.
* + *Period* entity: composed of *Date* objects
* + *Table* entity: serialize, unserialize, sort elements, limit number of elements
* contains all the logic, data structure, etc.
* receives data directly from the sql query via a known API
* - The *ArchiveProcessing* saves in the DB *numbers* or *Table* objects
*
* @package Piwik
*/
abstract class Piwik_Archive
{
const INDEX_NB_UNIQ_VISITORS = 1;
const INDEX_NB_VISITS = 2;
const INDEX_NB_ACTIONS = 3;
const INDEX_MAX_ACTIONS = 4;
const INDEX_SUM_VISIT_LENGTH = 5;
const INDEX_BOUNCE_COUNT = 6;
protected $alreadyChecked = false;
protected $site = null;
static protected $alreadyBuilt = array();
/**
* Builds an Archive object or returns the same archive if previously built.
*
* @param int $idSite
* @param string|Piwik_Date $date 'YYYY-MM-DD' or magic keywords 'today' See Piwik_Date::factory
* @param string $period 'week' 'day' etc.
* @return Piwik_Archive
*/
static public function build($idSite, $period, $oDate )
{
$oSite = new Piwik_Site($idSite);
if(is_string($oDate)
&& (
ereg('^(last|previous){1}([0-9]*)$', $oDate, $regs)
|| ereg('^([0-9]{4}-[0-9]{1,2}-[0-9]{1,2}),([0-9]{4}-[0-9]{1,2}-[0-9]{1,2})$', $oDate, $regs)
)
)
{
require_once 'Archive/Array.php';
$archive = new Piwik_Archive_Array($oSite, $period, $oDate);
}
else
{
if(is_string($oDate))
{
$oDate = Piwik_Date::factory($oDate);
}
$date = $oDate->toString();
if(isset(self::$alreadyBuilt[$idSite][$date][$period]))
{
return self::$alreadyBuilt[$idSite][$date][$period];
}
$oPeriod = Piwik_Period::factory($period, $oDate);
$archive = new Piwik_Archive_Single;
$archive->setPeriod($oPeriod);
$archive->setSite($oSite);
self::$alreadyBuilt[$idSite][$date][$period] = $archive;
}
return $archive;
}
/**
* Returns the value of the element $name from the current archive
* The value to be returned is a numeric value and is stored in the archive_numeric_* tables
*
* @param string $name For example Referers_distinctKeywords
* @return float|int|false False if no value with the given name
*/
abstract public function getNumeric( $name );
/**
* Returns the value of the element $name from the current archive
*
* The value to be returned is a blob value and is stored in the archive_numeric_* tables
*
* It can return anything from strings, to serialized PHP arrays or PHP objects, etc.
*
* @param string $name For example Referers_distinctKeywords
* @return mixed False if no value with the given name
*/
abstract public function getBlob( $name );
/**
* Given a list of fields defining numeric values, it will return a Piwik_DataTable_Simple
* containing one row per value.
*
* For example $fields = array( 'max_actions',
* 'nb_uniq_visitors',
* 'nb_visits',
* 'nb_actions',
* 'sum_visit_length',
* 'bounce_count',
* );
*
* @param array $fields array( fieldName1, fieldName2, ...)
* @return Piwik_DataTable_Simple
*/
abstract public function getDataTableFromNumeric( $fields );
/**
* This method will build a dataTable from the blob value $name in the current archive.
*
* For example $name = 'Referers_searchEngineByKeyword' will return a Piwik_DataTable containing all the keywords
* If a idSubTable is given, the method will return the subTable of $name
*
* @param string $name
* @param int $idSubTable
* @return Piwik_DataTable
* @throws exception If the value cannot be found
*/
abstract public function getDataTable( $name, $idSubTable = null );
/**
* Same as getDataTable() except that it will also load in memory
* all the subtables for the DataTable $name.
* You can then access the subtables by using the Piwik_DataTable_Manager getTable()
*
* @param string $name
* @param int $idSubTable
* @return Piwik_DataTable
*/
abstract public function getDataTableExpanded($name, $idSubTable = null);
/**
* Set the site
*
* @param Piwik_Site $site
*/
public function setSite( Piwik_Site $site )
{
$this->site = $site;
}
/**
* Get the site
*
* @param Piwik_Site $site
*/
public function getSite( )
{
return $this->site;
}
/**
* Returns the Id site associated with this archive
*
* @return int
*/
public function getIdSite()
{
return $this->site->getId();
}
}
|
