allow reports to specify that they have goal specific metrics (for so…

…me or all goals), but not the overall goal sum metrics provided by EnrichRecordWithGoalMetricSums
matomo-org · Jun 3, 2024 · b4d1125 · b4d1125
1 parent 6cf6e7d
commit b4d1125
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 8 deletions.
diff --git a/core/Plugin/Report.php b/core/Plugin/Report.php
@@ -132,6 +132,19 @@ class Report
      */
     protected $hasGoalMetrics = false;
 
+    /**
+     * Set this property to true if your report supports goal metrics, but does not also include overall summed goal
+     * metrics (total conversions and total revenue across all goals).
+     *
+     * By default, Matomo assumes reports that set {@see self::$hasGoalMetrics} to `true` provide these overall
+     * metrics, but some reports are not able to compute them.
+     *
+     * Only used if {@see self::$hasGoalMetrics} is true.
+     * @var bool
+     * @api
+     */
+    protected $hasGoalSumMetrics = true;
+
     /**
      * Set this property to false in case your report can't/shouldn't be flattened.
      * In this case, flattener won't be applied even if parameter is provided in a request
@@ -593,6 +606,15 @@ public function hasGoalMetrics()
         return $this->hasGoalMetrics;
     }
 
+    /**
+     * @return bool
+     * @ignore
+     */
+    public function hasGoalSumMetrics()
+    {
+        return $this->hasGoalSumMetrics;
+    }
+
     /**
      * @return bool
      * @ignore

diff --git a/plugins/Actions/Reports/GetEntryPageTitles.php b/plugins/Actions/Reports/GetEntryPageTitles.php
@@ -41,6 +41,7 @@ protected function init()
         $this->actionToLoadSubTables = $this->action;
         $this->subcategoryId = 'Actions_SubmenuPagesEntry';
         $this->hasGoalMetrics = true;
+        $this->hasGoalSumMetrics = false;
     }
 
     public function configureWidgets(WidgetsList $widgetsList, ReportWidgetFactory $factory)

diff --git a/plugins/Actions/Reports/GetEntryPageUrls.php b/plugins/Actions/Reports/GetEntryPageUrls.php
@@ -41,6 +41,7 @@ protected function init()
         $this->actionToLoadSubTables = $this->action;
         $this->subcategoryId = 'Actions_SubmenuPagesEntry';
         $this->hasGoalMetrics = true;
+        $this->hasGoalSumMetrics = false;
     }
 
     public function getProcessedMetrics()

diff --git a/plugins/Actions/Reports/GetPageTitles.php b/plugins/Actions/Reports/GetPageTitles.php
@@ -45,6 +45,7 @@ protected function init()
         $this->actionToLoadSubTables = $this->action;
         $this->subcategoryId = 'Actions_SubmenuPageTitles';
         $this->hasGoalMetrics = true;
+        $this->hasGoalSumMetrics = false;
     }
 
     public function getMetrics()

diff --git a/plugins/Actions/Reports/GetPageUrls.php b/plugins/Actions/Reports/GetPageUrls.php
@@ -44,6 +44,7 @@ protected function init()
 
         $this->subcategoryId = 'General_Pages';
         $this->hasGoalMetrics = true;
+        $this->hasGoalSumMetrics = false;
     }
 
     public function configureWidgets(WidgetsList $widgetsList, ReportWidgetFactory $factory)

diff --git a/plugins/CustomDimensions/CustomDimensions.php b/plugins/CustomDimensions/CustomDimensions.php
@@ -64,7 +64,8 @@ public function getReportsWithGoalMetrics(&$reportsWithGoals)
                 'name'     => $dimension['name'],
                 'module'   => $this->pluginName,
                 'action'   => 'getCustomDimension',
-                'parameters' => array('idDimension' => $dimension['idcustomdimension'])
+                'parameters' => array('idDimension' => $dimension['idcustomdimension']),
+                'hasGoalSumMetrics' => true,
             );
         }
     }

diff --git a/plugins/Goals/Goals.php b/plugins/Goals/Goals.php
@@ -387,14 +387,18 @@ public function getReportMetadataEnd(&$reports, $info)
                     && empty($apiReportToUpdate['parameters'])
                 ) {
                     // add overall Goal metrics computed during archiving by EnrichRecordWithGoalMetricSums
-                    $apiReportToUpdate['metrics']['nb_conversions'] = $goalMetrics['nb_conversions'];
-                    $apiReportToUpdate['metrics']['revenue'] = $goalMetrics['revenue'];
+                    if (!isset($reportsWithGoals['hasGoalSumMetrics'])
+                        || $reportWithGoals['hasGoalSumMetrics']
+                    ) {
+                        $apiReportToUpdate['metrics']['nb_conversions'] = $goalMetrics['nb_conversions'];
+                        $apiReportToUpdate['metrics']['revenue'] = $goalMetrics['revenue'];
 
-                    $apiReportToUpdate['metricsDocumentation']['nb_conversions'] = $conversionDocsTranslation;
-                    $apiReportToUpdate['metricsDocumentation']['revenue'] = $revenueDocsTranslation;
+                        $apiReportToUpdate['metricsDocumentation']['nb_conversions'] = $conversionDocsTranslation;
+                        $apiReportToUpdate['metricsDocumentation']['revenue'] = $revenueDocsTranslation;
 
-                    $apiReportToUpdate['metricTypes']['nb_conversions'] = Dimension::TYPE_NUMBER;
-                    $apiReportToUpdate['metricTypes']['revenue'] = Dimension::TYPE_MONEY;
+                        $apiReportToUpdate['metricTypes']['nb_conversions'] = Dimension::TYPE_NUMBER;
+                        $apiReportToUpdate['metricTypes']['revenue'] = Dimension::TYPE_MONEY;
+                    }
 
                     $apiReportToUpdate['metricsGoal'] = $goalMetricsToUse;
                     $apiReportToUpdate['processedMetricsGoal'] = $goalProcessedMetricsToUse;
@@ -418,7 +422,8 @@ private static function getAllReportsWithGoalMetrics()
                     'name'     => $report->getName(),
                     'module'   => $report->getModule(),
                     'action'   => $report->getAction(),
-                    'parameters' => $report->getParameters()
+                    'parameters' => $report->getParameters(),
+                    'hasGoalSumMetrics' => $report->hasGoalSumMetrics(),
                 );
             }
         }