blob: b9b9bc4ab13252727ffc7d351fb7963a82105dc3 (
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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\ExamplePlugin;
use Piwik\ArchiveProcessor;
use Piwik\Container\StaticContainer;
use Piwik\Date;
use Piwik\Option;
use Piwik\Sequence;
use Psr\Log\LoggerInterface;
/**
* Class Archiver
*
* Archiver is class processing raw data into ready ro read reports.
* It must implement two methods for aggregating daily reports
* aggregateDayReport() and other for summing daily reports into periods
* like week, month, year or custom range aggregateMultipleReports().
*
* For more detailed information about Archiver please visit Piwik developer guide
* http://developer.piwik.org/api-reference/Piwik/Plugin/Archiver
*/
class Archiver extends \Piwik\Plugin\Archiver
{
/**
* It is a good practice to store your archive names (reports stored in database)
* in Archiver class constants. You can define as many record names as you want
* for your plugin.
*
* Also important thing is that record name must be prefixed with plugin name.
*
* This is only an example record name, so feel free to change it to suit your needs.
*/
const EXAMPLEPLUGIN_ARCHIVE_RECORD = "ExamplePlugin_archive_record";
const EXAMPLEPLUGIN_METRIC_NAME = 'ExamplePlugin_example_metric';
const EXAMPLEPLUGIN_CONST_METRIC_NAME = 'ExamplePlugin_example_metric2';
private $daysFrom = '2016-07-08';
public function __construct(ArchiveProcessor $processor)
{
parent::__construct($processor);
$requestedReport = $processor->getParams()->getArchiveOnlyReport();
if ($requestedReport) {
$processor->getParams()->setIsPartialArchive(true);
}
$this->createSequence();
}
public function aggregateDayReport()
{
/**
* inside this method you can implement your LogAggreagator usage
* to process daily reports, this one uses idvisitor to group results.
*
* $visitorMetrics = $this
* ->getLogAggregator()
* ->getMetricsFromVisitByDimension('idvisitor')
* ->asDataTable();
* $visitorReport = $visitorMetrics->getSerialized();
* $this->getProcessor()->insertBlobRecord(self::EXAMPLEPLUGIN_ARCHIVE_RECORD, $visitorReport);
*/
if ($this->isRequestedReport(self::EXAMPLEPLUGIN_METRIC_NAME)) {
// insert a test numeric metric that is the difference in days between the day we're archiving and
// $this->daysFrom.
$daysFrom = Date::factory($this->daysFrom);
$date = $this->getProcessor()->getParams()->getPeriod()->getDateStart();
$differenceInSeconds = $daysFrom->getTimestamp() - $date->getTimestamp();
$differenceInDays = round($differenceInSeconds / 86400);
$this->getProcessor()->insertNumericRecord(self::EXAMPLEPLUGIN_METRIC_NAME, $differenceInDays);
}
if ($this->isRequestedReport(self::EXAMPLEPLUGIN_CONST_METRIC_NAME)) {
$callCount = $this->getAndIncrementArchiveCallCount();
$metricValue = $callCount > 0 ? 1 : 0;
$this->getProcessor()->insertNumericRecord(self::EXAMPLEPLUGIN_CONST_METRIC_NAME, $metricValue);
}
}
public function aggregateMultipleReports()
{
/**
* Inside this method you can simply point daily records
* to be summed. This work for most cases.
* However if needed, also custom queries can be implemented
* for periods to achieve more acurrate results.
*
* $this->getProcessor()->aggregateDataTableRecords(self::EXAMPLEPLUGIN_ARCHIVE_RECORD);
*/
$reports = [];
if ($this->isRequestedReport(self::EXAMPLEPLUGIN_METRIC_NAME)) {
$reports[] = self::EXAMPLEPLUGIN_METRIC_NAME;
}
if ($this->isRequestedReport(self::EXAMPLEPLUGIN_CONST_METRIC_NAME)) {
$reports[] = self::EXAMPLEPLUGIN_CONST_METRIC_NAME;
}
$this->getProcessor()->aggregateNumericMetrics($reports);
}
private function incrementArchiveCount()
{
$sequence = new Sequence('ExamplePlugin_archiveCount');
$result = $sequence->getNextId();
return $result;
}
private function createSequence()
{
}
private function getAndIncrementArchiveCallCount()
{
$params = $this->getProcessor()->getParams();
$optionName = 'ExamplePlugin.metricValue.' . md5($params->getSite()->getId() . '.' . $params->getPeriod()->getRangeString()
. '.' . $params->getPeriod()->getLabel() . '.' . $params->getSegment()->getHash());
$value = (int) Option::get($optionName);
Option::set($optionName, $value + 1);
return $value;
}
}
|
