Allow to provide secondary sort column for reports (#12128)

* Allow to provide secondy sort column for reports

* rename method

* Adds two simple tests to prove secondary column sorting

* invoke sort callback with datatable as second parameter

1 files changed, 24 insertions, 3 deletions

diff --git a/core/Plugin/Report.php b/core/Plugin/Report.php
index c300ad11a3..e0850586d9 100644
--- a/core/Plugin/Report.php
+++ b/core/Plugin/Report.php
@@ -10,16 +10,13 @@ namespace Piwik\Plugin;
 
 use Piwik\API\Proxy;
 use Piwik\API\Request;
-use Piwik\Cache;
 use Piwik\Columns\Dimension;
 use Piwik\Common;
 use Piwik\DataTable;
 use Piwik\DataTable\Filter\Sort;
 use Piwik\Metrics;
-use Piwik\Cache as PiwikCache;
 use Piwik\Piwik;
 use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
-use Piwik\Plugins\CoreVisualizations\Visualizations\JqplotGraph\Evolution;
 use Piwik\ViewDataTable\Factory as ViewDataTableFactory;
 use Exception;
 use Piwik\Widget\WidgetsList;
@@ -649,6 +646,30 @@ class Report
     }
 
     /**
+     * Allows to define a callback that will be used to determine the secondary column to sort by
+     *
+     * ```
+     * public function getSecondarySortColumnCallback()
+     * {
+     *     return function ($primaryColumn) {
+     *         switch ($primaryColumn) {
+     *             case Metrics::NB_CLICKS:
+     *                 return Metrics::NB_IMPRESSIONS;
+     *             case 'label':
+     *             default:
+     *                 return Metrics::NB_CLICKS;
+     *         }
+     *     };
+     * }
+     * ```
+     * @return null|callable
+     */
+    public function getSecondarySortColumnCallback()
+    {
+        return null;
+    }
+
+    /**
      * Get the list of related reports if there are any. They will be displayed for instance below a report as a
      * recommended related report.
      *