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
|
<?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\ExampleTracker\Columns;
use Piwik\Common;
use Piwik\Plugin\Dimension\ConversionDimension;
use Piwik\Tracker\Request;
use Piwik\Tracker\Visitor;
use Piwik\Tracker\Action;
use Piwik\Tracker\GoalManager;
/**
* This example dimension counts achievement points for each user. A user gets one achievement point for each action
* plus five extra achievement points for each conversion. This would allow you to create a ranking showing the most
* active/valuable users. It is just an example, you can log pretty much everything and even just store any custom
* request url property. Please note that dimension instances are usually cached during one tracking request so they
* should be stateless (meaning an instance of this dimension will be reused if requested multiple times).
*
* See {@link https://developer.matomo.org/api-reference/Piwik/Plugin\Dimension\ConversionDimension} for more information.
*/
class ExampleConversionDimension extends ConversionDimension
{
/**
* This will be the name of the column in the log_conversion table if a $columnType is specified.
* @var string
*/
protected $columnName = 'example_conversion_dimension';
/**
* If a columnType is defined, we will create this a column in the MySQL table having this type. Please make sure
* MySQL will understand this type. Once you change the column type the Piwik platform will notify the user to
* perform an update which can sometimes take a long time so be careful when choosing the correct column type.
* @var string
*/
protected $columnType = 'INTEGER(11) DEFAULT 0 NULL';
/**
* The type of the dimension is automatically detected by the columnType. If the type of the dimension is not
* detected correctly, you may want to adjust the type manually. The configured type will affect how the dimension
* is formatted in the UI.
* @var string
*/
// protected $type = self::TYPE_NUMBER;
/**
* The name of the dimension which will be visible for instance in the UI of a related report and in the mobile app.
* @return string
*/
protected $nameSingular = 'ExampleTracker_DimensionName';
/**
* By defining a segment a user will be able to filter their visitors by this column. For instance
* show all reports only considering users having more than 10 achievement points. If you do not want to define a
* segment for this dimension, simply leave the name empty.
*/
protected $segmentName = 'myConversionSegmentName';
protected $acceptValues = 'Here you should explain which values are accepted/useful for segments: Any number, for instance 1, 2, 3 , 99';
/**
* This event is triggered when an ecommerce order is converted. In this example we would store a "0" in case it
* was the visitors first action or "1" otherwise.
* Return boolean false if you do not want to change the value in some cases. If you do not want to perform any
* action on an ecommerce order at all it is recommended to just remove this method.
*
* @param Action|null $action
*
* @return mixed|false
*/
public function onEcommerceOrderConversion(Request $request, Visitor $visitor, $action, GoalManager $goalManager)
{
if ($visitor->isVisitorKnown()) {
return 1;
}
return 0;
}
/**
* This event is triggered when an ecommerce cart update is converted. In this example we would store a
* the value of the tracking url parameter "myCustomParam" in the "example_conversion_dimension" column.
* Return boolean false if you do not want to change the value in some cases. If you do not want to perform any
* action on an ecommerce order at all it is recommended to just remove this method.
*
* @param Action|null $action
*
* @return mixed|false
*/
public function onEcommerceCartUpdateConversion(Request $request, Visitor $visitor, $action, GoalManager $goalManager)
{
return Common::getRequestVar('myCustomParam', $default = false, 'int', $request->getParams());
}
/**
* This event is triggered when an any custom goal is converted. In this example we would store a the id of the
* goal in the 'example_conversion_dimension' column if the visitor is known and nothing otherwise.
* Return boolean false if you do not want to change the value in some cases. If you do not want to perform any
* action on an ecommerce order at all it is recommended to just remove this method.
*
* @param Action|null $action
*
* @return mixed|false
*/
public function onGoalConversion(Request $request, Visitor $visitor, $action, GoalManager $goalManager)
{
$goalId = $goalManager->getGoalColumn('idgoal');
if ($visitor->isVisitorKnown()) {
return $goalId;
}
return false;
}
}
|
