Refs #4040, converted VisitorInterest plugin to use display properties instead of ViewDataTable methods.

2 files changed, 90 insertions, 59 deletions

diff --git a/plugins/VisitorInterest/Controller.php b/plugins/VisitorInterest/Controller.php
index e2b9936c7f..588b98b7fc 100644
--- a/plugins/VisitorInterest/Controller.php
+++ b/plugins/VisitorInterest/Controller.php
@@ -26,37 +26,12 @@ class Piwik_VisitorInterest_Controller extends Piwik_Controller
 
     public function getNumberOfVisitsPerVisitDuration($fetch = false)
     {
-        $view = Piwik_ViewDataTable::factory('cloud');
-        $view->init($this->pluginName, __FUNCTION__, "VisitorInterest.getNumberOfVisitsPerVisitDuration");
-
-        $view->setColumnsToDisplay(array('label', 'nb_visits'));
-        $view->setSortedColumn('label', 'asc');
-        $view->setColumnTranslation('label', Piwik_Translate('VisitorInterest_ColumnVisitDuration'));
-        $view->setGraphLimit(10);
-        $view->disableSort();
-        $view->disableExcludeLowPopulation();
-        $view->disableOffsetInformationAndPaginationControls();
-        $view->disableSearchBox();
-        $view->disableShowAllColumns();
-
-        return $this->renderView($view, $fetch);
+        return Piwik_ViewDataTable::render($this->pluginName, __FUNCTION__, $fetch);
     }
 
     public function getNumberOfVisitsPerPage($fetch = false)
     {
-        $view = Piwik_ViewDataTable::factory('cloud');
-        $view->init($this->pluginName, __FUNCTION__, "VisitorInterest.getNumberOfVisitsPerPage");
-        $view->setColumnsToDisplay(array('label', 'nb_visits'));
-        $view->setSortedColumn('label', 'asc');
-        $view->setColumnTranslation('label', Piwik_Translate('VisitorInterest_ColumnPagesPerVisit'));
-        $view->setGraphLimit(10);
-        $view->disableExcludeLowPopulation();
-        $view->disableOffsetInformationAndPaginationControls();
-        $view->disableSearchBox();
-        $view->disableSort();
-        $view->disableShowAllColumns();
-
-        return $this->renderView($view, $fetch);
+        return Piwik_ViewDataTable::render($this->pluginName, __FUNCTION__, $fetch);
     }
 
     /**
@@ -68,21 +43,7 @@ class Piwik_VisitorInterest_Controller extends Piwik_Controller
      */
     public function getNumberOfVisitsByVisitCount($fetch = false)
     {
-        $view = Piwik_ViewDataTable::factory();
-        $view->init($this->pluginName, __FUNCTION__, "VisitorInterest.getNumberOfVisitsByVisitCount");
-        $view->setColumnsToDisplay(array('label', 'nb_visits', 'nb_visits_percentage'));
-        $view->setSortedColumn('label', 'asc');
-        $view->setColumnTranslation('label', Piwik_Translate('VisitorInterest_VisitNum'));
-        $view->setColumnTranslation('nb_visits_percentage', Piwik_Metrics::getPercentVisitColumn());
-        $view->disableExcludeLowPopulation();
-        $view->disableOffsetInformationAndPaginationControls();
-        $view->disableShowAllViewsIcons();
-        $view->setLimit(15);
-        $view->disableSearchBox();
-        $view->disableSort();
-        $view->disableShowAllColumns();
-
-        return $this->renderView($view, $fetch);
+        return Piwik_ViewDataTable::render($this->pluginName, __FUNCTION__, $fetch);
     }
 
     /**
@@ -94,19 +55,6 @@ class Piwik_VisitorInterest_Controller extends Piwik_Controller
      */
     public function getNumberOfVisitsByDaysSinceLast($fetch = false)
     {
-        $view = Piwik_ViewDataTable::factory();
-        $view->init($this->pluginName, __FUNCTION__, 'VisitorInterest.getNumberOfVisitsByDaysSinceLast');
-        $view->setColumnsToDisplay(array('label', 'nb_visits'));
-        $view->setSortedColumn('label', 'asc');
-        $view->setColumnTranslation('label', Piwik_Translate('General_DaysSinceLastVisit'));
-        $view->disableExcludeLowPopulation();
-        $view->disableOffsetInformationAndPaginationControls();
-        $view->disableShowAllViewsIcons();
-        $view->setLimit(15);
-        $view->disableSearchBox();
-        $view->disableSort();
-        $view->disableShowAllColumns();
-
-        return $this->renderView($view, $fetch);
+        return Piwik_ViewDataTable::render($this->pluginName, __FUNCTION__, $fetch);
     }
 }
diff --git a/plugins/VisitorInterest/VisitorInterest.php b/plugins/VisitorInterest/VisitorInterest.php
index 10231517e1..6a65f9c0f9 100644
--- a/plugins/VisitorInterest/VisitorInterest.php
+++ b/plugins/VisitorInterest/VisitorInterest.php
@@ -26,6 +26,7 @@ class Piwik_VisitorInterest extends Piwik_Plugin
             'WidgetsList.add'                  => 'addWidgets',
             'Menu.add'                         => 'addMenu',
             'API.getReportMetadata'            => 'getReportMetadata',
+            'ViewDataTable.getReportDisplayProperties' => 'getReportDisplayProperties',
         );
         return $hooks;
     }
@@ -91,7 +92,7 @@ class Piwik_VisitorInterest extends Piwik_Plugin
         );
     }
 
-    function addWidgets()
+    public function addWidgets()
     {
         Piwik_AddWidget('General_Visitors', 'VisitorInterest_WidgetLengths', 'VisitorInterest', 'getNumberOfVisitsPerVisitDuration');
         Piwik_AddWidget('General_Visitors', 'VisitorInterest_WidgetPages', 'VisitorInterest', 'getNumberOfVisitsPerPage');
@@ -99,7 +100,7 @@ class Piwik_VisitorInterest extends Piwik_Plugin
         Piwik_AddWidget('General_Visitors', 'VisitorInterest_WidgetVisitsByDaysSinceLast', 'VisitorInterest', 'getNumberOfVisitsByDaysSinceLast');
     }
 
-    function addMenu()
+    public function addMenu()
     {
         Piwik_RenameMenuEntry('General_Visitors', 'VisitFrequency_SubmenuFrequency',
             'General_Visitors', 'VisitorInterest_Engagement');
@@ -140,4 +141,86 @@ class Piwik_VisitorInterest extends Piwik_Plugin
         $out .= Piwik_FrontController::getInstance()->fetchDispatch('VisitorInterest', 'index');
         $out .= '</div>';
     }
-}
+
+    public function getReportDisplayProperties(&$properties)
+    {
+        $properties['VisitorInterest.getNumberOfVisitsPerVisitDuration'] =
+            $this->getDisplayPropertiesForGetNumberOfVisitsPerVisitDuration();
+        $properties['VisitorInterest.getNumberOfVisitsPerPage'] =
+            $this->getDisplayPropertiesForGetNumberOfVisitsPerPage();
+        $properties['VisitorInterest.getNumberOfVisitsByVisitCount'] =
+            $this->getDisplayPropertiesForGetNumberOfVisitsByVisitCount();
+        $properties['VisitorInterest.getNumberOfVisitsByDaysSinceLast'] =
+            $this->getDisplayPropertiesForGetNumberOfVisitsByDaysSinceLast();
+    }
+
+    private function getDisplayPropertiesForGetNumberOfVisitsPerVisitDuration()
+    {
+        return array(
+            'default_view_type' => 'cloud',
+            'filter_sort_column' => 'label',
+            'filter_sort_order' => 'asc',
+            'translations' => array('label' => Piwik_Translate('VisitorInterest_ColumnVisitDuration')),
+            'graph_limit' => 10,
+            'enable_sort' => false,
+            'show_exclude_low_population' => false,
+            'show_offset_information' => false,
+            'show_pagination_control' => false,
+            'show_search' => false,
+            'show_table_all_columns' => false,
+        );
+    }
+
+    private function getDisplayPropertiesForGetNumberOfVisitsPerPage()
+    {
+        return array(
+            'default_view_type' => 'cloud',
+            'filter_sort_column' => 'label',
+            'filter_sort_order' => 'asc',
+            'translations' => array('label' => Piwik_Translate('VisitorInterest_ColumnPagesPerVisit')),
+            'graph_limit' => 10,
+            'enable_sort' => false,
+            'show_exclude_low_population' => false,
+            'show_offset_information' => false,
+            'show_pagination_control' => false,
+            'show_search' => false,
+            'show_table_all_columns' => false,
+        );
+    }
+
+    private function getDisplayPropertiesForGetNumberOfVisitsByVisitCount()
+    {
+        return array(
+            'columns_to_display' => array('label', 'nb_visits', 'nb_visits_percentage'),
+            'filter_sort_column' => 'label',
+            'filter_sort_order' => 'asc',
+            'translations' => array('label' => Piwik_Translate('VisitorInterest_VisitNum'),
+                                    'nb_visits_percentage' => Piwik_Metrics::getPercentVisitColumn()),
+            'show_exclude_low_population' => false,
+            'show_offset_information' => false,
+            'show_pagination_control' => false,
+            'filter_limit' => 15,
+            'show_search' => false,
+            'enable_sort' => false,
+            'show_table_all_columns' => false,
+            'show_all_views_icons' => false,
+        );
+    }
+
+    private function getDisplayPropertiesForGetNumberOfVisitsByDaysSinceLast()
+    {
+        return array(
+            'filter_sort_column' => 'label',
+            'filter_sort_order' => 'asc',
+            'translations' => array('label' => Piwik_Translate('General_DaysSinceLastVisit')),
+            'show_exclude_low_population' => false,
+            'show_offset_information' => false,
+            'show_pagination_control' => false,
+            'show_all_views_icons' => false,
+            'filter_limit' => 15,
+            'show_search' => false,
+            'enable_sort' => false,
+            'show_table_all_columns' => false
+        );
+    }
+}
\ No newline at end of file