Install: update reporting page configuration

Author: btry

install/data/report_dashboard.json

@@ -77,27 +77,27 @@
             "point_labels": "0"
         }
     },
-    "plugin_carbon_report_embodied_abiotic_depletion": {
+    "plugin_carbon_report_embodied_adp_impact": {
         "x": 5,
         "y": 3,
         "width": 5,
         "height": 3,
         "card_options": {
             "color": "#ffd966",
-            "widgettype": "embodied_abiotic_depletion",
+            "widgettype": "impact_criteria_number",
             "use_gradient": "0",
             "point_labels": "0",
             "limit": "7"
         }
     },
-    "plugin_carbon_report_embodied_global_warming": {
+    "plugin_carbon_report_embodied_gwp_impact": {
         "x": 10,
         "y": 0,
         "width": 5,
         "height": 3,
         "card_options": {
             "color": "#7a941e",
-            "widgettype": "embodied_global_warming",
+            "widgettype": "impact_criteria_number",
             "use_gradient": "0",
             "point_labels": "0",
             "limit": "7"
@@ -110,7 +110,7 @@
         "height": 3,
         "card_options": {
             "color": "#326319",
-            "widgettype": "embodied_primary_energy",
+            "widgettype": "impact_criteria_number",
             "use_gradient": "0",
             "point_labels": "0",
             "limit": "7"

install/migration/update_1.1.1_to_1.2.0/09_add_impact_criterias.php

@@ -100,9 +100,14 @@
     'card_id' => 'plugin_carbon_report_embodied_gwp_impact'
 ]);
 foreach ($rows as $row) {
+    $card_options = json_decode($row['card_options'], true);
+    if ($card_options['widgettype'] === 'embodied_global_warming') {
+        $card_options['widgettype'] = 'impact_criteria_number';
+    }
     $dashboard_item->update([
         'id' => $row['id'],
         'card_id' => 'plugin_carbon_report_embodied_gwp_impact',
+        'card_options' => json_encode($card_options),
     ]);
 }
 
@@ -111,8 +116,29 @@
     'card_id' => 'plugin_carbon_report_embodied_abiotic_depletion'
 ]);
 foreach ($rows as $row) {
+    $card_options = json_decode($row['card_options'], true);
+    if ($card_options['widgettype'] === 'embodied_abiotic_depletion') {
+        $card_options['widgettype'] = 'impact_criteria_number';
+    }
     $dashboard_item->update([
         'id' => $row['id'],
         'card_id' => 'plugin_carbon_report_embodied_adp_impact',
+        'card_options' => json_encode($card_options),
+    ]);
+}
+
+$dashboard_item = new DashboardItem();
+$rows = $dashboard_item->find([
+    'card_id' => 'plugin_carbon_report_embodied_pe_impact'
+]);
+foreach ($rows as $row) {
+    $card_options = json_decode($row['card_options'], true);
+    if ($card_options['widgettype'] === 'embodied_primary_energy') {
+        $card_options['widgettype'] = 'impact_criteria_number';
+    }
+    $dashboard_item->update([
+        'id' => $row['id'],
+        'card_id' => 'plugin_carbon_report_embodied_pe_impact',
+        'card_options' => json_encode($card_options),
     ]);
 }

src/Dashboard/Grid.php

@@ -309,18 +309,4 @@ protected static function getReportCards(): array
 
         return $new_cards;
     }
-
-    private static function getWidgetForImpact(bool $embodied, string $type): string
-    {
-        switch (($embodied ? 'embodied' : 'usage') . ' ' . $type) {
-            case 'embodied gwp':
-                return 'impact_criteria_number';
-            case 'embodied adp':
-                return 'impact_criteria_number';
-            case 'embodied pe':
-                return 'impact_criteria_number';
-        }
-
-        return 'bigNumber';
-    }
 }

src/Dashboard/Provider.php

@@ -53,7 +53,6 @@
 use GlpiPlugin\Carbon\UsageImpact;
 use Glpi\DBAL\QueryExpression;
 use Glpi\DBAL\QuerySubQuery;
-use GlpiPlugin\Carbon\Documentation;
 use GlpiPlugin\Carbon\Impact\Type;
 use Search;
 use Session;

src/Dashboard/Widget.php

@@ -40,6 +40,7 @@
 use Glpi\Application\View\TemplateRenderer;
 use Glpi\Dashboard\Widget as GlpiDashboardWidget;
 use GlpiPlugin\Carbon\Documentation;
+use GlpiPlugin\Carbon\Impact\Type;
 use GlpiPlugin\Carbon\Report;
 use GlpiPlugin\Carbon\Toolbox;
 use Monitor;
@@ -744,7 +745,7 @@ public static function displayMonthlyCarbonEmission(array $params = []): string
             $last_month['series'][0]['unit']
         );
 
-        $url = Documentation::getInfoLink('carbon_emission');
+        $url = Type::getCriteriaInfoLink('gwp');
         $tooltip = __('Evaluates the usage carbon emission in CO₂ equivalent during the last 2 months. %s More information %s', 'carbon');
         $tooltip = sprintf($tooltip, '<br /><a target="_blank" href="' . $url . '">', '</a>');
         $tooltip_html = Html::showToolTip($tooltip, [
@@ -810,7 +811,7 @@ public static function displayUsageCarbonEmissionYearToDate(array $params = []):
                 break;
         }
 
-        $url = Documentation::getInfoLink('carbon_emission');
+        $url = Type::getCriteriaInfoLink('gwp');
         $tooltip = __('Evaluates the usage carbon emission in CO₂ equivalent during the last 12 elapsed months. %s More information %s', 'carbon');
         $tooltip = sprintf($tooltip, '<br /><a target="_blank" href="' . $url . '">', '</a>');
         $tooltip_html = Html::showToolTip($tooltip, [
@@ -845,12 +846,11 @@ public static function displayImpactCriteriaNumber(array $params = []): string
             'alt'     => '',
             'color'   => '',
             'icon'    => '',
-            'id'      => 'plugin_carbon_embodied_primary_energy_' . mt_rand(),
+            'id'      => 'plugin_carbon_impact_criteria_' . mt_rand(),
             'filters' => [], // TODO: Not implemented yet (is this useful ?)
         ];
         $p = array_merge($default, $params);
 
-        $url = Documentation::getInfoLink('primary_energy_impact');
         $url = $p['doc_url'];
         $tooltip = $p['tooltip'];
         $tooltip .= '<br /><a target="_blank" href="' . $url . '">'
@@ -892,7 +892,7 @@ public static function displayUsageAbioticDepletion(array $params = []): string
         ];
         $p = array_merge($default, $params);
 
-        $url = Documentation::getInfoLink('abiotic_depletion_impact');
+        $url = Type::getCriteriaInfoLink('adp');
         $tooltip = __('Evaluates the consumption of non renewable resources in Antimony equivalent. %s More information %s', 'carbon');
         $tooltip = sprintf($tooltip, '<br /><a target="_blank" href="' . $url . '">', '</a>');
         $tooltip_html = Html::showToolTip($tooltip, [

src/Impact/Type.php

@@ -35,7 +35,6 @@
 
 class Type
 {
-
     private const BASE_URL = 'https://glpi-plugins.readthedocs.io/%s/latest/carbon';
 
     const IMPACT_GWP    = 1; // Global warming potential
@@ -344,7 +343,7 @@ public static function getCriteriaPictogram(string $type): string
     /**
      * Get external URL to a detailed description of the given path
      *
-     * @param string $object_descriptor
+     * @param string $impact_type
      * @return string
      */
     public static function getCriteriaInfoLink(string $impact_type): string

src/UsageInfo.php

@@ -39,6 +39,7 @@
 use Glpi\Application\View\TemplateRenderer;
 use GlpiPlugin\Carbon\Dashboard\Provider;
 use GlpiPlugin\Carbon\Dashboard\Widget;
+use GlpiPlugin\Carbon\Impact\Type;
 use Html;
 use Monitor;
 use NetworkEquipment;
@@ -214,15 +215,15 @@ public static function showCharts(CommonDBTM $asset)
             'items_id' => $asset->getID(),
         ]);
 
-        $url = Documentation::getInfoLink('carbon_emission');
+        $url = Type::getCriteriaInfoLink('gwp');
         $tooltip = __('Evaluates the carbon emission in CO₂ equivalent. %s More information %s', 'carbon');
         $tooltip = sprintf($tooltip, '<br /><a target="_blank" href="' . $url . '">', '</a>');
         $carbon_emission_tooltip_html = Html::showToolTip($tooltip, [
             'display' => false,
             'applyto' => 'carbon_emission_tip',
         ]);
 
-        $url = Documentation::getInfoLink('abiotic_depletion_impact');
+        $url = Type::getCriteriaInfoLink('adp');
         $tooltip = __('Evaluates the consumption of non renewable resources in Antimony equivalent. %s More information %s', 'carbon');
         $tooltip = sprintf($tooltip, '<br /><a target="_blank" href="' . $url . '">', '</a>');
         $usage_abiotic_depletion_tooltip_html = Html::showToolTip($tooltip, [
@@ -234,7 +235,7 @@ public static function showCharts(CommonDBTM $asset)
             'applyto' => 'embodied_abiotic_depletion_tip',
         ]);
 
-        $url = Documentation::getInfoLink('primary_energy');
+        $url = Type::getCriteriaInfoLink('pe');
         $tooltip = __('Evaluates the primary energy consumed. %s More information %s', 'carbon');
         $tooltip = sprintf($tooltip, '<br /><a target="_blank" href="' . $url . '">', '</a>');
         $embodied_primary_energy_tooltip_html = Html::showToolTip($tooltip, [