Refs #1485 Better reports/column order in Metadata response + fixing …

…small issues with metadata
matomo-org · Jul 28, 2010 · c82186c · c82186c
1 parent d018813
commit c82186c
Show file tree

Hide file tree

Showing 17 changed files with 310 additions and 304 deletions.
diff --git a/lang/en.php b/lang/en.php
@@ -1158,6 +1158,7 @@
 	'VisitTime_SubmenuTimes' => 'Times',
 	'VisitTime_NHour' => '%sh',
 	'Widgetize_PluginDescription' => 'The plugin makes it very easy to export any Piwik Widget in your Blog, Website or on Igoogle and Netvibes!',
+	'PDFReports_PluginDescription' => 'Create and download your custom PDF reports, and have them emailed daily, weekly or monthly.',
 	'PDFReports_ManagePdfReports' => 'Manage PDF Reports',
 	'PDFReports_PDF' => 'PDF',
 	'PDFReports_EmailSchedule' => 'Email Schedule',

diff --git a/plugins/API/API.php b/plugins/API/API.php
@@ -72,8 +72,8 @@ public function getDefaultMetrics()
 	{
 		$translations = array(
 			// Standard metrics
-    		'nb_uniq_visitors' => 'General_ColumnNbUniqVisitors',
     		'nb_visits' => 'General_ColumnNbVisits',
+    		'nb_uniq_visitors' => 'General_ColumnNbUniqVisitors',
     		'nb_actions' => 'General_ColumnNbActions',
 // Do not display these in reports, as they are not so relevant
 // They are used to process metrics below
@@ -145,7 +145,6 @@ public function getReportMetadata($idSites = false)
 
 		$availableReports = array();
 		Piwik_PostEvent('API.getReportMetadata', $availableReports, $idSites);
-
 		foreach ($availableReports as &$availableReport) {
 			if (!isset($availableReport['metrics'])) {
 				$availableReport['metrics'] = $this->getDefaultMetrics();
@@ -199,10 +198,8 @@ public function getReportMetadata($idSites = false)
 			}
 			$availableReport['uniqueId'] = $uniqueId;
 		}
-
 		// Sort results to ensure consistent order
-		usort($availableReports, array($this, "sort"));
-
+		ksort($availableReports);
 		return $availableReports;
 	}
 

diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php
@@ -62,7 +62,7 @@ public function getReportMetadata($notification)
 		$metrics = 
 
 		// Page views URLs, Downloads and Outlinks have the full set of metrics
-		$reports[] = array(
+		$reports[$priority = 100] = array(
 			'category' => Piwik_Translate('Actions_Actions'),
 			'name' => Piwik_Translate('Actions_SubmenuPages'),
 			'module' => 'Actions',
@@ -84,8 +84,7 @@ public function getReportMetadata($notification)
 		// Page titles, downloads and outlinks only report basic metrics
 		$metrics = array(	'nb_hits' => Piwik_Translate('General_ColumnPageviews'),
             				'nb_visits',
-            				'nb_uniq_visitors',
-		);
+    	);
 		$reports[] = array(
 			'category' => Piwik_Translate('Actions_Actions'),
 			'name' => Piwik_Translate('Actions_SubmenuOutlinks'),
@@ -104,7 +103,10 @@ public function getReportMetadata($notification)
 			'metrics' => $metrics,
 			'processedMetrics' => false,
 		);
-
+		// Downloads and outlinks don't have nb_uniq_visitors metrics
+		// But Page title report does
+		$metrics[] = 'nb_uniq_visitors';
+
 		$reports[] = array(
 			'category' => Piwik_Translate('Actions_Actions'),
 			'name' => Piwik_Translate('Actions_SubmenuPageTitles'),
@@ -114,6 +116,7 @@ public function getReportMetadata($notification)
 			'metrics' => $metrics,
 			'processedMetrics' => false,
 		);
+
 	}
 
 	function addWidgets()

diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php
@@ -71,7 +71,7 @@ public function getReportMetadata($notification)
 		);
 
 		// General Goal metrics: conversions, conv rate, revenue
-		$reports[] = array(
+		$reports[$priority = 300] = array(
 			'category' => Piwik_Translate('Goals_Goals'),
 			'name' => Piwik_Translate('Goals_Goals'),
 			'module' => 'Goals',
@@ -106,12 +106,14 @@ public function getReportMetadata($notification)
 		if(count($idSites) == 1)
 		{
 			$goals = Piwik_Goals_API::getInstance()->getGoals(reset($idSites));
+			$count = 0;
 			foreach($goals as $goal) 
 			{
 				// Add the general Goal metrics: ie. total Goal conversions, 
 				// Goal conv rate or Goal total revenue.
 				// This API call requires a custom parameter
-				$reports[] = array(
+				$priority = 160 + $count;
+				$reports[$priority] = array(
 					'category' => Piwik_Translate('Goals_Goals'),
 					'name' => Piwik_Translate('Goals_GoalX', $goal['name']),
 					'module' => 'Goals',
@@ -120,6 +122,7 @@ public function getReportMetadata($notification)
 					'metrics' => $goalMetrics,
 					'processedMetrics' => false,
 				);
+				$count++;
 			}
 		}
 	}

diff --git a/plugins/PDFReports/templates/add.tpl b/plugins/PDFReports/templates/add.tpl
@@ -1,4 +1,4 @@
-<div id='entityAddContainer'>
+<div id='entityAddContainer' style='display:none'>
 <div class='entityCancel'>
 	{'PDFReports_CancelAndReturnToPDF'|translate:"<a class='entityCancelLink'>":"</a>"}
 </div>

diff --git a/plugins/Provider/Provider.php b/plugins/Provider/Provider.php
@@ -45,7 +45,7 @@ public function getListHooksRegistered()
 	public function getReportMetadata($notification)
 	{
 		$reports = &$notification->getNotificationObject();
-		$reports[] = array(
+		$reports[$priority = 40] = array(
 			'category' => Piwik_Translate('Provider_WidgetProviders'),
 			'name' => Piwik_Translate('Provider_ColumnProvider'),
 			'module' => 'Provider',

diff --git a/plugins/Referers/Referers.php b/plugins/Referers/Referers.php
@@ -50,7 +50,7 @@ public function getReportMetadata($notification)
 	{
 		$reports = &$notification->getNotificationObject();
 		$reports = array_merge($reports, array(
-        		array(
+        		$priority = 200 => array(
         			'category'  => Piwik_Translate('Referers_Referers'),
         			'name'   => Piwik_Translate('Referers_Type'),
         			'module' => 'Referers',

diff --git a/plugins/UserCountry/UserCountry.php b/plugins/UserCountry/UserCountry.php
@@ -44,15 +44,15 @@ function getListHooksRegistered()
 	public function getReportMetadata($notification) 
 	{
 		$reports = &$notification->getNotificationObject();
-		$reports[] = array(
+		$reports[$priority = 20] = array(
 			'category' => Piwik_Translate('General_Visitors'),
 			'name' => Piwik_Translate('UserCountry_Country'),
 			'module' => 'UserCountry',
 			'action' => 'getCountry',
 			'dimension' => Piwik_Translate('UserCountry_Country'),
 		);
 
-		$reports[] = array(
+		$reports[$priority = 21] = array(
 			'category' => Piwik_Translate('General_Visitors'),
 			'name' => Piwik_Translate('UserCountry_Continent'),
 			'module' => 'UserCountry',

diff --git a/plugins/UserSettings/UserSettings.php b/plugins/UserSettings/UserSettings.php
@@ -74,6 +74,8 @@ function getListHooksRegistered()
 	public function getReportMetadata($notification) 
 	{
 		$reports = &$notification->getNotificationObject();
+
+		$count = 0;
 		foreach($this->reportMetadata as $report)
 		{
 			list( $category, $name, $apiModule, $apiAction, $columnName ) = $report;
@@ -95,7 +97,9 @@ public function getReportMetadata($notification)
     			// There is no processedMetrics for this report
 				$report['processedMetrics'] = array();
     		}
-    		$reports[] = $report;
+    		$priority = 30 + $count;
+    		$reports[$priority] = $report;
+    		$count++;
 		}
 	}
 

diff --git a/plugins/VisitFrequency/VisitFrequency.php b/plugins/VisitFrequency/VisitFrequency.php
@@ -43,7 +43,7 @@ function getListHooksRegistered()
 	public function getReportMetadata($notification) 
 	{
 		$reports = &$notification->getNotificationObject();
-		$reports[] = array(
+		$reports[$priority = 60] = array(
 			'category' => Piwik_Translate('General_Visitors'),
 			'name' => Piwik_Translate('VisitFrequency_ColumnReturningVisits'),
 			'module' => 'VisitFrequency',

diff --git a/plugins/VisitTime/VisitTime.php b/plugins/VisitTime/VisitTime.php
@@ -43,15 +43,15 @@ function getListHooksRegistered()
 	public function getReportMetadata($notification) 
 	{
 		$reports = &$notification->getNotificationObject();
-		$reports[] = array(
+		$reports[$priority = 80] = array(
 			'category' => Piwik_Translate('VisitsSummary_VisitsSummary'),
 			'name' => Piwik_Translate('VisitTime_WidgetLocalTime'),
 			'module' => 'VisitTime',
 			'action' => 'getVisitInformationPerLocalTime',
 			'dimension' => Piwik_Translate('VisitTime_ColumnLocalTime'),
 		);
 
-		$reports[] = array(
+		$reports[$priority = 81] = array(
 			'category' => Piwik_Translate('VisitsSummary_VisitsSummary'),
 			'name' => Piwik_Translate('VisitTime_WidgetServerTime'),
 			'module' => 'VisitTime',

diff --git a/plugins/VisitorInterest/VisitorInterest.php b/plugins/VisitorInterest/VisitorInterest.php
@@ -43,7 +43,7 @@ function getListHooksRegistered()
 	public function getReportMetadata($notification) 
 	{
 		$reports = &$notification->getNotificationObject();
-		$reports[] = array(
+		$reports[$priority = 70] = array(
 			'category' => Piwik_Translate('General_Visitors'),
 			'name' => Piwik_Translate('VisitorInterest_WidgetLengths'),
 			'module' => 'VisitorInterest',
@@ -53,7 +53,7 @@ public function getReportMetadata($notification)
 			'processedMetrics' => false,
 		);
 
-		$reports[] = array(
+		$reports[$priority = 71] = array(
 			'category' => Piwik_Translate('General_Visitors'),
 			'name' => Piwik_Translate('VisitorInterest_WidgetPages'),
 			'module' => 'VisitorInterest',

diff --git a/plugins/VisitsSummary/VisitsSummary.php b/plugins/VisitsSummary/VisitsSummary.php
@@ -44,7 +44,7 @@ function getListHooksRegistered()
 	public function getReportMetadata($notification) 
 	{
 		$reports = &$notification->getNotificationObject();
-		$reports[] = array(
+		$reports[$priority = 10] = array(
 			'category' => Piwik_Translate('VisitsSummary_VisitsSummary'),
 			'name' => Piwik_Translate('VisitsSummary_VisitsSummary'),
 			'module' => 'VisitsSummary',

diff --git a/tests/integration/expected/test_apiGetReportMetadata__API.getDefaultMetrics.xml b/tests/integration/expected/test_apiGetReportMetadata__API.getDefaultMetrics.xml
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <result>
 	<row>
-		<nb_uniq_visitors>Unique visitors</nb_uniq_visitors>
 		<nb_visits>Visits</nb_visits>
+		<nb_uniq_visitors>Unique visitors</nb_uniq_visitors>
 		<nb_actions>Actions</nb_actions>
 	</row>
 </result>
diff --git a/tests/integration/expected/test_apiGetReportMetadata__API.getMetadata.xml b/tests/integration/expected/test_apiGetReportMetadata__API.getMetadata.xml
@@ -7,8 +7,8 @@
 		<action>getCountry</action>
 		<dimension>Country</dimension>
 		<metrics>
-			<nb_uniq_visitors>Unique visitors</nb_uniq_visitors>
 			<nb_visits>Visits</nb_visits>
+			<nb_uniq_visitors>Unique visitors</nb_uniq_visitors>
 			<nb_actions>Actions</nb_actions>
 
 		</metrics>

diff --git a/tests/integration/expected/test_apiGetReportMetadata__API.getProcessedReport_day.xml b/tests/integration/expected/test_apiGetReportMetadata__API.getProcessedReport_day.xml
@@ -9,8 +9,8 @@
 		<action>getCountry</action>
 		<dimension>Country</dimension>
 		<metrics>
-			<nb_uniq_visitors>Unique visitors</nb_uniq_visitors>
 			<nb_visits>Visits</nb_visits>
+			<nb_uniq_visitors>Unique visitors</nb_uniq_visitors>
 			<nb_actions>Actions</nb_actions>
 
 		</metrics>
@@ -36,8 +36,8 @@
 	</metadata>
 	<columns>
 		<label>Country</label>
-		<nb_uniq_visitors>Unique visitors</nb_uniq_visitors>
 		<nb_visits>Visits</nb_visits>
+		<nb_uniq_visitors>Unique visitors</nb_uniq_visitors>
 		<nb_actions>Actions</nb_actions>
 		<nb_actions_per_visit>Actions per Visit</nb_actions_per_visit>
 		<avg_time_on_site>Avg. Time on Website</avg_time_on_site>