refactor(Dashboard): mutualize template for number widget

Author: btry

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

@@ -111,6 +111,22 @@
     ]);
 }
 
+$dashboard_item = new DashboardItem();
+$rows = $dashboard_item->find([
+    'card_id' => 'plugin_carbon_report_usage_abiotic_depletion'
+]);
+foreach ($rows as $row) {
+    $card_options = json_decode($row['card_options'], true);
+    if ($card_options['widgettype'] === 'usage_abiotic_depletion') {
+        $card_options['widgettype'] = 'impact_criteria_number';
+    }
+    $dashboard_item->update([
+        'id' => $row['id'],
+        'card_id' => 'plugin_carbon_report_usage_adp_impact',
+        'card_options' => json_encode($card_options),
+    ]);
+}
+
 $dashboard_item = new DashboardItem();
 $rows = $dashboard_item->find([
     'card_id' => 'plugin_carbon_report_embodied_abiotic_depletion'

src/Dashboard/DemoProvider.php

@@ -46,8 +46,8 @@ class DemoProvider
 {
     /** @var array<string, array> $impact_values Embodied and usage impact values*/
     private static array $impact_values = [
-        'gwp'    => [616000000, null],
-        'adp'    => [12.748, null],
+        'gwp'    => [616000000, 176483],
+        'adp'    => [12.748, 2.86],
         'pe'     => [491000000, null],
         'gwppb'  => [null, null],
         'gwppf'  => [null, null],
@@ -70,24 +70,6 @@ class DemoProvider
         'ept'    => [null, null],
     ];
 
-    public static function getUsageAbioticDepletion(array $params = [], array $crit = []): array
-    {
-        $default_params = [
-            'label' => __('Usage abiotic depletion potential', 'carbon'),
-            'icon'  => 'fa-solid fa-temperature-arrow-up',
-        ];
-        $params = array_merge($default_params, $params);
-
-        $value = 2.86;
-        $value = Toolbox::getWeight($value) . __('Sbeq', 'carbon');
-
-        return [
-            'number'     => $value,
-            'label'      => $params['label'],
-            'icon'       => $params['icon'],
-        ];
-    }
-
     public static function getUsageCarbonEmissionPerMonth(array $params = [], array $crit = []): array
     {
         $default_params = [
@@ -380,27 +362,6 @@ public static function getSumUsageEmissionsPerModel(array $params = [], array $w
         ];
     }
 
-    /**
-     * Get usage CO2 emissions
-     *
-     * @param array $params
-     * @return array
-     */
-    public static function getUsageCarbonEmission(array $params = []): array
-    {
-        $default_params = [
-            'label' => __('plugin carbon - Usage carbon emission', 'carbon'),
-            'icon'  => 'fa-solid fa-temperature-arrow-up',
-        ];
-        $params = array_merge($default_params, $params);
-        $gwp = Toolbox::getWeight(176483) . __('CO₂eq', 'carbon');
-        return [
-            'number' => $gwp,
-            'label'  => $params['label'],
-            'icon'   => $params['icon'],
-        ];
-    }
-
     /**
      * Get the value of an impact criteria for the embodied scope
      *
@@ -501,7 +462,7 @@ public static function getImpactOfEmbodiedAndUsageCriteria(string $impact_type,
             $crit['itemtype'] = array_intersect($crit['itemtype'], PLUGIN_CARBON_TYPES);
         }
 
-        $value = self::$impact_values[$impact_type][1];
+        $value = self::$impact_values[$impact_type][0] + self::$impact_values[$impact_type][1];
         if ($value === null) {
             $value = 'N/A';
         } else {

src/Dashboard/Grid.php

@@ -266,11 +266,14 @@ protected static function getReportCards(): array
                 'label'        => __('Biggest monthly averaged carbon emission per model', 'carbon'),
                 'provider'     => Provider::class . '::getSumUsageEmissionsPerModel',
             ],
-            'plugin_carbon_report_usage_abiotic_depletion' => [
-                'widgettype'   => ['usage_abiotic_depletion'],
+            'plugin_carbon_report_usage_adp_impact' => [
+                'widgettype'   => ['impact_criteria_number'],
                 'group'        => $group,
                 'label'        => __('Usage abiotic depletion potential', 'carbon'),
-                'provider'     => Provider::class . '::getUsageAbioticDepletion',
+                'provider'     => Provider::class . '::getImpactOfUsageCriteria',
+                'args'         => [
+                    'impact_type' => 'adp',
+                ]
             ],
         ];
 

src/Dashboard/Widget.php

@@ -863,7 +863,7 @@ public static function displayImpactCriteriaNumber(array $params = []): string
 
         $label_color = '#626976';
         $fg_color = GlpiToolbox::getFgColor($p['color']);
-        return TemplateRenderer::getInstance()->render('@carbon/dashboard/embodied-impact-criteria.html.twig', [
+        return TemplateRenderer::getInstance()->render('@carbon/dashboard/impact-criteria.html.twig', [
             'id' => $p['id'],
             'color' => $p['color'],
             'fg_color' => $fg_color,

…board/embodied-impact-criteria.html.twig …ates/dashboard/impact-criteria.html.twigtemplates/dashboard/embodied-impact-criteria.html.twig renamed to templates/dashboard/impact-criteria.html.twig templates/dashboard/embodied-impact-criteria.html.twig renamed to templates/dashboard/impact-criteria.html.twig

@@ -72,7 +72,7 @@
 <div class="card" id="{{ id }}">
     <div class="card-body" style="height: 100%">
         <div class="row align-items-center">
-            <div class="col-auto" id="carbonEmbodiedCarbonEmissionIconElement">
+            <div class="col-auto">
                 <span class="icon icon-size">
                 {% if pictogram_file != '' %}
                     {{ source('@carbon/dashboard/' ~ pictogram_file) }}