forked from microweber/microweber
/
Period.php
220 lines (198 loc) · 4.52 KB
/
Period.php
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
<?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: Period.php 4311 2011-04-04 18:49:55Z vipsoft $
*
* @category Piwik
* @package Piwik
*/
/**
* Creating a new Piwik_Period subclass:
*
* Every overloaded method must start with the code
* if(!$this->subperiodsProcessed)
* {
* $this->generate();
* }
* that checks whether the subperiods have already been computed.
* This is for performance improvements, computing the subperiods is done a per demand basis.
*
* @package Piwik
* @subpackage Piwik_Period
*/
abstract class Piwik_Period
{
protected $subperiods = array();
protected $subperiodsProcessed = false;
protected $label = null;
protected $date = null;
static protected $errorAvailablePeriods = 'day, week, month, year, range';
public function __construct( $date )
{
$this->checkInputDate( $date );
$this->date = clone $date;
}
/**
* @param string $strPeriod "day", "week", "month", "year"
* @param Piwik_Date $date Piwik_Date object
* @return Piwik_Period
*/
static public function factory($strPeriod, Piwik_Date $date)
{
switch ($strPeriod) {
case 'day':
return new Piwik_Period_Day($date);
break;
case 'week':
return new Piwik_Period_Week($date);
break;
case 'month':
return new Piwik_Period_Month($date);
break;
case 'year':
return new Piwik_Period_Year($date);
break;
default:
throw new Exception(Piwik_TranslateException('General_ExceptionInvalidPeriod', array($strPeriod, self::$errorAvailablePeriods)));
break;
}
}
/**
* Returns the first day of the period
*
* @return Piwik_Date First day of the period
*/
public function getDateStart()
{
if(!$this->subperiodsProcessed)
{
$this->generate();
}
if(count($this->subperiods) == 0)
{
return $this->getDate();
}
$periods = $this->getSubperiods();
$currentPeriod = $periods[0];
while( $currentPeriod->getNumberOfSubperiods() > 0 )
{
$periods = $currentPeriod->getSubperiods();
$currentPeriod = $periods[0];
}
return $currentPeriod->getDate();
}
/**
* Returns the last day of the period ; can be a date in the future
*
* @return Piwik_Date Last day of the period
*/
public function getDateEnd()
{
if(!$this->subperiodsProcessed)
{
$this->generate();
}
if(count($this->subperiods) == 0)
{
return $this->getDate();
}
$periods = $this->getSubperiods();
$currentPeriod = $periods[count($periods)-1];
while( $currentPeriod->getNumberOfSubperiods() > 0 )
{
$periods = $currentPeriod->getSubperiods();
$currentPeriod = $periods[count($periods)-1];
}
return $currentPeriod->getDate();
}
public function getId()
{
return Piwik::$idPeriods[$this->getLabel()];
}
public function getLabel()
{
return $this->label;
}
/**
* @return Piwik_Date
*/
protected function getDate()
{
return $this->date;
}
protected function checkInputDate($date)
{
if( !($date instanceof Piwik_Date))
{
throw new Exception("The date must be a Piwik_Date object. " . var_export($date,true));
}
}
protected function generate()
{
$this->subperiodsProcessed = true;
}
public function getNumberOfSubperiods()
{
if(!$this->subperiodsProcessed)
{
$this->generate();
}
return count($this->subperiods);
}
/**
* Returns Period_Day for a period made of days (week, month),
* Period_Month for a period made of months (year)
*
* @return array Piwik_Period
*/
public function getSubperiods()
{
if(!$this->subperiodsProcessed)
{
$this->generate();
}
return $this->subperiods;
}
/**
* Add a date to the period.
*
* Protected because it not yet supported to add periods after the initialization
*
* @param Piwik_Date Valid Piwik_Date object
*/
protected function addSubperiod( $date )
{
$this->subperiods[] = $date;
}
public function toString($format = "Y-m-d")
{
if(!$this->subperiodsProcessed)
{
$this->generate();
}
$dateString = array();
foreach($this->subperiods as $period)
{
$dateString[] = $period->toString($format);
}
return $dateString;
}
public function __toString()
{
return implode(",", $this->toString());
}
public function get( $part= null )
{
if(!$this->subperiodsProcessed)
{
$this->generate();
}
return $this->date->toString($part);
}
abstract public function getPrettyString();
abstract public function getLocalizedShortString();
abstract public function getLocalizedLongString();
}