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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @category Piwik_Plugins
* @package Piwik_VisitTime
*/
use Piwik\Common;
use Piwik\Period;
use Piwik\Site;
/**
*
* @package Piwik_VisitTime
*/
class Piwik_VisitTime extends Piwik_Plugin
{
/**
* @see Piwik_Plugin::getListHooksRegistered
*/
public function getListHooksRegistered()
{
$hooks = array(
'ArchiveProcessing_Day.compute' => 'archiveDay',
'ArchiveProcessing_Period.compute' => 'archivePeriod',
'WidgetsList.add' => 'addWidgets',
'Menu.add' => 'addMenu',
'Goals.getReportsWithGoalMetrics' => 'getReportsWithGoalMetrics',
'API.getReportMetadata' => 'getReportMetadata',
'API.getSegmentsMetadata' => 'getSegmentsMetadata',
'ViewDataTable.getReportDisplayProperties' => 'getReportDisplayProperties',
);
return $hooks;
}
public function getReportMetadata(&$reports)
{
$reports[] = array(
'category' => Piwik_Translate('VisitsSummary_VisitsSummary'),
'name' => Piwik_Translate('VisitTime_WidgetLocalTime'),
'module' => 'VisitTime',
'action' => 'getVisitInformationPerLocalTime',
'dimension' => Piwik_Translate('VisitTime_ColumnLocalTime'),
'documentation' => Piwik_Translate('VisitTime_WidgetLocalTimeDocumentation', array('<b>', '</b>')),
'constantRowsCount' => true,
'order' => 20
);
$reports[] = array(
'category' => Piwik_Translate('VisitsSummary_VisitsSummary'),
'name' => Piwik_Translate('VisitTime_WidgetServerTime'),
'module' => 'VisitTime',
'action' => 'getVisitInformationPerServerTime',
'dimension' => Piwik_Translate('VisitTime_ColumnServerTime'),
'documentation' => Piwik_Translate('VisitTime_WidgetServerTimeDocumentation', array('<b>', '</b>')),
'constantRowsCount' => true,
'order' => 15,
);
$reports[] = array(
'category' => Piwik_Translate('VisitsSummary_VisitsSummary'),
'name' => Piwik_Translate('VisitTime_VisitsByDayOfWeek'),
'module' => 'VisitTime',
'action' => 'getByDayOfWeek',
'dimension' => Piwik_Translate('VisitTime_DayOfWeek'),
'documentation' => Piwik_Translate('VisitTime_WidgetByDayOfWeekDocumentation'),
'constantRowsCount' => true,
'order' => 25,
);
}
function addWidgets()
{
Piwik_AddWidget('VisitsSummary_VisitsSummary', 'VisitTime_WidgetLocalTime', 'VisitTime', 'getVisitInformationPerLocalTime');
Piwik_AddWidget('VisitsSummary_VisitsSummary', 'VisitTime_WidgetServerTime', 'VisitTime', 'getVisitInformationPerServerTime');
Piwik_AddWidget('VisitsSummary_VisitsSummary', 'VisitTime_VisitsByDayOfWeek', 'VisitTime', 'getByDayOfWeek');
}
function addMenu()
{
Piwik_AddMenu('General_Visitors', 'VisitTime_SubmenuTimes', array('module' => 'VisitTime', 'action' => 'index'));
}
public function getReportsWithGoalMetrics(&$dimensions)
{
$dimensions[] = array('category' => Piwik_Translate('VisitTime_ColumnServerTime'),
'name' => Piwik_Translate('VisitTime_ColumnServerTime'),
'module' => 'VisitTime',
'action' => 'getVisitInformationPerServerTime',
);
}
public function getSegmentsMetadata(&$segments)
{
$acceptedValues = "0, 1, 2, 3, ..., 20, 21, 22, 23";
$segments[] = array(
'type' => 'dimension',
'category' => Piwik_Translate('General_Visit'),
'name' => Piwik_Translate('VisitTime_ColumnServerTime'),
'segment' => 'visitServerHour',
'sqlSegment' => 'HOUR(log_visit.visit_last_action_time)',
'acceptedValues' => $acceptedValues
);
$segments[] = array(
'type' => 'dimension',
'category' => Piwik_Translate('General_Visit'),
'name' => Piwik_Translate('VisitTime_ColumnLocalTime'),
'segment' => 'visitLocalHour',
'sqlSegment' => 'HOUR(log_visit.visitor_localtime)',
'acceptedValues' => $acceptedValues
);
}
public function getReportDisplayProperties(&$properties, $apiAction)
{
$commonProperties = array(
'filter_sort_column' => 'label',
'filter_sort_order' => 'asc',
'show_search' => false,
'show_exclude_low_population' => false,
'show_offset_information' => false,
'show_pagination_control' => false,
'default_view_type' => 'graphVerticalBar'
);
$reportViewProperties = array(
'VisitTime.getVisitInformationPerServerTime' => array_merge($commonProperties, array(
'filter_limit' => 24,
'graph_limit' => null,
'show_goals' => true,
'translations' => array('label' => Piwik_Translate('VisitTime_ColumnServerTime')),
// custom parameter
'hideFutureHoursWhenToday' => 1,
)),
'VisitTime.getVisitInformationPerLocalTime' => array_merge($commonProperties, array(
'filter_limit' => 24,
'graph_limit' => null,
'title' => Piwik_Translate('VisitTime_ColumnLocalTime'),
'translations' => array('label' => Piwik_Translate('VisitTime_LocalTime')),
)),
'VisitTime.getByDayOfWeek' => array_merge($commonProperties, array(
'filter_limit' => 7,
'graph_limit' => null,
'enable_sort' => false,
'show_all_ticks' => true,
'show_footer_message' =>
Piwik_Translate('General_ReportGeneratedFrom', self::getDateRangeForFooterMessage()),
'translations' => array('label' => Piwik_Translate('VisitTime_DayOfWeek')),
)),
);
// add the visits by day of week as a related report, if the current period is not 'day'
if (Common::getRequestVar('period', 'day') != 'day') {
$reportViewProperties['VisitTime.getVisitInformationPerLocalTime']['relatedReports'] = array(
'VisitTime.getByDayOfWeek' => Piwik_Translate('VisitTime_VisitsByDayOfWeek')
);
}
if (isset($reportViewProperties[$apiAction])) {
$properties = $reportViewProperties[$apiAction];
}
}
public function archivePeriod(Piwik_ArchiveProcessor_Period $archiveProcessor)
{
$archiving = new Piwik_VisitTime_Archiver($archiveProcessor);
if($archiving->shouldArchive()) {
$archiving->archivePeriod();
}
}
public function archiveDay(Piwik_ArchiveProcessor_Day $archiveProcessor)
{
$archiving = new Piwik_VisitTime_Archiver($archiveProcessor);
if($archiving->shouldArchive()) {
$archiving->archiveDay();
}
}
private static function getDateRangeForFooterMessage()
{
// get query params
$idSite = Common::getRequestVar('idSite');
$date = Common::getRequestVar('date');
$period = Common::getRequestVar('period');
// create a period instance
$oPeriod = Period::makePeriodFromQueryParams(Site::getTimezoneFor($idSite), $period, $date);
// set the footer message using the period start & end date
$start = $oPeriod->getDateStart()->toString();
$end = $oPeriod->getDateEnd()->toString();
if ($start == $end) {
$dateRange = $start;
} else {
$dateRange = $start . " – " . $end;
}
return $dateRange;
}
}
|
