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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
* @category Piwik_Plugins
* @package Piwik_Goals
*/
/**
*
* @package Piwik_Goals
*/
class Piwik_Goals_API
{
static private $instance = null;
static public function getInstance()
{
if (self::$instance == null)
{
$c = __CLASS__;
self::$instance = new $c();
}
return self::$instance;
}
static public function getGoals( $idSite )
{
$goals = Piwik_FetchAll("SELECT *
FROM ".Piwik_Common::prefixTable('goal')."
WHERE idsite = ?
AND deleted = 0", $idSite);
$cleanedGoals = array();
foreach($goals as &$goal)
{
unset($goal['idsite']);
if($goal['match_attribute'] == 'manually') {
unset($goal['pattern']);
unset($goal['pattern_type']);
unset($goal['case_sensitive']);
}
$cleanedGoals[$goal['idgoal']] = $goal;
}
return $cleanedGoals;
}
static public function addGoal( $idSite, $name, $matchAttribute, $pattern, $patternType, $caseSensitive, $revenue )
{
Piwik::checkUserHasAdminAccess($idSite);
// save in db
$db = Zend_Registry::get('db');
$idGoal = $db->fetchOne("SELECT max(idgoal) + 1
FROM ".Piwik::prefixTable('goal')."
WHERE idsite = ?", $idSite);
if($idGoal == false)
{
$idGoal = 1;
}
self::checkPatternIsValid($patternType, $pattern);
$name = self::checkName($name);
$pattern = self::checkPattern($pattern);
$db->insert(Piwik::prefixTable('goal'),
array(
'idsite' => $idSite,
'idgoal' => $idGoal,
'name' => $name,
'match_attribute' => $matchAttribute,
'pattern' => $pattern,
'pattern_type' => $patternType,
'case_sensitive' => $caseSensitive,
'revenue' => $revenue,
'deleted' => 0,
));
Piwik_Common::regenerateCacheWebsiteAttributes($idSite);
return $idGoal;
}
static public function updateGoal( $idSite, $idGoal, $name, $matchAttribute, $pattern, $patternType, $caseSensitive, $revenue )
{
Piwik::checkUserHasAdminAccess($idSite);
$name = self::checkName($name);
$pattern = self::checkPattern($pattern);
self::checkPatternIsValid($patternType, $pattern);
Zend_Registry::get('db')->update( Piwik::prefixTable('goal'),
array(
'name' => $name,
'match_attribute' => $matchAttribute,
'pattern' => $pattern,
'pattern_type' => $patternType,
'case_sensitive' => $caseSensitive,
'revenue' => $revenue,
),
"idsite = '$idSite' AND idgoal = '$idGoal'"
);
Piwik_Common::regenerateCacheWebsiteAttributes($idSite);
}
static private function checkPatternIsValid($patternType, $pattern)
{
if($patternType == 'exact'
&& substr($pattern, 0, 4) != 'http')
{
throw new Exception("If you choose 'exact match', the matching string must be a
URL starting with http:// or https://. For example, 'http://www.yourwebsite.com/newsletter/subscribed.html'.");
}
}
static private function checkName($name)
{
return urldecode($name);
}
static private function checkPattern($pattern)
{
return urldecode($pattern);
}
static public function deleteGoal( $idSite, $idGoal )
{
Piwik::checkUserHasAdminAccess($idSite);
Piwik_Query("UPDATE ".Piwik::prefixTable('goal')."
SET deleted = 1
WHERE idsite = ?
AND idgoal = ?",
array($idSite, $idGoal));
Piwik_Query("DELETE FROM ".Piwik::prefixTable("log_conversion")." WHERE idgoal = ?", $idGoal);
Piwik_Common::regenerateCacheWebsiteAttributes($idSite);
}
// static public function getConversionsReturningVisitors( $idSite, $period, $date, $idGoal = false )
// {
//
// }
//
// static public function getConversionsNewVisitors( $idSite, $period, $date, $idGoal = false )
// {
//
// }
static public function getConversionRateReturningVisitors( $idSite, $period, $date, $idGoal = false )
{
// visits converted for returning for all goals = call Frequency API
if($idGoal === false)
{
$request = new Piwik_API_Request("method=VisitFrequency.getConvertedVisitsReturning&idSite=$idSite&period=$period&date=$date&format=original");
$nbVisitsConvertedReturningVisitors = $request->process();
}
// visits converted for returning = nb conversion for this goal
else
{
$nbVisitsConvertedReturningVisitors = self::getNumeric($idSite, $period, $date, Piwik_Goals::getRecordName('nb_conversions', $idGoal, 1));
}
// all returning visits
$request = new Piwik_API_Request("method=VisitFrequency.getVisitsReturning&idSite=$idSite&period=$period&date=$date&format=original");
$nbVisitsReturning = $request->process();
// echo $nbVisitsConvertedReturningVisitors;
// echo "<br>". $nbVisitsReturning;exit;
return Piwik::getPercentageSafe($nbVisitsConvertedReturningVisitors, $nbVisitsReturning, Piwik_Goals::ROUNDING_PRECISION);
}
static public function getConversionRateNewVisitors( $idSite, $period, $date, $idGoal = false )
{
// new visits converted for all goals = nb visits converted - nb visits converted for returning
if($idGoal == false)
{
$request = new Piwik_API_Request("method=VisitsSummary.getVisitsConverted&idSite=$idSite&period=$period&date=$date&format=original");
$convertedVisits = $request->process();
$request = new Piwik_API_Request("method=VisitFrequency.getConvertedVisitsReturning&idSite=$idSite&period=$period&date=$date&format=original");
$convertedReturningVisits = $request->process();
$convertedNewVisits = $convertedVisits - $convertedReturningVisits;
}
// new visits converted for a given goal = nb conversion for this goal for new visits
else
{
$convertedNewVisits = self::getNumeric($idSite, $period, $date, Piwik_Goals::getRecordName('nb_conversions', $idGoal, 0));
}
// all new visits = all visits - all returning visits
$request = new Piwik_API_Request("method=VisitFrequency.getVisitsReturning&idSite=$idSite&period=$period&date=$date&format=original");
$nbVisitsReturning = $request->process();
$request = new Piwik_API_Request("method=VisitsSummary.getVisits&idSite=$idSite&period=$period&date=$date&format=original");
$nbVisits = $request->process();
$newVisits = $nbVisits - $nbVisitsReturning;
return Piwik::getPercentageSafe($convertedNewVisits, $newVisits, Piwik_Goals::ROUNDING_PRECISION);
}
static public function get( $idSite, $period, $date, $idGoal = false, $columns = array() )
{
Piwik::checkUserHasViewAccess( $idSite );
$archive = Piwik_Archive::build($idSite, $period, $date );
if(!empty($columns))
{
$toFetch = $columns;
}
else
{
$toFetch = array(
'nb_conversions',
'conversion_rate',
'revenue',
);
foreach($toFetch as &$columnName)
{
$columnName = Piwik_Goals::getRecordName($columnName, $idGoal);
}
}
$dataTable = $archive->getDataTableFromNumeric($toFetch);
return $dataTable;
}
static protected function getNumeric( $idSite, $period, $date, $toFetch )
{
Piwik::checkUserHasViewAccess( $idSite );
$archive = Piwik_Archive::build($idSite, $period, $date );
$dataTable = $archive->getNumeric($toFetch);
return $dataTable;
}
static public function getConversions( $idSite, $period, $date, $idGoal = false )
{
return self::getNumeric( $idSite, $period, $date, Piwik_Goals::getRecordName('nb_conversions', $idGoal));
}
static public function getConversionRate( $idSite, $period, $date, $idGoal = false )
{
return self::getNumeric( $idSite, $period, $date, Piwik_Goals::getRecordName('conversion_rate', $idGoal));
}
static public function getRevenue( $idSite, $period, $date, $idGoal = false )
{
return self::getNumeric( $idSite, $period, $date, Piwik_Goals::getRecordName('revenue', $idGoal));
}
}
|
