Refs #4041, force DataTable visualizations to specify which properties should be overridable and move some view properties to different visualizations.

6 files changed, 47 insertions, 4 deletions

diff --git a/plugins/CoreVisualizations/Visualizations/Cloud.php b/plugins/CoreVisualizations/Visualizations/Cloud.php
index 31f0f291ef..d2a45349bc 100644
--- a/plugins/CoreVisualizations/Visualizations/Cloud.php
+++ b/plugins/CoreVisualizations/Visualizations/Cloud.php
@@ -28,9 +28,17 @@ class Cloud extends DataTableVisualization
 {
     const ID = 'cloud';
     
+    /**
+     * Whether to display the logo assocatied with a DataTable row (stored as 'logo' row metadata)
+     * instead of the label in Tag Clouds.
+     */
+    const DISPLAY_LOGO_INSTEAD_OF_LABEL = 'display_logo_instead_of_label';
+
     /** Used by integration tests to make sure output is consistent. */
     public static $debugDisableShuffle = false;
 
+    public static $overridableProperties = array('display_logo_instead_of_label');
+
     protected $wordsArray = array();
     public $truncatingLimit = 50;
 
@@ -39,7 +47,11 @@ class Cloud extends DataTableVisualization
         return array(
             'show_offset_information' => false,
             'show_exclude_low_population' => false,
-            'display_logo_instead_of_label' => false,
+            'visualization_properties' => array(
+                'cloud' => array(
+                    'display_logo_instead_of_label' => false,
+                )
+            )
         );
     }
 
@@ -75,7 +87,7 @@ class Cloud extends DataTableVisualization
         $labelMetadata = array();
         foreach ($dataTable->getRows() as $row) {
             $logo = false;
-            if ($properties['display_logo_instead_of_label']) {
+            if ($properties['visualization_properties']->display_logo_instead_of_label) {
                 $logo = $row->getMetadata('logo');
             }
 
diff --git a/plugins/CoreVisualizations/Visualizations/HtmlTable.php b/plugins/CoreVisualizations/Visualizations/HtmlTable.php
index d5e1f32775..0dd35715a3 100644
--- a/plugins/CoreVisualizations/Visualizations/HtmlTable.php
+++ b/plugins/CoreVisualizations/Visualizations/HtmlTable.php
@@ -86,6 +86,20 @@ class HtmlTable extends DataTableVisualization
      */
     const DISABLE_SUBTABLE_IN_GOALS_VIEW = 'disable_subtable_when_show_goals';
 
+    /**
+     * Controls whether the summary row is displayed on every page of the datatable view or not.
+     * If false, the summary row will be treated as the last row of the dataset and will only visible
+     * when viewing the last rows.
+     */
+    const KEEP_SUMMARY_ROW = 'keep_summary_row';
+
+    /**
+     * If true, the summary row will be colored differently than all other DataTable rows.
+     * 
+     * @see also self::KEEP_SUMMARY_ROW
+     */
+    const HIGHLIGHT_SUMMARY_ROW = 'highlight_summary_row';
+
     static public $clientSideParameters = array(
         'search_recursive',
         'filter_limit',
@@ -104,6 +118,17 @@ class HtmlTable extends DataTableVisualization
         'subtable_controller_action',
     );
 
+    public static $overridableProperties = array(
+        'show_expanded',
+        'disable_row_actions',
+        'disable_row_evolution',
+        'show_extra_columns',
+        'show_goals_columns',
+        'disable_subtable_when_show_goals',
+        'keep_summary_row',
+        'highlight_summary_row',
+    );
+
     /**
      * Constructor.
      */
@@ -153,6 +178,8 @@ class HtmlTable extends DataTableVisualization
                     'show_extra_columns' => false,
                     'show_goals_columns' => false,
                     'disable_subtable_when_show_goals' => false,
+                    'keep_summary_row' => false,
+                    'highlight_summary_row' => false,
                 ),
             ),
         );
diff --git a/plugins/CoreVisualizations/Visualizations/HtmlTable/AllColumns.php b/plugins/CoreVisualizations/Visualizations/HtmlTable/AllColumns.php
index 7f51275c60..02eee0b12d 100644
--- a/plugins/CoreVisualizations/Visualizations/HtmlTable/AllColumns.php
+++ b/plugins/CoreVisualizations/Visualizations/HtmlTable/AllColumns.php
@@ -14,7 +14,7 @@ namespace Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
 use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
 
 /**
- * TODO
+ * DataTableVisualization that derives from HtmlTable and sets show_extra_columns to true.
  */
 class AllColumns extends HtmlTable
 {
diff --git a/plugins/CoreVisualizations/Visualizations/HtmlTable/Goals.php b/plugins/CoreVisualizations/Visualizations/HtmlTable/Goals.php
index e2823fb84d..d42ea06ef2 100644
--- a/plugins/CoreVisualizations/Visualizations/HtmlTable/Goals.php
+++ b/plugins/CoreVisualizations/Visualizations/HtmlTable/Goals.php
@@ -14,7 +14,7 @@ namespace Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
 use Piwik\Plugins\CoreVisualizations\Visualizations\HtmlTable;
 
 /**
- * TODO
+ * DataTableVisualization that derives from HtmlTable and sets show_goals_columns to true.
  */
 class Goals extends HtmlTable
 {
diff --git a/plugins/CoreVisualizations/Visualizations/JqplotGraph.php b/plugins/CoreVisualizations/Visualizations/JqplotGraph.php
index 2b844a9fc9..11e1e40300 100644
--- a/plugins/CoreVisualizations/Visualizations/JqplotGraph.php
+++ b/plugins/CoreVisualizations/Visualizations/JqplotGraph.php
@@ -49,6 +49,8 @@ class JqplotGraph extends Graph
         'external_series_toggle_show_all'
     );
 
+    public static $overridableProperties = array('x_axis_step_size');
+
     /**
      * Constructor.
      * 
diff --git a/plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution.php b/plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution.php
index 1d9d69a74b..40892f09c0 100644
--- a/plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution.php
+++ b/plugins/CoreVisualizations/Visualizations/JqplotGraph/Evolution.php
@@ -33,6 +33,8 @@ class Evolution extends JqplotGraph
 
     public static $clientSideProperties = array('show_line_graph');
     
+    public static $overridableProperties = array('show_line_graph');
+
     public function __construct($view)
     {
         parent::__construct($view);