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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
|
<?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\Plugin;
use Exception;
use Piwik\Development;
/**
* Creates a new segment that can be used for instance within the {@link \Piwik\Columns\Dimension::configureSegment()}
* method. Make sure to set at least the following values: {@link setName()}, {@link setSegment()},
* {@link setSqlSegment()}, {@link setType()} and {@link setCategory()}. If you are using a segment in the context of a
* dimension the type and the SQL segment is usually set for you automatically.
*
* Example:
* ```
$segment = new \Piwik\Plugin\Segment();
$segment->setType(\Piwik\Plugin\Segment::TYPE_DIMENSION);
$segment->setName('General_EntryKeyword');
$segment->setCategory('General_Visit');
$segment->setSegment('entryKeyword');
$segment->setSqlSegment('log_visit.entry_keyword');
$segment->setAcceptedValues('Any keywords people search for on your website such as "help" or "imprint"');
```
* @api
* @since 2.5.0
*/
class Segment
{
/**
* Segment type 'dimension'. Can be used along with {@link setType()}.
* @api
*/
const TYPE_DIMENSION = 'dimension';
/**
* Segment type 'metric'. Can be used along with {@link setType()}.
* @api
*/
const TYPE_METRIC = 'metric';
private $type;
private $category;
private $name;
private $segment;
private $sqlSegment;
private $sqlFilter;
private $sqlFilterValue;
private $acceptValues;
private $permission;
private $suggestedValuesCallback;
private $unionOfSegments;
private $isInternalSegment = false;
private $suggestedValuesApi = '';
/**
* If true, this segment will only be visible to the user if the user has view access
* to one of the requested sites (see API.getSegmentsMetadata).
*
* @var bool
*/
private $requiresAtLeastViewAccess = false;
/**
* @ignore
*/
final public function __construct()
{
$this->init();
}
/**
* Here you can initialize this segment and set any default values. It is called directly after the object is
* created.
* @api
*/
protected function init()
{
}
/**
* Here you should explain which values are accepted/useful for your segment, for example:
* "1, 2, 3, etc." or "comcast.net, proxad.net, etc.". If the value needs any special encoding you should mention
* this as well. For example "Any URL including protocol. The URL must be URL encoded."
*
* @param string $acceptedValues
* @api
*/
public function setAcceptedValues($acceptedValues)
{
$this->acceptValues = $acceptedValues;
}
/**
* Set (overwrite) the category this segment belongs to. It should be a translation key such as 'General_Actions'
* or 'General_Visit'.
* @param string $category
* @api
*/
public function setCategory($category)
{
$this->category = $category;
}
/**
* Set (overwrite) the segment display name. This name will be visible in the API and the UI. It should be a
* translation key such as 'Actions_ColumnEntryPageTitle' or 'Resolution_ColumnResolution'.
* @param string $name
* @api
*/
public function setName($name)
{
$this->name = $name;
}
/**
* Set (overwrite) the name of the segment. The name should be lower case first and has to be unique. The segment
* name defined here needs to be set in the URL to actually apply this segment. Eg if the segment is 'searches'
* you need to set "&segment=searches>0" in the UI.
* @param string $segment
* @api
*/
public function setSegment($segment)
{
$this->segment = $segment;
$this->check();
}
/**
* Sometimes you want users to set values that differ from the way they are actually stored. For instance if you
* want to allow to filter by any URL than you might have to resolve this URL to an action id. Or a country name
* maybe has to be mapped to a 2 letter country code. You can do this by specifing either a callable such as
* `array('Classname', 'methodName')` or by passing a closure. There will be four values passed to the given closure
* or callable: `string $valueToMatch`, `string $segment` (see {@link setSegment()}), `string $matchType`
* (eg SegmentExpression::MATCH_EQUAL or any other match constant of this class) and `$segmentName`.
*
* If the closure returns NULL, then Piwik assumes the segment sub-string will not match any visitor.
*
* @param string|\Closure $sqlFilter
* @api
*/
public function setSqlFilter($sqlFilter)
{
$this->sqlFilter = $sqlFilter;
}
/**
* Similar to {@link setSqlFilter()} you can map a given segment value to another value. For instance you could map
* "new" to 0, 'returning' to 1 and any other value to '2'. You can either define a callable or a closure. There
* will be only one value passed to the closure or callable which contains the value a user has set for this
* segment. This callback is called shortly before {@link setSqlFilter()}.
* @param string|array $sqlFilterValue
* @api
*/
public function setSqlFilterValue($sqlFilterValue)
{
$this->sqlFilterValue = $sqlFilterValue;
}
/**
* Defines to which column in the MySQL database the segment belongs: 'mytablename.mycolumnname'. Eg
* 'log_visit.idsite'. When a segment is applied the given or filtered value will be compared with this column.
*
* @param string $sqlSegment
* @api
*/
public function setSqlSegment($sqlSegment)
{
$this->sqlSegment = $sqlSegment;
$this->check();
}
/**
* Set a list of segments that should be used instead of fetching the values from a single column.
* All set segments will be applied via an OR operator.
*
* @param array $segments
* @api
*/
public function setUnionOfSegments($segments)
{
$this->unionOfSegments = $segments;
$this->check();
}
/**
* @return array
* @ignore
*/
public function getUnionOfSegments()
{
return $this->unionOfSegments;
}
/**
* @return string
* @ignore
*/
public function getSqlSegment()
{
return $this->sqlSegment;
}
/**
* @return string
* @ignore
*/
public function getSqlFilterValue()
{
return $this->sqlFilterValue;
}
/**
* @return string
* @ignore
*/
public function getAcceptValues()
{
return $this->acceptValues;
}
/**
* @return string
* @ignore
*/
public function getSqlFilter()
{
return $this->sqlFilter;
}
/**
* Set (overwrite) the type of this segment which is usually either a 'dimension' or a 'metric'.
* @param string $type See constansts TYPE_*
* @api
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return string
* @ignore
*/
public function getType()
{
return $this->type;
}
/**
* @return string
* @ignore
*/
public function getName()
{
return $this->name;
}
/**
* @return string
* @ignore
*/
public function getCategoryId()
{
return $this->category;
}
/**
* Returns the name of this segment as it should appear in segment expressions.
*
* @return string
*/
public function getSegment()
{
return $this->segment;
}
/**
* @return string
* @ignore
*/
public function getSuggestedValuesCallback()
{
return $this->suggestedValuesCallback;
}
/**
* Set callback which will be executed when user will call for suggested values for segment.
*
* @param callable $suggestedValuesCallback
*/
public function setSuggestedValuesCallback($suggestedValuesCallback)
{
$this->suggestedValuesCallback = $suggestedValuesCallback;
}
/**
* @return string
* @ignore
*/
public function getSuggestedValuesApi()
{
return $this->suggestedValuesApi;
}
/**
* Set callback which will be executed when user will call for suggested values for segment.
*
* @param string $suggestedValuesApi
*/
public function setSuggestedValuesApi($suggestedValuesApi)
{
if (!empty($suggestedValuesApi) && is_string($suggestedValuesApi)) {
if (Development::isEnabled() && strpos($suggestedValuesApi, '.get') === false) {
throw new Exception('Invalid suggested values API defined, expecting ".get" to be present.');
}
} else {
$suggestedValuesApi = '';
}
$this->suggestedValuesApi = $suggestedValuesApi;
}
/**
* You can restrict the access to this segment by passing a boolean `false`. For instance if you want to make
* a certain segment only available to users having super user access you could do the following:
* `$segment->setPermission(Piwik::hasUserSuperUserAccess());`
* @param bool $permission
* @api
*/
public function setPermission($permission)
{
$this->permission = $permission;
}
/**
* @return array
* @ignore
*/
public function toArray()
{
$segment = array(
'type' => $this->type,
'category' => $this->category,
'name' => $this->name,
'segment' => $this->segment,
'sqlSegment' => $this->sqlSegment,
);
if (!empty($this->unionOfSegments)) {
$segment['unionOfSegments'] = $this->unionOfSegments;
}
if (!empty($this->sqlFilter)) {
$segment['sqlFilter'] = $this->sqlFilter;
}
if (!empty($this->sqlFilterValue)) {
$segment['sqlFilterValue'] = $this->sqlFilterValue;
}
if (!empty($this->acceptValues)) {
$segment['acceptedValues'] = $this->acceptValues;
}
if (isset($this->permission)) {
$segment['permission'] = $this->permission;
}
if (is_callable($this->suggestedValuesCallback)) {
$segment['suggestedValuesCallback'] = $this->suggestedValuesCallback;
}
if (is_string($this->suggestedValuesApi) && !empty($this->suggestedValuesApi)) {
$segment['suggestedValuesApi'] = $this->suggestedValuesApi;
}
return $segment;
}
/**
* Returns true if this segment should only be visible to the user if the user has view access
* to one of the requested sites (see API.getSegmentsMetadata), false if it should always be
* visible to the user (even the anonymous user).
*
* @return boolean
* @ignore
*/
public function isRequiresAtLeastViewAccess()
{
return $this->requiresAtLeastViewAccess;
}
/**
* Sets whether the segment should only be visible if the user requesting it has view access
* to one of the requested sites and if the user is not the anonymous user.
*
* @param boolean $requiresAtLeastViewAccess
* @ignore
*/
public function setRequiresAtLeastViewAccess($requiresAtLeastViewAccess)
{
$this->requiresAtLeastViewAccess = $requiresAtLeastViewAccess;
}
/**
* Sets whether the segment is for internal use only and should not be visible in the UI or in API metadata output.
* These types of segments are, for example, used in unions for other segments, but have no value to users.
*
* @param bool $value
*/
public function setIsInternal($value)
{
$this->isInternalSegment = $value;
}
/**
* Gets whether the segment is for internal use only and should not be visible in the UI or in API metadata output.
* These types of segments are, for example, used in unions for other segments, but have no value to users.
*
* @return bool
*/
public function isInternal()
{
return $this->isInternalSegment;
}
private function check()
{
if ($this->sqlSegment && $this->unionOfSegments) {
throw new Exception(sprintf('Union of segments and SQL segment is set for segment "%s", use only one of them', $this->name));
}
if ($this->segment && $this->unionOfSegments && in_array($this->segment, $this->unionOfSegments, true)) {
throw new Exception(sprintf('The segment %s contains a union segment to itself', $this->name));
}
}
}
|