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
|
<?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\VisitFrequency;
use Piwik\API\Request;
use Piwik\DataTable;
use Piwik\Period;
use Piwik\Piwik;
use Piwik\Plugins\API\DataTable\MergeDataTables;
use Piwik\Segment;
use Piwik\Segment\SegmentExpression;
use Piwik\Site;
/**
* VisitFrequency API lets you access a list of metrics related to Returning Visitors.
* @method static \Piwik\Plugins\VisitFrequency\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
// visitorType==returning,visitorType==returningCustomer
public const RETURNING_VISITOR_SEGMENT = "visitorType%3D%3Dreturning%2CvisitorType%3D%3DreturningCustomer";
public const RETURNING_COLUMN_SUFFIX = "_returning";
public const NEW_VISITOR_SEGMENT = 'visitorType%3D%3Dnew';
public const NEW_COLUMN_SUFFIX = "_new";
protected $autoSanitizeInputParams = false;
/**
* @param string|int|int[] $idSite
* @param null|string|string[] $columns
*/
public function get($idSite, string $period, string $date, ?string $segment = null, $columns = null): DataTable\DataTableInterface
{
Piwik::checkUserHasViewAccess($idSite);
$visitTypes = array(
self::NEW_COLUMN_SUFFIX => self::NEW_VISITOR_SEGMENT,
self::RETURNING_COLUMN_SUFFIX => self::RETURNING_VISITOR_SEGMENT,
);
$columns = Piwik::getArrayFromApiParameter($columns);
if ($idSite === 'all' || count(Site::getIdSitesFromIdSitesString($idSite, false, true)) > 1) {
$resultSet = new DataTable\Map();
$resultSet->setKeyName('idSite');
} elseif (Period::isMultiplePeriod($date, $period)) {
$resultSet = new DataTable\Map();
$resultSet->setKeyName('period');
} else {
$resultSet = new DataTable\Simple();
}
foreach ($visitTypes as $columnSuffix => $visitorTypeSegment) {
$modifiedSegment = Segment::combine($segment, SegmentExpression::AND_DELIMITER, $visitorTypeSegment);
$columnsForVisitType = empty($columns) ? array() : $this->unprefixColumns($columns, $columnSuffix);
// Only make the API call if either $columns is empty (i.e. no list of columns was passed in, so we
// should fetch all columns) or if one of the columns that was passed in is for this visitor type
if (!empty($columns) && empty($columnsForVisitType)) {
continue;
}
$params = array(
'idSite' => $idSite,
'period' => $period,
'date' => $date,
'segment' => $modifiedSegment,
'columns' => implode(',', $columnsForVisitType),
'format' => 'original',
'format_metrics' => 0,
);
/** @var DataTable\Map|DataTable $response */
$response = Request::processRequest('VisitsSummary.get', $params);
$this->prefixColumns($response, $columnSuffix);
$merger = new MergeDataTables();
$merger->mergeDataTables($resultSet, $response);
}
return $resultSet;
}
/**
* @param string[] $requestedColumns
* @return string[]
*/
protected function unprefixColumns(array $requestedColumns, string $suffix): array
{
$result = array();
foreach ($requestedColumns as $column) {
if (strpos($column, $suffix) !== false) {
$result[] = str_replace($suffix, '', $column);
}
}
return $result;
}
protected function prefixColumns(DataTable\DataTableInterface $table, string $suffix): void
{
$rename = array();
foreach ($table->getColumns() as $oldColumn) {
$rename[$oldColumn] = $oldColumn . $suffix;
}
$table->filter('ReplaceColumnNames', [$rename]);
}
}
|
