More codeclimate fixes.

GetDKAN · dafeder · Apr 16, 2025 · Mar 5, 2025 · Mar 5, 2025 · Mar 10, 2025
commit cb177a8b4b2b91a904f7cec271c012a1ca86f2a3
diff --git a/modules/harvest/src/ETL/Extract/DataJson.php b/modules/harvest/src/ETL/Extract/DataJson.php
@@ -29,7 +29,7 @@ class DataJson extends Extract {
  
10BC0
  *
    * @param object $harvest_plan
    *   The harvest plan.
-   * @param ClientInterface|null $client
+   * @param \GuzzleHttp\ClientInterface|null $client
    *   Optional http client.
    */
   public function __construct(object $harvest_plan, ?ClientInterface $client = NULL) {

diff --git a/modules/harvest/src/ETL/Factory.php b/modules/harvest/src/ETL/Factory.php
@@ -45,10 +45,10 @@ class Factory {
    * @param object $harvest_plan
    *   The harvest.
    * @param object $item_storage
-   *   The item storage
+   *   The item storage.
    * @param object $hash_storage
-   *   The item storage
-   * @param ClientInterface|NULL $client
+   *   The item storage.
+   * @param /GuzzleHttp/ClientInterface|null $client
    *   The http client.
    *
    * @throws \Exception
@@ -78,8 +78,7 @@ public function __construct(
    *
    * @throws \Exception
    */
-  public function get(string $type)
-  {
+  public function get(string $type) {
     switch ($type) {
       case  "extract":
         $class = $this->harvestPlan->extract->type;
@@ -113,13 +112,13 @@ public function get(string $type)
    *
    * @param string $class
    *   The name of the class.
-   * @param $config
+   * @param object $config
    *   Optional class config.
    *
    * @return mixed
    *   The requested object.
    */
-  private function getOne(string $class, $config = NULL) {
+  private function getOne(string $class, object $config = NULL) {
     if (!$config) {
       $config = $this->harvestPlan;
     }
@@ -129,15 +128,15 @@ private function getOne(string $class, $config = NULL) {
   /**
    * Validate harvest plan against schema.
    *
-   * @param $harvest_plan
+   * @param object $harvest_plan
    *   The harvest plan object to test.
    *
    * @return bool
    *   Return TRUE if plan validates.
    *
    * @throws \Exception
    */
-  public static function validateHarvestPlan($harvest_plan): bool {
+  public static function validateHarvestPlan(object $harvest_plan): bool {
     if (!is_object($harvest_plan)) {
       throw new \Exception("Harvest plan must be a php object.");
     }

diff --git a/modules/harvest/src/ETL/Transform/AddId.php b/modules/harvest/src/ETL/Transform/AddId.php
@@ -3,7 +3,7 @@
 namespace Drupal\harvest\ETL\Transform;
 
 /**
- * transform to add an identifier.
+ * Transform to add an identifier.
  */
 class AddId extends Transform {
 

diff --git a/modules/harvest/src/ETL/Transform/AddRandomNumber.php b/modules/harvest/src/ETL/Transform/AddRandomNumber.php
@@ -3,7 +3,7 @@
 namespace Drupal\harvest\ETL\Transform;
 
 /**
- * transform to add a random number.
+ * Transform to add a random number.
  */
 class AddRandomNumber extends Transform {
 

diff --git a/modules/harvest/src/Harvester.php b/modules/harvest/src/Harvester.php
@@ -13,6 +13,11 @@ class Harvester {
   public const HARVEST_LOAD_UPDATED_ITEM = 1;
   public const HARVEST_LOAD_UNCHANGED = 2;
 
+  /**
+   * The Factory object.
+   *
+   * @var Factory|Drupal\harvest\ETL\Factory
+   */
   private Factory $factory;
 
   /**
@@ -155,16 +160,15 @@ private function executeTransformers(array $transformers, array $items, array &$
    *
    * @param array $transformers
    *   The transformers to execute.
-   * @param object $transformed_item
-   *   The item to transform
+   * @param object $item
+   *   The item to transform.
    * @param string $identifier
    *   The item identifier.
    *
    * @return object
    *   The transformed item.
    */
-  private function executeTransformersSingle(array $transformers, object $item, string $identifier)
-  {
+  private function executeTransformersSingle(array $transformers, object $item, string $identifier) {
     $transformed_item = clone $item;
 
     foreach ($transformers as $transformer) {
@@ -183,10 +187,11 @@ private function executeTransformersSingle(array $transformers, object $item, st
 
     return $transformed_item;
   }
+
   /**
    * Transform an item.
    *
-   * @param Transform $transformer
+   * @param \Drupal\harvest\ETL\Transform\Transform $transformer
    *   The transformer to run.
    * @param object $item
    *   The item to transform.

diff --git a/modules/harvest/src/ResultInterpreter.php b/modules/harvest/src/ResultInterpreter.php
@@ -3,9 +3,14 @@
 namespace Drupal\harvest;
 
 /**
- * Extract helpful information from a harvest result.
+ * Extracts information from an arroy of harvest result statuses.
  */
 class ResultInterpreter {
+  /**
+   * The result statuses of actions performed by a harvest.
+   *
+   * @var array
+   */
   private array $result;
 
   /**
@@ -66,7 +71,10 @@ public function countProcessed(): int {
 
     if (isset($this->result['status']['transform'])) {
       foreach (array_keys($this->result['status']['transform']) as $transformer) {
-        $ids = [...$ids, ...array_keys($this->result['status']['transform'][$transformer])];
+        $ids = [
+          ...$ids,
+          ...array_keys($this->result['status']['transform'][$transformer])
+        ];
       }
     }
 

diff --git a/modules/harvest/src/Util.php b/modules/harvest/src/Util.php
@@ -2,8 +2,6 @@
 
 namespace Drupal\harvest;
 
-use Drupal\harvest\Load\Dataset;
-
 /**
  * Utilities for managing datasets.
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,8 +2,6 @@ @@
     namespace Drupal\harvest;
-    use Drupal\harvest\Load\Dataset;
     /**
      * Utilities for managing datasets.
      */
@@ Expand Down @@