PHP 8.1 compatibility changes (GetDKAN#3908)

* Remove ini_set of deprecated auto_detect_line_endings * Don’t pass a null value to json_decode() * Consistently implement setUp() and tearDown() in tests * Add #[\ReturnTypeWillChange] for mismatched return types * Explicitly retype boolean to array * Update weitzman/drupal-test-traits to 2.x version * Simplify code complexity * Don’t redeclare protected variable
janette · Feb 14, 2023 · 65c62bf · 65c62bf
1 parent 9a65b1c
commit 65c62bf
Show file tree

Hide file tree

Showing 21 changed files with 32 additions and 23 deletions.
diff --git a/composer.json b/composer.json
@@ -25,7 +25,7 @@
         "getdkan/procrastinator": "^4.0.0",
         "getdkan/rooted-json-data": "^0.0.2",
         "getdkan/sql-parser": "^2.0.0",
-        "guzzlehttp/guzzle" : "^6.3",
+        "guzzlehttp/guzzle" : "^6.5.8 || ^7.4.5",
         "ilbee/csv-response": "^1.0",
         "m1x0n/opis-json-schema-error-presenter": "^0.5.2",
         "neitanod/forceutf8": "~2.0",
@@ -37,7 +37,7 @@
     },
     "require-dev": {
         "getdkan/mock-chain": "^1.3.0",
-        "weitzman/drupal-test-traits": "^1.5",
+        "weitzman/drupal-test-traits": "^2.0.1",
         "phpunit/phpunit": "^8.5.14 || ^9"
     },
     "repositories": {

diff --git a/modules/common/src/DataResource.php b/modules/common/src/DataResource.php
@@ -222,6 +222,7 @@ public function getTableName() {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function jsonSerialize() {
     return $this->serialize();
   }
@@ -316,6 +317,9 @@ private static function getDistribution($identifier) {
     $storage = $factory->getInstance('distribution');
 
     $distroJson = $storage->retrieve($identifier);
+    if (is_null($distroJson)) {
+      $distroJson = '';
+    }
     return json_decode($distroJson);
   }
 

diff --git a/modules/common/tests/src/Functional/Api1TestBase.php b/modules/common/tests/src/Functional/Api1TestBase.php
@@ -13,7 +13,6 @@ abstract class Api1TestBase extends ExistingSiteBase {
   use CleanUp;
 
   protected $http;
-  protected $baseUrl;
   protected $spec;
   protected $auth;
   protected $endpoint;

diff --git a/modules/datastore/modules/datastore_mysql_import/src/Service/MysqlImport.php b/modules/datastore/modules/datastore_mysql_import/src/Service/MysqlImport.php
@@ -89,15 +89,9 @@ protected function runIt() {
    */
   protected function getColsFromFile(string $file_path, string $delimiter): array {
 
-    // Ensure the "auto_detect_line_endings" ini setting is enabled before
-    // openning the file to ensure Mac style EOL characters are detected.
-    $old_ini = ini_set('auto_detect_line_endings', '1');
     // Open the CSV file.
     $f = fopen($file_path, 'r');
-    // Revert ini setting once the file has been opened.
-    if ($old_ini !== FALSE) {
-      ini_set('auto_detect_line_endings', $old_ini);
-    }
+
     // Ensure the file could be successfully opened.
     if (!isset($f) || $f === FALSE) {
       throw new FileException(sprintf('Failed to open resource file "%s".', $file_path));

diff --git a/modules/datastore/src/DatastoreResource.php b/modules/datastore/src/DatastoreResource.php
@@ -61,6 +61,7 @@ public function getMimeType() {
   /**
    * {@inheritdoc}
    */
+  #[\ReturnTypeWillChange]
   public function jsonSerialize() {
     return (object) [
       'filePath' => $this->filePath,

diff --git a/modules/datastore/src/Storage/DatabaseTable.php b/modules/datastore/src/Storage/DatabaseTable.php
@@ -65,6 +65,7 @@ public function getSummary() {
    *
    * {@inheritdoc}
    */
+  #[\ReturnTypeWillChange]
   public function jsonSerialize() {
     return (object) ['resource' => $this->resource];
   }

diff --git a/modules/datastore/src/Storage/TableSummary.php b/modules/datastore/src/Storage/TableSummary.php
@@ -58,6 +58,7 @@ public function __construct(
    *
    * {@inheritdoc}
    */
+  #[\ReturnTypeWillChange]
   public function jsonSerialize() {
     return array_filter([
       'numOfColumns' => $this->numOfColumns,

diff --git a/modules/datastore/tests/src/Functional/DictionaryEnforcerTest.php b/modules/datastore/tests/src/Functional/DictionaryEnforcerTest.php
@@ -119,7 +119,7 @@ public function setUp(): void {
       ->getExternalUrl();
   }
 
-  public function tearDown() {
+  public function tearDown(): void {
     parent::tearDown();
     $this->removeAllMappedFiles();
   }

diff --git a/modules/datastore/tests/src/Unit/Controller/QueryControllerTest.php b/modules/datastore/tests/src/Unit/Controller/QueryControllerTest.php
@@ -30,7 +30,7 @@
  */
 class QueryControllerTest extends TestCase {
 
-  protected function setUp() {
+  protected function setUp(): void {
     parent::setUp();
     // Set cache services
     $options = (new Options)

diff --git a/modules/datastore/tests/src/Unit/Controller/QueryDownloadControllerTest.php b/modules/datastore/tests/src/Unit/Controller/QueryDownloadControllerTest.php
@@ -32,7 +32,7 @@ class QueryDownloadControllerTest extends TestCase {
 
   private $buffer;
 
-  protected function setUp() {
+  protected function setUp(): void {
     parent::setUp();
     // Set cache services
     $options = (new Options)

diff --git a/modules/datastore/tests/src/Unit/Plugin/QueueWorker/ImportJobTest.php b/modules/datastore/tests/src/Unit/Plugin/QueueWorker/ImportJobTest.php
@@ -26,7 +26,7 @@ protected function setUp(): void {
     $this->assertTrue($this->database instanceof DatabaseTableInterface);
   }
 
-  protected function tearDown() {
+  protected function tearDown(): void {
     parent::tearDown();
     $this->database = NULL;
   }

diff --git a/modules/datastore/tests/src/Unit/Plugin/QueueWorker/TestMemStorage.php b/modules/datastore/tests/src/Unit/Plugin/QueueWorker/TestMemStorage.php
@@ -73,6 +73,7 @@ public function count(): int
         return count($this->storage);
     }
 
+    #[\ReturnTypeWillChange]
     public function jsonSerialize()
     {
         return (object) ['storage' => $this->storage];

diff --git a/modules/datastore/tests/src/Unit/SqlEndpoint/WebServiceApiTest.php b/modules/datastore/tests/src/Unit/SqlEndpoint/WebServiceApiTest.php
@@ -29,7 +29,7 @@
 class WebServiceApiTest extends TestCase {
   use TestHelperTrait;
 
-  protected function setUp() {
+  protected function setUp(): void {
     parent::setUp();
     // Set cache services
     $options = (new Options)

diff --git a/modules/json_form_widget/src/ValueHandler.php b/modules/json_form_widget/src/ValueHandler.php
@@ -71,14 +71,14 @@ public function handleObjectValues($formValues, $property, $schema) {
     }
 
     $properties = array_keys((array) $schema->properties);
-    $data = FALSE;
+    $data = [];
     foreach ($properties as $sub_property) {
       $value = $this->flattenValues($formValues, $sub_property, $schema->properties->$sub_property);
       if ($value) {
         $data[$sub_property] = $value;
       }
     }
-    return $data;
+    return $data ?: FALSE;
   }
 
   /**

diff --git a/modules/metastore/modules/metastore_search/src/Facade/ComplexDataFacade.php b/modules/metastore/modules/metastore_search/src/Facade/ComplexDataFacade.php
@@ -53,6 +53,7 @@ public function getProperties($include_computed = FALSE) {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function toArray() {
     // @todo Implement toArray() method.
   }
@@ -62,6 +63,7 @@ public function toArray() {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function isEmpty() {
     // @todo Implement isEmpty() method.
   }
@@ -71,6 +73,7 @@ public function isEmpty() {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function current() {
     // @todo Implement current() method.
   }
@@ -80,6 +83,7 @@ public function current() {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function next() {
     // @todo Implement next() method.
   }
@@ -89,6 +93,7 @@ public function next() {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function key() {
     // @todo Implement key() method.
   }
@@ -98,6 +103,7 @@ public function key() {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function valid() {
     // @todo Implement valid() method.
   }
@@ -107,6 +113,7 @@ public function valid() {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function rewind() {
     // @todo Implement rewind() method.
   }
@@ -116,6 +123,7 @@ public function rewind() {
    *
    * @inheritdoc
    */
+  #[\ReturnTypeWillChange]
   public function onChange($name) {
     // @todo Implement onChange() method.
   }

diff --git a/modules/metastore/tests/src/Functional/DatasetSpecificDocsTest.php b/modules/metastore/tests/src/Functional/DatasetSpecificDocsTest.php
@@ -57,7 +57,7 @@ public function test() {
   /**
    *
    */
-  public function tearDown() {
+  public function tearDown(): void {
     parent::tearDown();
     $this->removeAllNodes();
     $this->removeAllMappedFiles();

diff --git a/modules/metastore/tests/src/Functional/OnPreReferenceTest.php b/modules/metastore/tests/src/Functional/OnPreReferenceTest.php
@@ -67,7 +67,7 @@ public function test() {
   /**
    *
    */
-  public function tearDown() {
+  public function tearDown(): void {
     parent::tearDown();
     $this->removeAllNodes();
     $this->removeAllMappedFiles();

diff --git a/modules/metastore/tests/src/Functional/OrphanCheckerTest.php b/modules/metastore/tests/src/Functional/OrphanCheckerTest.php
@@ -25,7 +25,7 @@ class OrphanCheckerTest extends ExistingSiteBase {
    */
   protected $validMetadataFactory;
 
-  public function setUp() {
+  public function setUp(): void {
     parent::setUp();
     $this->removeHarvests();
     $this->removeAllNodes();

diff --git a/modules/metastore/tests/src/Kernel/DataDictionarySettingsFormTest.php b/modules/metastore/tests/src/Kernel/DataDictionarySettingsFormTest.php
@@ -54,7 +54,7 @@ public function provideFormData(): array {
   /**
    * {@inheritdoc}
    */
-  protected function setUp() {
+  protected function setUp(): void {
     parent::setUp();
 
     $this->form = new DataDictionarySettingsForm($this->container->get('config.factory'));

diff --git a/modules/metastore/tests/src/Unit/SchemaRetrieverTest.php b/modules/metastore/tests/src/Unit/SchemaRetrieverTest.php
@@ -24,7 +24,7 @@ class SchemaRetrieverTest extends TestCase {
   /**
    * Protected.
    */
-  protected function setUp() {
+  protected function setUp(): void {
     // TODO: Change the autogenerated stub.
     parent::setUp();
     if (!defined("DRUPAL_MINIMUM_PHP")) {

diff --git a/tests/src/Functional/DatasetTest.php b/tests/src/Functional/DatasetTest.php
@@ -45,7 +45,7 @@ public function setUp(): void {
     $this->validMetadataFactory = ServiceTest::getValidMetadataFactory($this);
   }
 
-  public function tearDown() {
+  public function tearDown(): void {
     parent::tearDown();
     $this->removeHarvests();
     $this->removeAllNodes();