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
|
<?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_Referers
*/
// no direct access
defined('PIWIK_INCLUDE_PATH') or die;
/**
* @see plugins/Referers/functions.php
*/
require_once PIWIK_INCLUDE_PATH . '/plugins/Referers/functions.php';
/**
*
* @package Piwik_Referers
*/
class Piwik_Referers_API
{
static private $instance = null;
static public function getInstance()
{
if (self::$instance == null)
{
$c = __CLASS__;
self::$instance = new $c();
}
return self::$instance;
}
/**
* @return Piwik_DataTable
*/
static protected function getDataTable($name, $idSite, $period, $date, $expanded, $idSubtable = null)
{
Piwik::checkUserHasViewAccess( $idSite );
$archive = Piwik_Archive::build($idSite, $period, $date );
if($expanded)
{
$dataTable = $archive->getDataTableExpanded($name, $idSubtable);
}
else
{
$dataTable = $archive->getDataTable($name, $idSubtable);
}
$dataTable->filter('Sort', array(Piwik_Archive::INDEX_NB_VISITS, 'desc', $naturalSort = false, $expanded));
$dataTable->queueFilter('ReplaceColumnNames', array($expanded));
$dataTable->queueFilter('ReplaceSummaryRowLabel');
return $dataTable;
}
static public function getRefererType($idSite, $period, $date, $typeReferer = false)
{
$dataTable = self::getDataTable('Referers_type', $idSite, $period, $date, $expanded = false);
if($typeReferer !== false)
{
$dataTable->filter('Pattern', array('label', $typeReferer));
}
$dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_getRefererTypeLabel'));
return $dataTable;
}
static public function getKeywords($idSite, $period, $date, $expanded = false)
{
$dataTable = self::getDataTable('Referers_searchEngineByKeyword', $idSite, $period, $date, $expanded);
return $dataTable;
}
static public function getSearchEnginesFromKeywordId($idSite, $period, $date, $idSubtable)
{
$dataTable = self::getDataTable('Referers_searchEngineByKeyword',$idSite, $period, $date, $expanded = false, $idSubtable);
$dataTable->queueFilter('ColumnCallbackAddMetadata', array( 'label', 'url', 'Piwik_getSearchEngineUrlFromName') );
$dataTable->queueFilter('MetadataCallbackAddMetadata', array( 'url', 'logo', 'Piwik_getSearchEngineLogoFromUrl') );
// get the keyword and create the URL to the search result page
$keywords = self::getKeywords($idSite, $period, $date);
$keyword = $keywords->getRowFromIdSubDataTable($idSubtable)->getColumn('label');
$dataTable->queueFilter('MetadataCallbackReplace', array( 'url', 'Piwik_getSearchEngineUrlFromUrlAndKeyword', array($keyword)) );
return $dataTable;
}
static public function getSearchEngines($idSite, $period, $date, $expanded = false)
{
$dataTable = self::getDataTable('Referers_keywordBySearchEngine',$idSite, $period, $date, $expanded);
$dataTable->queueFilter('ColumnCallbackAddMetadata', array( 'label', 'url', 'Piwik_getSearchEngineUrlFromName') );
$dataTable->queueFilter('MetadataCallbackAddMetadata', array( 'url', 'logo', 'Piwik_getSearchEngineLogoFromUrl') );
return $dataTable;
}
static public function getKeywordsFromSearchEngineId($idSite, $period, $date, $idSubtable)
{
$dataTable = self::getDataTable('Referers_keywordBySearchEngine',$idSite, $period, $date, $expanded = false, $idSubtable);
// get the search engine and create the URL to the search result page
$searchEngines = self::getSearchEngines($idSite, $period, $date);
$searchEngines->applyQueuedFilters();
$searchEngineUrl = $searchEngines->getRowFromIdSubDataTable($idSubtable)->getMetadata('url');
$dataTable->queueFilter('ColumnCallbackAddMetadata', array( 'label', 'url', 'Piwik_getSearchEngineUrlFromKeywordAndUrl', array($searchEngineUrl)));
return $dataTable;
}
static public function getCampaigns($idSite, $period, $date, $expanded = false)
{
$dataTable = self::getDataTable('Referers_keywordByCampaign',$idSite, $period, $date, $expanded);
return $dataTable;
}
static public function getKeywordsFromCampaignId($idSite, $period, $date, $idSubtable)
{
$dataTable = self::getDataTable('Referers_keywordByCampaign',$idSite, $period, $date, $expanded = false, $idSubtable);
return $dataTable;
}
static public function getWebsites($idSite, $period, $date, $expanded = false)
{
$dataTable = self::getDataTable('Referers_urlByWebsite',$idSite, $period, $date, $expanded);
return $dataTable;
}
static public function getUrlsFromWebsiteId($idSite, $period, $date, $idSubtable)
{
$dataTable = self::getDataTable('Referers_urlByWebsite',$idSite, $period, $date, $expanded = false, $idSubtable);
$dataTable->queueFilter('ColumnCallbackAddMetadata', array( 'label', 'url', create_function('$label', 'return $label;')) );
$dataTable->queueFilter('ColumnCallbackReplace', array('label', 'Piwik_getPathFromUrl'));
return $dataTable;
}
static public function getNumberOfDistinctSearchEngines($idSite, $period, $date)
{
return self::getNumeric('Referers_distinctSearchEngines', $idSite, $period, $date);
}
static public function getNumberOfDistinctKeywords($idSite, $period, $date)
{
return self::getNumeric('Referers_distinctKeywords', $idSite, $period, $date);
}
static public function getNumberOfDistinctCampaigns($idSite, $period, $date)
{
return self::getNumeric('Referers_distinctCampaigns', $idSite, $period, $date);
}
static public function getNumberOfDistinctWebsites($idSite, $period, $date)
{
return self::getNumeric('Referers_distinctWebsites', $idSite, $period, $date);
}
static public function getNumberOfDistinctWebsitesUrls($idSite, $period, $date)
{
return self::getNumeric('Referers_distinctWebsitesUrls', $idSite, $period, $date);
}
static private function getNumeric($name, $idSite, $period, $date)
{
Piwik::checkUserHasViewAccess( $idSite );
$archive = Piwik_Archive::build($idSite, $period, $date );
return $archive->getDataTableFromNumeric($name);
}
}
|
