docs: update docblocks

Author: btry

hook.php

@@ -153,7 +153,8 @@ function plugin_carbon_postShowTab(array $param)
 /**
  * Add search options to core itemtypes
  *
- * @param string $itemtype
+* @template T of CommonDBTM
+* @param class-string<T> $itemtype
  * @return array
  */
 function plugin_carbon_getAddSearchOptionsNew($itemtype): array

src/CarbonEmission.php

@@ -172,6 +172,8 @@ public function rawSearchOptions()
      * Gaps are returned as an array of start and end
      * where start is the 1st msising date and end is the last missing date
      *
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype
      * @param integer $id
      * @param DateTimeInterface|null $start
      * @param DateTimeInterface|null $stop

src/Dashboard/Provider.php

@@ -459,7 +459,8 @@ public static function getHandledAssetsRatio(array $params = [])
      *
      * Handled assets are assets with enough data to calculate usage carbon emission
      *
-     * @param array|string $itemtypes types of asets to count
+     * @template T of CommonDBTM
+     * @param array[class-string<T>]|class-string<T> $itemtypes types of asets to count
      * @param array $params
      * @return array
      */

src/EmbodiedImpact.php

@@ -140,7 +140,8 @@ public function rawSearchOptions()
     /**
      * Get iterator of items without known embodied impact for a specified itemtype
      *
-     * @param string $itemtype
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype
      * @param array $crit Criteria array of WHERE, ORDER, GROUP BY, LEFT JOIN, INNER JOIN, RIGHT JOIN, HAVING, LIMIT
      * @return DBmysqlIterator
      */

src/Engine/V1/Inventory.php

@@ -35,11 +35,9 @@
 use DateTime;
 use Computer as GlpiComputer;
 use DbUtils;
-use GlpiPlugin\Carbon\Zone;
 use GlpiPlugin\Carbon\DataTracking\TrackedFloat;
 use GlpiPlugin\Carbon\DataTracking\TrackedInt;
 use GlpiPlugin\Carbon\Source_Zone;
-use GlpiPlugin\Carbon\Tests\Engine\V1\EngineTestCase;
 
 /**
  * Compute environmental impact of a whole inventory
@@ -56,7 +54,8 @@ class Inventory implements EngineInterface
     /**
      * Check an item is already in the inventory
      *
-     * @param string $itemtype
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype
      * @param integer $items_id
      * @return boolean
      */
@@ -69,7 +68,8 @@ public function hasItem(string $itemtype, int $items_id)
     /**
      * Is the itemtype an asset ?
      *
-     * @param string $itemtype
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype
      * @return boolean
      */
     private static function isAsset(string $itemtype): bool
@@ -83,7 +83,8 @@ private static function isAsset(string $itemtype): bool
     /**
      * Add an item to the inventory to be processed
      *
-     * @param string $itemtype
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype
      * @param integer $items_id
      * @return boolean
      */
@@ -125,7 +126,8 @@ public function addItem(string $itemtype, int $items_id): bool
     /**
      * Add several items to the inventory by itemtype and a search criteria
      *
-     * @param string $itemtype itemtype of the items to add
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype itemtype of the items to add
      * @param array $crit search criteria of items to add
      * @return boolean true if success
      */

src/Impact/Embodied/Engine.php

@@ -56,7 +56,8 @@ public static function getAvailableBackends(): array
      *
      * Returns null if no engine found
      *
-     * @param string $itemtype itemtype of assets to analyze
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype itemtype of assets to analyze
      * @return EmbodiedImpactInterface|null an instance if an embodied impact calculation object or null on error
      */
     public static function getEngineFromItemtype(string $itemtype): ?EmbodiedImpactInterface
@@ -82,7 +83,8 @@ public static function getEngineFromItemtype(string $itemtype): ?EmbodiedImpactI
      * Get an instance of the internal engine to calcilate impacts for the given itemtype
      * This is a fallback engine
      *
-     * @param string $itemtype
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype
      * @return ?EmbodiedImpactInterface
      */
     public static function getInternalEngineFromItemtype(string $itemtype): ?EmbodiedImpactInterface

src/Impact/Usage/Engine.php

@@ -55,7 +55,8 @@ public static function getAvailableBackends(): array
      *
      * Returns null if no engine found
      *
-     * @param string $itemtype itemtype of assets to analyze
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype itemtype of assets to analyze
      * @return AbstractUsageImpact|null an instance if an embodied impact calculation object or null on error
      */
     public static function getEngineFromItemtype(string $itemtype): ?AbstractUsageImpact

src/Zone.php

@@ -190,8 +190,8 @@ public function rawSearchOptions()
 
     /**
      * Get the request fragment to find a zone by asset
-     *
-     * @param class-string $itemtype asset type
+     * @template T of CommonDBTM
+     * @param class-string<T> $itemtype asset type
      * @return array Request fragment
      */
     private static function getByAssetRequest(string $itemtype): array