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
|
<?php
/**
* Piwik - 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\API;
use Piwik\Category\CategoryList;
use Piwik\Columns\Dimension;
use Piwik\Piwik;
use Piwik\Plugin\Segment;
class SegmentMetadata
{
/**
* Map of category name to order
* @var array
*/
private $categoryOrder = array();
public function getSegmentsMetadata($idSites = array(), $_hideImplementationData = true, $isAuthenticatedWithViewAccess, $_showAllSegments = false)
{
$segments = array();
/**
* Triggered to add custom segment definitions.
*
* **Example**
*
* public function addSegments(&$segments)
* {
* $segment = new Segment();
* $segment->setSegment('my_segment_name');
* $segment->setType(Segment::TYPE_DIMENSION);
* $segment->setName('My Segment Name');
* $segment->setSqlSegment('log_table.my_segment_name');
* $segments[] = $segment;
* }
*
* @param array &$segments An array containing a list of segment entries.
*/
Piwik::postEvent('Segment.addSegments', array(&$segments));
foreach (Dimension::getAllDimensions() as $dimension) {
foreach ($dimension->getSegments() as $segment) {
if (!$_showAllSegments
&& $segment->isInternal()
) {
continue;
}
$segments[] = $segment;
}
}
/** @var Segment[] $dimensionSegments */
$dimensionSegments = $segments;
$segments = array();
foreach ($dimensionSegments as $segment) {
if ($segment->isRequiresAtLeastViewAccess()) {
$segment->setPermission($isAuthenticatedWithViewAccess);
}
$segments[] = $segment->toArray();
}
$categoryList = CategoryList::get();
foreach ($segments as &$segment) {
$categoryId = $segment['category'];
$segment['name'] = Piwik::translate($segment['name']);
$segment['category'] = Piwik::translate($categoryId);
if (!isset($this->categoryOrder[$segment['category']])) {
$category = $categoryList->getCategory($categoryId);
if (!empty($category)) {
$this->categoryOrder[$segment['category']] = $category->getOrder();
} else {
$this->categoryOrder[$segment['category']] = 999;
}
}
if ($_hideImplementationData) {
unset($segment['sqlFilter']);
unset($segment['sqlFilterValue']);
unset($segment['sqlSegment']);
if (isset($segment['suggestedValuesCallback'])
&& !is_string($segment['suggestedValuesCallback'])
) {
unset($segment['suggestedValuesCallback']);
}
if (isset($segment['suggestedValuesApi'])) {
unset($segment['suggestedValuesApi']);
}
}
}
usort($segments, array($this, 'sortSegments'));
return $segments;
}
private function sortSegments($row1, $row2)
{
$customVarCategory = Piwik::translate('CustomVariables_CustomVariables');
$columns = array('category', 'type', 'name', 'segment');
foreach ($columns as $column) {
// Keep segments ordered alphabetically inside categories..
$type = -1;
if ($column == 'name') {
$type = 1;
}
if ($column === 'category') {
$idOrder1 = $this->categoryOrder[$row1[$column]];
$idOrder2 = $this->categoryOrder[$row2[$column]];
if ($idOrder1 === $idOrder2) {
continue;
}
return $idOrder1 > $idOrder2 ? 1 : -1;
}
$compare = $type * strcmp($row1[$column], $row2[$column]);
// hack so that custom variables "page" are grouped together in the doc
if ($row1['category'] == $customVarCategory
&& $row1['category'] == $row2['category']
) {
$compare = strcmp($row1['segment'], $row2['segment']);
return $compare;
}
if ($compare != 0) {
return $compare;
}
}
return $compare;
}
}
|