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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\ExamplePlugin\RecordBuilders;
use Piwik\ArchiveProcessor;
use Piwik\ArchiveProcessor\Record;
use Piwik\ArchiveProcessor\RecordBuilder;
use Piwik\Date;
/**
* The RecordBuilder class processes raw data into ready ro read reports.
* It must implement two methods, one for aggregating daily reports
* aggregate() and another returning information about the record.
*
* Plugins can have more than one RecordBuilder, and should try to divide them
* up into the smallest number they can, while still performing as few total log aggregation
* queries as possible (this results in improved performance overall).
*
* For more detailed information about RecordBuilders please visit Matomo developer guide
* https://developer.matomo.org/api-reference/Piwik/ArchiveProcessor/RecordBuilder
*/
class ExampleMetric extends RecordBuilder
{
/**
* It is good practice to store your archive names (reports stored in database)
* as class constants. You can define as many record names as you want
* for your plugin.
*
* Also important to note that record names must be prefixed with the plugin name.
*
* These are only example record names, so feel free to change them to suit your needs.
*/
public const EXAMPLEPLUGIN_ARCHIVE_RECORD = "ExamplePlugin_archive_record";
public const EXAMPLEPLUGIN_METRIC_NAME = 'ExamplePlugin_example_metric';
private $daysFrom = '2016-07-08';
/**
* This method should return the list of records this RecordBuilder creates. This example
* archives one metric, so we return some information about them.
*/
public function getRecordMetadata(ArchiveProcessor $archiveProcessor): array
{
return [
Record::make(Record::TYPE_NUMERIC, self::EXAMPLEPLUGIN_METRIC_NAME),
];
}
/**
* inside this method you can implement your LogAggregator usage
* to process daily reports. this code for example, uses idvisitor to group results:
*
* ```
* $record = new DataTable();
*
* $query = $archiveProcessor->getLogAggregator()->queryVisitsByDimension(['idvisitor']);
* while ($row = $query->fetch()) {
* $label = $row['idvisitor'];
* unset($row['idvisitor']);
* $record->sumRowWithLabel($label, $row);
* }
*
* return [self::EXAMPLEPLUGIN_ARCHIVE_RECORD => $record];
* ```
*
* non-day periods will automatically be aggregated together
*/
protected function aggregate(ArchiveProcessor $archiveProcessor): array
{
$params = $archiveProcessor->getParams();
$records = [];
// 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 = $params->getPeriod()->getDateStart();
$differenceInSeconds = $daysFrom->getTimestamp() - $date->getTimestamp();
$differenceInDays = round($differenceInSeconds / 86400);
$records[self::EXAMPLEPLUGIN_METRIC_NAME] = $differenceInDays;
return $records;
}
}
|
