Metrics.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.0.7

matomo / app / core / Metrics.php

matomo / app / core Last commit date

API 2 years ago Access 2 years ago Application 2 years ago Archive 2 years ago ArchiveProcessor 2 years ago Archiver 2 years ago AssetManager 2 years ago Auth 2 years ago Category 2 years ago Changes 2 years ago CliMulti 2 years ago Columns 2 years ago Concurrency 2 years ago Config 2 years ago Container 2 years ago CronArchive 2 years ago DataAccess 2 years ago DataFiles 2 years ago DataTable 2 years ago Db 2 years ago DeviceDetector 2 years ago Email 2 years ago Exception 2 years ago Http 2 years ago Intl 2 years ago Log 2 years ago Mail 2 years ago Measurable 2 years ago Menu 2 years ago Metrics 2 years ago Notification 2 years ago Period 2 years ago Plugin 2 years ago ProfessionalServices 2 years ago Report 2 years ago ReportRenderer 2 years ago Scheduler 2 years ago Segment 2 years ago Session 2 years ago Settings 2 years ago Tracker 2 years ago Translation 2 years ago Twig 2 years ago UpdateCheck 2 years ago Updater 2 years ago Updates 2 years ago Validators 2 years ago View 2 years ago ViewDataTable 2 years ago Visualization 2 years ago Widget 2 years ago .htaccess 2 years ago Access.php 2 years ago Archive.php 2 years ago ArchiveProcessor.php 2 years ago AssetManager.php 2 years ago Auth.php 2 years ago AuthResult.php 2 years ago BaseFactory.php 2 years ago Cache.php 2 years ago CacheId.php 2 years ago CliMulti.php 2 years ago Common.php 2 years ago Config.php 2 years ago Console.php 2 years ago Context.php 2 years ago Cookie.php 2 years ago CronArchive.php 2 years ago DI.php 2 years ago DataArray.php 2 years ago DataTable.php 2 years ago Date.php 2 years ago Db.php 2 years ago DbHelper.php 2 years ago Development.php 2 years ago ErrorHandler.php 2 years ago EventDispatcher.php 2 years ago ExceptionHandler.php 2 years ago FileIntegrity.php 2 years ago Filechecks.php 2 years ago Filesystem.php 2 years ago FrontController.php 2 years ago Http.php 2 years ago IP.php 2 years ago Log.php 2 years ago LogDeleter.php 2 years ago Mail.php 2 years ago Metrics.php 2 years ago NoAccessException.php 2 years ago Nonce.php 2 years ago Notification.php 2 years ago NumberFormatter.php 2 years ago Option.php 2 years ago Period.php 2 years ago Piwik.php 2 years ago Plugin.php 2 years ago Profiler.php 2 years ago ProxyHeaders.php 2 years ago ProxyHttp.php 2 years ago QuickForm2.php 2 years ago RankingQuery.php 2 years ago ReportRenderer.php 2 years ago Request.php 2 years ago Segment.php 2 years ago Sequence.php 2 years ago Session.php 2 years ago SettingsPiwik.php 2 years ago SettingsServer.php 2 years ago Singleton.php 2 years ago Site.php 2 years ago SiteContentDetector.php 2 years ago SupportedBrowser.php 2 years ago TCPDF.php 2 years ago Theme.php 2 years ago Timer.php 2 years ago Tracker.php 2 years ago Twig.php 2 years ago Unzip.php 2 years ago UpdateCheck.php 2 years ago Updater.php 2 years ago UpdaterErrorException.php 2 years ago Updates.php 2 years ago Url.php 2 years ago UrlHelper.php 2 years ago Version.php 2 years ago View.php 2 years ago bootstrap.php 2 years ago dispatch.php 2 years ago testMinimumPhpVersion.php 2 years ago

Metrics.php

434 lines

1	<?php
2
3	/**
4	* Matomo - free/libre analytics platform
5	*
6	* @link https://matomo.org
7	* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
8	*
9	*/
10	namespace Piwik;
11
12	use Piwik\Cache as PiwikCache;
13	use Piwik\Columns\Dimension;
14	use Piwik\Tracker\GoalManager;
15	require_once PIWIK_INCLUDE_PATH . "/core/Piwik.php";
16	/**
17	* This class contains metadata regarding core metrics and contains several
18	* related helper functions.
19	*
20	* Of note are the `INDEX_...` constants. In the database, metric column names
21	* in {@link DataTable} rows are stored as integers to save space. The integer
22	* values used are determined by these constants.
23	*
24	* @api
25	*/
26	class Metrics
27	{
28	/*
29	* When saving DataTables in the DB, we replace all columns name with these IDs. This saves many bytes,
30	* eg. INDEX_NB_UNIQ_VISITORS is an integer: 4 bytes, but 'nb_uniq_visitors' is 16 bytes at least
31	*/
32	const INDEX_NB_UNIQ_VISITORS = 1;
33	const INDEX_NB_VISITS = 2;
34	const INDEX_NB_ACTIONS = 3;
35	const INDEX_MAX_ACTIONS = 4;
36	const INDEX_SUM_VISIT_LENGTH = 5;
37	const INDEX_BOUNCE_COUNT = 6;
38	const INDEX_NB_VISITS_CONVERTED = 7;
39	const INDEX_NB_CONVERSIONS = 8;
40	const INDEX_REVENUE = 9;
41	const INDEX_GOALS = 10;
42	const INDEX_SUM_DAILY_NB_UNIQ_VISITORS = 11;
43	// Specific to the Actions reports
44	const INDEX_PAGE_NB_HITS = 12;
45	const INDEX_PAGE_SUM_TIME_SPENT = 13;
46	const INDEX_PAGE_EXIT_NB_UNIQ_VISITORS = 14;
47	const INDEX_PAGE_EXIT_NB_VISITS = 15;
48	const INDEX_PAGE_EXIT_SUM_DAILY_NB_UNIQ_VISITORS = 16;
49	const INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS = 17;
50	const INDEX_PAGE_ENTRY_SUM_DAILY_NB_UNIQ_VISITORS = 18;
51	const INDEX_PAGE_ENTRY_NB_VISITS = 19;
52	const INDEX_PAGE_ENTRY_NB_ACTIONS = 20;
53	const INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH = 21;
54	const INDEX_PAGE_ENTRY_BOUNCE_COUNT = 22;
55	// Ecommerce Items reports
56	const INDEX_ECOMMERCE_ITEM_REVENUE = 23;
57	const INDEX_ECOMMERCE_ITEM_QUANTITY = 24;
58	const INDEX_ECOMMERCE_ITEM_PRICE = 25;
59	const INDEX_ECOMMERCE_ORDERS = 26;
60	const INDEX_ECOMMERCE_ITEM_PRICE_VIEWED = 27;
61	// Site Search
62	const INDEX_SITE_SEARCH_HAS_NO_RESULT = 28;
63	const INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS = 29;
64	// Performance Analytics
65	const INDEX_PAGE_SUM_TIME_GENERATION = 30;
66	const INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION = 31;
67	const INDEX_PAGE_MIN_TIME_GENERATION = 32;
68	const INDEX_PAGE_MAX_TIME_GENERATION = 33;
69	// Events
70	const INDEX_EVENT_NB_HITS = 34;
71	const INDEX_EVENT_SUM_EVENT_VALUE = 35;
72	const INDEX_EVENT_MIN_EVENT_VALUE = 36;
73	const INDEX_EVENT_MAX_EVENT_VALUE = 37;
74	const INDEX_EVENT_NB_HITS_WITH_VALUE = 38;
75	// Number of unique User IDs
76	const INDEX_NB_USERS = 39;
77	const INDEX_SUM_DAILY_NB_USERS = 40;
78	// Contents
79	const INDEX_CONTENT_NB_IMPRESSIONS = 41;
80	const INDEX_CONTENT_NB_INTERACTIONS = 42;
81	// Unique visitors fingerprints (useful to process unique visitors across websites)
82	const INDEX_NB_UNIQ_FINGERPRINTS = 43;
83	// Goal reports
84	const INDEX_GOAL_NB_CONVERSIONS = 1;
85	const INDEX_GOAL_REVENUE = 2;
86	const INDEX_GOAL_NB_VISITS_CONVERTED = 3;
87	const INDEX_GOAL_ECOMMERCE_REVENUE_SUBTOTAL = 4;
88	const INDEX_GOAL_ECOMMERCE_REVENUE_TAX = 5;
89	const INDEX_GOAL_ECOMMERCE_REVENUE_SHIPPING = 6;
90	const INDEX_GOAL_ECOMMERCE_REVENUE_DISCOUNT = 7;
91	const INDEX_GOAL_ECOMMERCE_ITEMS = 8;
92	const INDEX_GOAL_NB_PAGES_UNIQ_BEFORE = 9;
93	const INDEX_GOAL_NB_CONVERSIONS_ATTRIB = 10;
94	const INDEX_GOAL_NB_CONVERSIONS_PAGE_RATE = 11;
95	const INDEX_GOAL_NB_CONVERSIONS_PAGE_UNIQ = 12;
96	const INDEX_GOAL_NB_CONVERSIONS_ENTRY_RATE = 13;
97	const INDEX_GOAL_REVENUE_PER_ENTRY = 14;
98	const INDEX_GOAL_REVENUE_ATTRIB = 15;
99	const INDEX_GOAL_NB_CONVERSIONS_ENTRY = 16;
100	const INDEX_GOAL_REVENUE_ENTRY = 17;
101	public static $mappingFromIdToName = array(
102	\Piwik\Metrics::INDEX_NB_UNIQ_VISITORS => 'nb_uniq_visitors',
103	\Piwik\Metrics::INDEX_NB_UNIQ_FINGERPRINTS => 'nb_uniq_fingerprints',
104	\Piwik\Metrics::INDEX_NB_VISITS => 'nb_visits',
105	\Piwik\Metrics::INDEX_NB_ACTIONS => 'nb_actions',
106	\Piwik\Metrics::INDEX_NB_USERS => 'nb_users',
107	\Piwik\Metrics::INDEX_MAX_ACTIONS => 'max_actions',
108	\Piwik\Metrics::INDEX_SUM_VISIT_LENGTH => 'sum_visit_length',
109	\Piwik\Metrics::INDEX_BOUNCE_COUNT => 'bounce_count',
110	\Piwik\Metrics::INDEX_NB_VISITS_CONVERTED => 'nb_visits_converted',
111	\Piwik\Metrics::INDEX_NB_CONVERSIONS => 'nb_conversions',
112	\Piwik\Metrics::INDEX_REVENUE => 'revenue',
113	\Piwik\Metrics::INDEX_GOALS => 'goals',
114	\Piwik\Metrics::INDEX_SUM_DAILY_NB_UNIQ_VISITORS => 'sum_daily_nb_uniq_visitors',
115	\Piwik\Metrics::INDEX_SUM_DAILY_NB_USERS => 'sum_daily_nb_users',
116	// Actions metrics
117	\Piwik\Metrics::INDEX_PAGE_NB_HITS => 'nb_hits',
118	\Piwik\Metrics::INDEX_PAGE_SUM_TIME_SPENT => 'sum_time_spent',
119	\Piwik\Metrics::INDEX_PAGE_SUM_TIME_GENERATION => 'sum_time_generation',
120	\Piwik\Metrics::INDEX_PAGE_NB_HITS_WITH_TIME_GENERATION => 'nb_hits_with_time_generation',
121	\Piwik\Metrics::INDEX_PAGE_MIN_TIME_GENERATION => 'min_time_generation',
122	\Piwik\Metrics::INDEX_PAGE_MAX_TIME_GENERATION => 'max_time_generation',
123	\Piwik\Metrics::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS => 'exit_nb_uniq_visitors',
124	\Piwik\Metrics::INDEX_PAGE_EXIT_NB_VISITS => 'exit_nb_visits',
125	\Piwik\Metrics::INDEX_PAGE_EXIT_SUM_DAILY_NB_UNIQ_VISITORS => 'sum_daily_exit_nb_uniq_visitors',
126	\Piwik\Metrics::INDEX_PAGE_ENTRY_NB_UNIQ_VISITORS => 'entry_nb_uniq_visitors',
127	\Piwik\Metrics::INDEX_PAGE_ENTRY_SUM_DAILY_NB_UNIQ_VISITORS => 'sum_daily_entry_nb_uniq_visitors',
128	\Piwik\Metrics::INDEX_PAGE_ENTRY_NB_VISITS => 'entry_nb_visits',
129	\Piwik\Metrics::INDEX_PAGE_ENTRY_NB_ACTIONS => 'entry_nb_actions',
130	\Piwik\Metrics::INDEX_PAGE_ENTRY_SUM_VISIT_LENGTH => 'entry_sum_visit_length',
131	\Piwik\Metrics::INDEX_PAGE_ENTRY_BOUNCE_COUNT => 'entry_bounce_count',
132	\Piwik\Metrics::INDEX_PAGE_IS_FOLLOWING_SITE_SEARCH_NB_HITS => 'nb_hits_following_search',
133	// Items reports metrics
134	\Piwik\Metrics::INDEX_ECOMMERCE_ITEM_REVENUE => 'revenue',
135	\Piwik\Metrics::INDEX_ECOMMERCE_ITEM_QUANTITY => 'quantity',
136	\Piwik\Metrics::INDEX_ECOMMERCE_ITEM_PRICE => 'price',
137	\Piwik\Metrics::INDEX_ECOMMERCE_ITEM_PRICE_VIEWED => 'price_viewed',
138	\Piwik\Metrics::INDEX_ECOMMERCE_ORDERS => 'orders',
139	// Events
140	\Piwik\Metrics::INDEX_EVENT_NB_HITS => 'nb_events',
141	\Piwik\Metrics::INDEX_EVENT_SUM_EVENT_VALUE => 'sum_event_value',
142	\Piwik\Metrics::INDEX_EVENT_MIN_EVENT_VALUE => 'min_event_value',
143	\Piwik\Metrics::INDEX_EVENT_MAX_EVENT_VALUE => 'max_event_value',
144	\Piwik\Metrics::INDEX_EVENT_NB_HITS_WITH_VALUE => 'nb_events_with_value',
145	// Contents
146	\Piwik\Metrics::INDEX_CONTENT_NB_IMPRESSIONS => 'nb_impressions',
147	\Piwik\Metrics::INDEX_CONTENT_NB_INTERACTIONS => 'nb_interactions',
148	);
149	public static $mappingFromIdToNameGoal = array(\Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS => 'nb_conversions', \Piwik\Metrics::INDEX_GOAL_NB_VISITS_CONVERTED => 'nb_visits_converted', \Piwik\Metrics::INDEX_GOAL_REVENUE => 'revenue', \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SUBTOTAL => 'revenue_subtotal', \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_TAX => 'revenue_tax', \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SHIPPING => 'revenue_shipping', \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_DISCOUNT => 'revenue_discount', \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_ITEMS => 'items', \Piwik\Metrics::INDEX_GOAL_NB_PAGES_UNIQ_BEFORE => 'nb_conv_pages_before', \Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS_ATTRIB => 'nb_conversions_attrib', \Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS_PAGE_RATE => 'nb_conversions_page_rate', \Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS_PAGE_UNIQ => 'nb_conversions_page_uniq', \Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS_ENTRY_RATE => 'nb_conversions_entry_rate', \Piwik\Metrics::INDEX_GOAL_REVENUE_PER_ENTRY => 'revenue_per_entry', \Piwik\Metrics::INDEX_GOAL_REVENUE_ATTRIB => 'revenue_attrib', \Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS_ENTRY => 'nb_conversions_entry', \Piwik\Metrics::INDEX_GOAL_REVENUE_ENTRY => 'revenue_entry');
150	protected static $metricsAggregatedFromLogs = array(\Piwik\Metrics::INDEX_NB_UNIQ_VISITORS, \Piwik\Metrics::INDEX_NB_VISITS, \Piwik\Metrics::INDEX_NB_ACTIONS, \Piwik\Metrics::INDEX_NB_USERS, \Piwik\Metrics::INDEX_MAX_ACTIONS, \Piwik\Metrics::INDEX_SUM_VISIT_LENGTH, \Piwik\Metrics::INDEX_BOUNCE_COUNT, \Piwik\Metrics::INDEX_NB_VISITS_CONVERTED);
151	public static function getMappingFromIdToName()
152	{
153	$cache = PiwikCache::getTransientCache();
154	$cacheKey = \Piwik\CacheId::siteAware(\Piwik\CacheId::pluginAware('Metrics.mappingFromIdToName'));
155	$value = $cache->fetch($cacheKey);
156	if (empty($value)) {
157	$value = self::$mappingFromIdToName;
158	/**
159	* Use this event if your plugin uses custom metric integer IDs to associate those IDs with the
160	* actual metric names (eg, 2 => nb_visits). This allows matomo to automate the replacing
161	* of IDs => metric names for your new metrics.
162	*
163	* Example
164	*
165	* public function addMetricIdToNameMapping(&$mapping)
166	* {
167	* $mapping[Archiver::INDEX_MY_NEW_METRIC] = $mapping['MyPlugin_myNewMetric'];
168	* }
169	*
170	* @ignore
171	*/
172	\Piwik\Piwik::postEvent('Metrics.addMetricIdToNameMapping', [&$value]);
173	$cache->save($cacheKey, $value);
174	}
175	return $value;
176	}
177	public static function getVisitsMetricNames()
178	{
179	$names = array();
180	foreach (self::$metricsAggregatedFromLogs as $metricId) {
181	$names[$metricId] = self::$mappingFromIdToName[$metricId];
182	}
183	return $names;
184	}
185	public static function getMappingFromNameToId()
186	{
187	static $nameToId = null;
188	if ($nameToId === null) {
189	$nameToId = array_flip(self::$mappingFromIdToName);
190	}
191	return $nameToId;
192	}
193	public static function getMappingFromNameToIdGoal()
194	{
195	static $nameToId = null;
196	if ($nameToId === null) {
197	$nameToId = array_flip(self::$mappingFromIdToNameGoal);
198	}
199	return $nameToId;
200	}
201	/**
202	* Is a lower value for a given column better?
203	* @param $column
204	* @return bool
205	*
206	* @ignore
207	*/
208	public static function isLowerValueBetter($column)
209	{
210	$isLowerBetter = null;
211	/**
212	* Use this event to define if a lower value of a metric is better.
213	*
214	* @param string $isLowerBetter should be set to a boolean indicating if lower is better
215	* @param string $column name of the column to determine
216	*
217	* Example
218	*
219	* public function checkIsLowerMetricValueBetter(&$isLowerBetter, $metric)
220	* {
221	* if ($metric === 'position') {
222	* $isLowerBetter = true;
223	* }
224	* }
225	*/
226	\Piwik\Piwik::postEvent('Metrics.isLowerValueBetter', [&$isLowerBetter, $column]);
227	if (!is_null($isLowerBetter)) {
228	return true;
229	}
230	$lowerIsBetterPatterns = array('bounce', 'exit');
231	foreach ($lowerIsBetterPatterns as $pattern) {
232	if (strpos($column, $pattern) !== false) {
233	return true;
234	}
235	}
236	return false;
237	}
238	/**
239	* Derive the unit name from a column name
240	* @param $column
241	* @param $idSite
242	* @return string
243	* @ignore
244	*/
245	public static function getUnit($column, $idSite)
246	{
247	$nameToUnit = array('_rate' => '%', 'revenue' => \Piwik\Site::getCurrencySymbolFor($idSite), '_time_' => 's');
248	$unit = null;
249	/**
250	* Use this event to define units for custom metrics used in evolution graphs and row evolution only.
251	*
252	* @param string $unit should hold the unit (e.g. %, €, s or empty string)
253	* @param string $column name of the column to determine
254	* @param string $idSite id of the current site
255	*/
256	\Piwik\Piwik::postEvent('Metrics.getEvolutionUnit', [&$unit, $column, $idSite]);
257	if (!empty($unit)) {
258	return $unit;
259	}
260	foreach ($nameToUnit as $pattern => $type) {
261	if (strpos($column, $pattern) !== false) {
262	return $type;
263	}
264	}
265	return '';
266	}
267	public static function getDefaultMetricSemanticTypes() : array
268	{
269	$cacheId = \Piwik\CacheId::pluginAware('DefaultMetricSemanticTypes');
270	$cache = PiwikCache::getTransientCache();
271	$types = $cache->fetch($cacheId);
272	if (empty($types)) {
273	$types = ['nb_visits' => Dimension::TYPE_NUMBER, 'nb_uniq_visitors' => Dimension::TYPE_NUMBER, 'nb_actions' => Dimension::TYPE_NUMBER, 'nb_users' => Dimension::TYPE_NUMBER, 'avg_time_on_page' => Dimension::TYPE_DURATION_S, 'sum_time_spent' => Dimension::TYPE_DURATION_S, 'sum_visit_length' => Dimension::TYPE_DURATION_S, 'bounce_count' => Dimension::TYPE_NUMBER, 'bounce_count_returning' => Dimension::TYPE_NUMBER, 'max_actions' => Dimension::TYPE_NUMBER, 'max_actions_returning' => Dimension::TYPE_NUMBER, 'nb_visits_converted_returning' => Dimension::TYPE_NUMBER, 'sum_visit_length_returning' => Dimension::TYPE_NUMBER, 'nb_visits_converted' => Dimension::TYPE_NUMBER, 'nb_conversions' => Dimension::TYPE_NUMBER, 'revenue' => Dimension::TYPE_MONEY, 'nb_hits' => Dimension::TYPE_NUMBER, 'entry_nb_visits' => Dimension::TYPE_NUMBER, 'entry_nb_uniq_visitors' => Dimension::TYPE_NUMBER, 'exit_nb_visits' => Dimension::TYPE_NUMBER, 'exit_nb_uniq_visitors' => Dimension::TYPE_NUMBER, 'entry_bounce_count' => Dimension::TYPE_NUMBER, 'exit_bounce_count' => Dimension::TYPE_NUMBER, 'exit_rate' => Dimension::TYPE_PERCENT, 'sum_daily_nb_uniq_visitors' => Dimension::TYPE_NUMBER, 'sum_daily_nb_users' => Dimension::TYPE_NUMBER, 'sum_daily_entry_nb_uniq_visitors' => Dimension::TYPE_NUMBER, 'sum_daily_exit_nb_uniq_visitors' => Dimension::TYPE_NUMBER, 'entry_nb_actions' => Dimension::TYPE_NUMBER, 'entry_sum_visit_length' => Dimension::TYPE_NUMBER, 'nb_actions_per_visit' => Dimension::TYPE_NUMBER, 'avg_time_on_site' => Dimension::TYPE_DURATION_S, 'bounce_rate' => Dimension::TYPE_PERCENT, 'conversion_rate' => Dimension::TYPE_PERCENT];
274	/**
275	* Use this event to notify Matomo of the semantic types of metrics your plugin adds.
276	*
277	* A metric's semantic type is metadata used primarily in integrations with Matomo
278	* and third party services/applications. It provides information that can be used
279	* to determine how to display or use the information.
280	*
281	* It is recommended for your plugin to provide this information so users of third
282	* party services that connect with Matomo can make full use of the data your plugin
283	* tracks.
284	*
285	* See {@link Metrics} for the list of available semantic types.
286	*
287	* @param string $types The array mapping of metric_name => metric semantic type
288	*/
289	\Piwik\Piwik::postEvent('Metrics.getDefaultMetricSemanticTypes', [&$types]);
290	$cache->save($cacheId, $types);
291	}
292	return $types;
293	}
294	public static function getDefaultMetricTranslations()
295	{
296	$cacheId = \Piwik\CacheId::pluginAware('DefaultMetricTranslations');
297	$cache = PiwikCache::getTransientCache();
298	if ($cache->contains($cacheId)) {
299	return $cache->fetch($cacheId);
300	}
301	$translations = array('label' => 'General_ColumnLabel', 'date' => 'General_Date', 'avg_time_on_page' => 'General_ColumnAverageTimeOnPage', 'sum_time_spent' => 'General_ColumnSumVisitLength', 'sum_visit_length' => 'General_ColumnSumVisitLength', 'bounce_count' => 'General_ColumnBounces', 'bounce_count_returning' => 'VisitFrequency_ColumnBounceCountForReturningVisits', 'max_actions' => 'General_ColumnMaxActions', 'max_actions_returning' => 'VisitFrequency_ColumnMaxActionsInReturningVisit', 'nb_visits_converted_returning' => 'VisitFrequency_ColumnNbReturningVisitsConverted', 'sum_visit_length_returning' => 'VisitFrequency_ColumnSumVisitLengthReturning', 'nb_visits_converted' => 'General_ColumnVisitsWithConversions', 'nb_conversions' => 'Goals_ColumnConversions', 'revenue' => 'General_ColumnRevenue', 'nb_hits' => 'General_ColumnPageviews', 'entry_nb_visits' => 'General_ColumnEntrances', 'entry_nb_uniq_visitors' => 'General_ColumnUniqueEntrances', 'exit_nb_visits' => 'General_ColumnExits', 'exit_nb_uniq_visitors' => 'General_ColumnUniqueExits', 'entry_bounce_count' => 'General_ColumnBounces', 'exit_bounce_count' => 'General_ColumnBounces', 'exit_rate' => 'General_ColumnExitRate');
302	$dailySum = ' (' . \Piwik\Piwik::translate('General_DailySum') . ')';
303	$afterEntry = ' ' . \Piwik\Piwik::translate('General_AfterEntry');
304	$translations['sum_daily_nb_uniq_visitors'] = \Piwik\Piwik::translate('General_ColumnNbUniqVisitors') . $dailySum;
305	$translations['sum_daily_nb_users'] = \Piwik\Piwik::translate('General_ColumnNbUsers') . $dailySum;
306	$translations['sum_daily_entry_nb_uniq_visitors'] = \Piwik\Piwik::translate('General_ColumnUniqueEntrances') . $dailySum;
307	$translations['sum_daily_exit_nb_uniq_visitors'] = \Piwik\Piwik::translate('General_ColumnUniqueExits') . $dailySum;
308	$translations['entry_nb_actions'] = \Piwik\Piwik::translate('General_ColumnNbActions') . $afterEntry;
309	$translations['entry_sum_visit_length'] = \Piwik\Piwik::translate('General_ColumnSumVisitLength') . $afterEntry;
310	$translations = array_merge(self::getDefaultMetrics(), self::getDefaultProcessedMetrics(), $translations);
311	/**
312	* Use this event to register translations for metrics processed by your plugin.
313	*
314	* @param string $translations The array mapping of column_name => Plugin_TranslationForColumn
315	*/
316	\Piwik\Piwik::postEvent('Metrics.getDefaultMetricTranslations', array(&$translations));
317	$translations = array_map(array('\\Piwik\\Piwik', 'translate'), $translations);
318	$cache->save($cacheId, $translations);
319	return $translations;
320	}
321	public static function getDefaultMetrics()
322	{
323	$cacheId = \Piwik\CacheId::languageAware('DefaultMetrics');
324	$cache = PiwikCache::getTransientCache();
325	if ($cache->contains($cacheId)) {
326	return $cache->fetch($cacheId);
327	}
328	$translations = array('nb_visits' => 'General_ColumnNbVisits', 'nb_uniq_visitors' => 'General_ColumnNbUniqVisitors', 'nb_actions' => 'General_ColumnNbActions', 'nb_users' => 'General_ColumnNbUsers');
329	$translations = array_map(array('\\Piwik\\Piwik', 'translate'), $translations);
330	$cache->save($cacheId, $translations);
331	return $translations;
332	}
333	public static function getDefaultProcessedMetrics()
334	{
335	$cacheId = \Piwik\CacheId::languageAware('DefaultProcessedMetrics');
336	$cache = PiwikCache::getTransientCache();
337	if ($cache->contains($cacheId)) {
338	return $cache->fetch($cacheId);
339	}
340	$translations = array(
341	// Processed in AddColumnsProcessedMetrics
342	'nb_actions_per_visit' => 'General_ColumnActionsPerVisit',
343	'avg_time_on_site' => 'General_ColumnAvgTimeOnSite',
344	'bounce_rate' => 'General_ColumnBounceRate',
345	'conversion_rate' => 'General_ColumnConversionRate',
346	);
347	$translations = array_map(array('\\Piwik\\Piwik', 'translate'), $translations);
348	$cache->save($cacheId, $translations);
349	return $translations;
350	}
351	public static function getReadableColumnName($columnIdRaw)
352	{
353	$mappingIdToName = self::$mappingFromIdToName;
354	if (array_key_exists($columnIdRaw, $mappingIdToName)) {
355	return $mappingIdToName[$columnIdRaw];
356	}
357	return $columnIdRaw;
358	}
359	public static function getMetricIdsToProcessReportTotal()
360	{
361	return array(self::INDEX_NB_VISITS, self::INDEX_NB_UNIQ_VISITORS, self::INDEX_NB_ACTIONS, self::INDEX_PAGE_NB_HITS, self::INDEX_NB_VISITS_CONVERTED, self::INDEX_NB_CONVERSIONS, self::INDEX_BOUNCE_COUNT, self::INDEX_PAGE_ENTRY_BOUNCE_COUNT, self::INDEX_PAGE_ENTRY_NB_VISITS, self::INDEX_PAGE_ENTRY_NB_ACTIONS, self::INDEX_PAGE_EXIT_NB_VISITS, self::INDEX_PAGE_EXIT_NB_UNIQ_VISITORS, self::INDEX_REVENUE);
362	}
363	public static function getDefaultMetricsDocumentation()
364	{
365	$cacheId = \Piwik\CacheId::pluginAware('DefaultMetricsDocumentation');
366	$cache = PiwikCache::getTransientCache();
367	if ($cache->contains($cacheId)) {
368	return $cache->fetch($cacheId);
369	}
370	$translations = array('nb_visits' => 'General_ColumnNbVisitsDocumentation', 'nb_uniq_visitors' => 'General_ColumnNbUniqVisitorsDocumentation', 'nb_actions' => 'General_ColumnNbActionsDocumentation', 'nb_users' => 'General_ColumnNbUsersDocumentation', 'nb_actions_per_visit' => 'General_ColumnActionsPerVisitDocumentation', 'avg_time_on_site' => 'General_ColumnAvgTimeOnSiteDocumentation', 'bounce_rate' => 'General_ColumnBounceRateDocumentation', 'conversion_rate' => 'General_ColumnConversionRateDocumentation', 'avg_time_on_page' => 'General_ColumnAverageTimeOnPageDocumentation', 'nb_hits' => 'General_ColumnPageviewsDocumentation', 'exit_rate' => 'General_ColumnExitRateDocumentation');
371	/**
372	* Use this event to register translations for metrics documentation processed by your plugin.
373	*
374	* @param string[] $translations The array mapping of column_name => Plugin_TranslationForColumnDocumentation
375	*/
376	\Piwik\Piwik::postEvent('Metrics.getDefaultMetricDocumentationTranslations', array(&$translations));
377	$translations = array_map(array('\\Piwik\\Piwik', 'translate'), $translations);
378	$cache->save($cacheId, $translations);
379	return $translations;
380	}
381	public static function getPercentVisitColumn()
382	{
383	$percentVisitsLabel = str_replace(' ', ' ', \Piwik\Piwik::translate('General_ColumnPercentageVisits'));
384	return $percentVisitsLabel;
385	}
386	/**
387	* This is a utility method used when building records through log aggregation.
388	*
389	* In records with per-goal conversion metrics the metrics are stored within DataTable Rows
390	* as a column with an array a value. The array is indexed by the goal ID and the column name
391	* is set to `Metrics::INDEX_GOALS`, for example:
392	*
393	* ```
394	* $columns = [
395	* Metrics::INDEX_GOALS = [
396	* $idGoal => [
397	* // ... conversion metrics ...
398	* ],
399	* ],
400	* ];
401	* $row = new Row([DataTable::COLUMNS => $columns]);
402	* ```
403	*
404	* This methods returns an array like `$columns` above based on a goal ID and a row of
405	* metric values for the goal. The result can be added directly to a DataTable record via `sumRowWithLabel()`.
406	*
407	* The goal metrics returned will differ based on whether the goal is user defined or an ecommerce goal.
408	*
409	* @param int $idGoal
410	* @param array $goalsMetrics
411	* @return array
412	*/
413	public static function makeGoalColumnsRow(int $idGoal, array $goalsMetrics) : array
414	{
415	if ($idGoal > GoalManager::IDGOAL_ORDER) {
416	// user defined goal
417	$columns = [\Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS, \Piwik\Metrics::INDEX_GOAL_NB_VISITS_CONVERTED, \Piwik\Metrics::INDEX_GOAL_REVENUE];
418	} else {
419	if ($idGoal == GoalManager::IDGOAL_ORDER) {
420	// ecommerce order
421	$columns = [\Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS, \Piwik\Metrics::INDEX_GOAL_NB_VISITS_CONVERTED, \Piwik\Metrics::INDEX_GOAL_REVENUE, \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SUBTOTAL, \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_TAX, \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_SHIPPING, \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_REVENUE_DISCOUNT, \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_ITEMS];
422	} else {
423	// idGoal == GoalManager::IDGOAL_CART (abandoned cart)
424	$columns = [\Piwik\Metrics::INDEX_GOAL_NB_CONVERSIONS, \Piwik\Metrics::INDEX_GOAL_NB_VISITS_CONVERTED, \Piwik\Metrics::INDEX_GOAL_REVENUE, \Piwik\Metrics::INDEX_GOAL_ECOMMERCE_ITEMS];
425	}
426	}
427	$values = [];
428	foreach ($columns as $column) {
429	$values[$column] = (float) ($goalsMetrics[$column] ?? 0);
430	}
431	return $values;
432	}
433	}
434