Support PHP 8.2 (#4085)

GetDKAN · Jan 30, 2024 · a4fdb23 · a4fdb23
1 parent 30d823e
commit a4fdb23
Show file tree

Hide file tree

Showing 47 changed files with 372 additions and 78 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -187,7 +187,7 @@ jobs:
     parameters:
       php_version:
         description: 'PHP major.minor for DDev to use.'
-        default: '8.1'
+        default: '8.2'
         type: string
       dkan_recommended_branch:
         description: 'Branch of getdkan/recommended-project to use.'
@@ -248,6 +248,11 @@ workflows:
             parameters:
               dkan_recommended_branch: [ '10.1.x-dev']
               php_version: [ '8.1' ]
+      - phpunit:
+          matrix:
+            parameters:
+              dkan_recommended_branch: [ '10.1.x-dev']
+              php_version: [ '8.2' ]
       - phpunit:
          matrix:
            parameters:

diff --git a/composer.json b/composer.json
@@ -13,12 +13,12 @@
         "ext-json": "*",
         "ezyang/htmlpurifier" : "^4.11",
         "fmizzell/maquina": "^1.1.1",
-        "getdkan/contracts": "^1.0.0",
-        "getdkan/csv-parser": "^1.3.0",
-        "getdkan/file-fetcher" : "^5.0.2",
-        "getdkan/harvest": "^1.0.0",
+        "getdkan/contracts": "^1.1.2",
+        "getdkan/csv-parser": "^1.3.1",
+        "getdkan/file-fetcher" : "^5.0.3",
+        "getdkan/harvest": "^1.0.3",
         "getdkan/procrastinator": "^5.0.0",
-        "getdkan/rooted-json-data": "^0.1",
+        "getdkan/rooted-json-data": "^0.2.1",
         "guzzlehttp/guzzle" : "^6.5.8 || ^7.4.5",
         "ilbee/csv-response": "^1.1.1",
         "justinrainbow/json-schema": "^5.2",
@@ -32,7 +32,7 @@
         "symfony/polyfill-php80": "^1.27"
     },
     "require-dev": {
-        "getdkan/mock-chain": "^1.3.0",
+        "getdkan/mock-chain": "^1.3.6",
         "weitzman/drupal-test-traits": "^2.0.1",
         "phpunit/phpunit": "^8.5.14 || ^9"
     },

diff --git a/modules/common/src/DataResource.php b/modules/common/src/DataResource.php
@@ -282,9 +282,7 @@ public function getTableName() {
   }
 
   /**
-   * Inherited.
-   *
-   * @inheritdoc
+   * {@inheritDoc}
    */
   #[\ReturnTypeWillChange]
   public function jsonSerialize() {

diff --git a/modules/common/src/Events/Event.php b/modules/common/src/Events/Event.php
@@ -2,14 +2,37 @@
 
 namespace Drupal\common\Events;
 
-use Drupal\Component\EventDispatcher\Event as SymfonyEvent;
+use Drupal\Component\EventDispatcher\Event as DrupalEvent;
 
 /**
  * Custom DKAN extension of the Drupal Event class.
  *
  * @package Drupal\common\Events
  */
-class Event extends SymfonyEvent {
+class Event extends DrupalEvent {
+
+  /**
+   * Validation callback.
+   *
+   * @var \Closure|mixed|null
+   */
+  private $validator;
+
+  /**
+   * Data.
+   *
+   * How this is used depends on the event we're responding to.
+   *
+   * @var mixed
+   */
+  private $data;
+
+  /**
+   * Exception.
+   *
+   * @var \Exception|null
+   */
+  private ?\Exception $exception;
 
   /**
    * Constructor.

diff --git a/modules/common/src/Plugin/DkanApiDocsPluginManager.php b/modules/common/src/Plugin/DkanApiDocsPluginManager.php
@@ -2,6 +2,7 @@
 
 namespace Drupal\common\Plugin;
 
+use Drupal\common\Annotation\DkanApiDocs;
 use Drupal\Core\Cache\CacheBackendInterface;
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Plugin\DefaultPluginManager;
@@ -26,10 +27,10 @@ class DkanApiDocsPluginManager extends DefaultPluginManager {
    */
   public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
     $subdir = 'Plugin/DkanApiDocs';
-    $plugin_interface = 'Drupal\common\Plugin\DkanApiDocsInterface';
+    $plugin_interface = DkanApiDocsInterface::class;
 
     // The name of the annotation class that contains the plugin definition.
-    $plugin_definition_annotation_name = 'Drupal\common\Annotation\DkanApiDocs';
+    $plugin_definition_annotation_name = DkanApiDocs::class;
 
     parent::__construct($subdir, $namespaces, $module_handler, $plugin_interface, $plugin_definition_annotation_name);
 

diff --git a/modules/common/src/Storage/SelectFactory.php b/modules/common/src/Storage/SelectFactory.php
@@ -284,7 +284,7 @@ private function addCondition($statementObj, $condition) {
       $this->addMatchCondition($statementObj, $condition);
       return;
     }
-    $field = (isset($condition->collection) ? $condition->collection : $this->alias)
+    $field = ($condition->collection ?? $this->alias)
       . '.'
       . $condition->property;
     $statementObj->condition($field, $condition->value, strtoupper($condition->operator));

diff --git a/modules/common/tests/src/Kernel/Storage/JobStoreFactoryTest.php b/modules/common/tests/src/Kernel/Storage/JobStoreFactoryTest.php
@@ -16,8 +16,9 @@
    * @group dkan
    * @group common
    * @group kernel
+   * @group legacy
    *
-   * @see  @see \Drupal\Tests\common\Kernel\Storage\AbstractJobStoreFactoryTest
+   * @see \Drupal\Tests\common\Kernel\Storage\AbstractJobStoreFactoryTest
    */
   class JobStoreFactoryTest extends KernelTestBase {
 

diff --git a/modules/common/tests/src/Unit/Mocks/FileSystem.php b/modules/common/tests/src/Unit/Mocks/FileSystem.php
@@ -12,7 +12,7 @@
 /**
  *
  */
-class FileSystem extends DrupalFileSystem {
+class FileSystem extends DrupalFilesystem {
 
   /**
    *

diff --git a/modules/datastore/src/Controller/AbstractQueryController.php b/modules/datastore/src/Controller/AbstractQueryController.php
@@ -91,7 +91,7 @@ public static function create(ContainerInterface $container) {
    * @param \Symfony\Component\HttpFoundation\Request $request
    *   The request object.
    *
-   * @return Ilbee\CSVResponse\CSVResponse|Symfony\Component\HttpFoundation\JsonResponse
+   * @return \Ilbee\CSVResponse\CSVResponse|\Symfony\Component\HttpFoundation\JsonResponse
    *   The json or CSV response.
    */
   public function query(Request $request) {
@@ -292,7 +292,7 @@ protected function getRowsLimit(): int {
    *   Normalized and type-casted JSON string.
    */
   public static function getPayloadJson(Request $request, $schema = NULL) {
-    $schema = $schema ?? file_get_contents(__DIR__ . "/../../docs/query.json");
+    $schema ??= file_get_contents(__DIR__ . "/../../docs/query.json");
     $payloadJson = static::getJson($request);
     $payloadJson = static::fixTypes($payloadJson, $schema);
     return $payloadJson;

diff --git a/modules/datastore/src/Plugin/DkanApiDocs/DatastoreApiDocs.php b/modules/datastore/src/Plugin/DkanApiDocs/DatastoreApiDocs.php
@@ -23,10 +23,17 @@ class DatastoreApiDocs extends DkanApiDocsBase {
   /**
    * The DKAN metastore service.
    *
-   * @var Drupal\metastore\Service
+   * @var \Drupal\metastore\Service
    */
   private $metastore;
 
+  /**
+   * Import info service.
+   *
+   * @var \Drupal\datastore\Service\Info\ImportInfo
+   */
+  private ImportInfo $importInfo;
+
   /**
    * Constructs a \Drupal\Component\Plugin\PluginBase object.
    *
@@ -42,7 +49,7 @@ class DatastoreApiDocs extends DkanApiDocsBase {
    *   The module handler service.
    * @param \Drupal\metastore\MetastoreService $metastore
    *   The module handler service.
-   * @param Drupal\datastore\Service\Info\ImportInfo $importInfo
+   * @param \Drupal\datastore\Service\Info\ImportInfo $importInfo
    *   Import info datastoer service.
    */
   public function __construct(
@@ -62,7 +69,7 @@ public function __construct(
   /**
    * Container injection.
    *
-   * @param \Drupal\common\Plugin\ContainerInterface $container
+   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
    *   The service container.
    * @param array $configuration
    *   A configuration array containing information about the plugin instance.
@@ -100,7 +107,7 @@ public function spec() {
     // Reformat definitions.
     foreach ($querySchema["definitions"] as $key => $def) {
       $schemaName = "datastoreQuery" . ucfirst($key);
-      $def["title"] = "Datastore Query: " . (isset($def["title"]) ? $def["title"] : $key);
+      $def["title"] = "Datastore Query: " . ($def["title"] ?? $key);
       $spec["components"]["schemas"][$schemaName] = $def;
     }
     unset($querySchema["definitions"]);

diff --git a/modules/datastore/src/Service/ImportService.php b/modules/datastore/src/Service/ImportService.php
@@ -74,7 +74,7 @@ class ImportService {
    *
    * @see self::getImporter()
    */
-  private ?ImportJob $importJob;
+  private ?ImportJob $importJob = NULL;
 
   /**
    * Create a resource service instance.

diff --git a/modules/datastore/src/SqlEndpoint/WebServiceApi.php b/modules/datastore/src/SqlEndpoint/WebServiceApi.php
@@ -22,7 +22,7 @@ class WebServiceApi implements ContainerInjectionInterface {
   /**
    * DKAN SQL Endpoint service.
    *
-   * @var \Drupal\datastore\SqlEndpoint
+   * @var \Drupal\datastore\SqlEndpoint\DatastoreSqlEndpointService
    */
   private $service;
 
@@ -36,10 +36,17 @@ class WebServiceApi implements ContainerInjectionInterface {
   /**
    * API request data.
    *
-   * @var Symfony\Component\HttpFoundation\RequestStack
+   * @var \Symfony\Component\HttpFoundation\RequestStack
    */
   private $requestStack;
 
+  /**
+   * Metastore API response service.
+   *
+   * @var \Drupal\metastore\MetastoreApiResponse
+   */
+  private MetastoreApiResponse $metastoreApiResponse;
+
   /**
    * {@inheritdoc}
    */

diff --git a/modules/datastore/src/Storage/QueryFactory.php b/modules/datastore/src/Storage/QueryFactory.php
@@ -222,7 +222,7 @@ private function populateQuerySorts(Query $query) {
       return;
     }
     foreach ($this->datastoreQuery->{"$.sorts"} as $sort) {
-      $query->sorts[] = (object) $this->resourceRename($sort);
+      $query->sorts[] = (object) self::resourceRename($sort);
     }
   }
 
@@ -257,7 +257,7 @@ private function populateQueryCondition($condition) {
     $primaryAlias = $this->datastoreQuery->{"$.resources[0].alias"};
     if (isset($condition["property"])) {
       $return = (object) [
-        "collection" => isset($condition["resource"]) ? $condition["resource"] : $primaryAlias,
+        "collection" => $condition["resource"] ?? $primaryAlias,
         "property" => $condition["property"],
         "value" => $this->propertyConvert($condition["value"]),
       ];

diff --git a/modules/datastore/src/Storage/TableSummary.php b/modules/datastore/src/Storage/TableSummary.php
@@ -37,15 +37,34 @@ class TableSummary implements \JsonSerializable {
    */
   public $numOfRows;
 
+  /**
+   * Full text indexes.
+   *
+   * @var array|null
+   */
+  private ?array $fulltextIndexes;
+
   /**
    * Constructor.
+   *
+   * @param int $numOfColumns
+   *   Number of columns.
+   * @param array $columns
+   *   Summary columns.
+   * @param array|null $indexes
+   *   Summary indexes.
+   * @param array|null $fulltext_indexes
+   *   Full text indexes.
+   * @param int $numOfRows
+   *   Number of rows.
    */
   public function __construct(
     int $numOfColumns,
     array $columns,
     ?array $indexes,
     ?array $fulltext_indexes,
-    int $numOfRows) {
+    int $numOfRows
+  ) {
     $this->numOfColumns = $numOfColumns;
     $this->columns = $columns;
     $this->indexes = $indexes;
@@ -54,9 +73,9 @@ public function __construct(
   }
 
   /**
-   * Inherited.
+   * Specify data which should be serialized to JSON.
    *
-   * {@inheritdoc}
+   * @return mixed
    */
   #[\ReturnTypeWillChange]
   public function jsonSerialize() {

diff --git a/modules/datastore/tests/src/Kernel/Plugin/QueueWorker/LocalizeQueueWorkerTest.php b/modules/datastore/tests/src/Kernel/Plugin/QueueWorker/LocalizeQueueWorkerTest.php
@@ -22,7 +22,7 @@
  */
 class LocalizeQueueWorkerTest extends KernelTestBase {
 
-  const SOURCE_URL = 'https://dkan-default-content-files.s3.amazonaws.com/phpunit/district_centerpoints_small.csv';
+  protected const SOURCE_URL = 'https://dkan-default-content-files.s3.amazonaws.com/phpunit/district_centerpoints_small.csv';
 
   /**
    * {@inheritdoc}

diff --git a/modules/datastore/tests/src/Kernel/Service/Info/ImportInfoTest.php b/modules/datastore/tests/src/Kernel/Service/Info/ImportInfoTest.php
@@ -31,7 +31,7 @@ class ImportInfoTest extends KernelTestBase {
    */
   const HOST = 'http://example.com';
 
-  const SOURCE_URL = 'https://dkan-default-content-files.s3.amazonaws.com/phpunit/district_centerpoints_small.csv';
+  protected const SOURCE_URL = 'https://dkan-default-content-files.s3.amazonaws.com/phpunit/district_centerpoints_small.csv';
 
   public function testFileSize() {
     $source_resource = new DataResource(

diff --git a/modules/datastore/tests/src/Kernel/Service/ResourceLocalizerTest.php b/modules/datastore/tests/src/Kernel/Service/ResourceLocalizerTest.php
@@ -33,7 +33,7 @@ class ResourceLocalizerTest extends KernelTestBase {
    */
   const HOST = 'http://example.com';
 
-  const SOURCE_URL = 'https://dkan-default-content-files.s3.amazonaws.com/phpunit/district_centerpoints_small.csv';
+  protected const SOURCE_URL = 'https://dkan-default-content-files.s3.amazonaws.com/phpunit/district_centerpoints_small.csv';
 
   public function testNoResourceFound() {
     $service = $this->container->get('dkan.datastore.service.resource_localizer');

diff --git a/modules/datastore/tests/src/Unit/Plugin/QueueWorker/TestMemStorage.php b/modules/datastore/tests/src/Unit/Plugin/QueueWorker/TestMemStorage.php
@@ -23,10 +23,7 @@ public function primaryKey() { }
 
     public function retrieve(string $id)
     {
-        if (isset($this->storage[$id])) {
-            return $this->storage[$id];
-        }
-        return null;
+        return $this->storage[$id] ?? null;
     }
 
     public function retrieveAll(): array

diff --git a/modules/dkan_js_frontend/dkan_js_frontend.module b/modules/dkan_js_frontend/dkan_js_frontend.module
@@ -34,15 +34,15 @@ function dkan_js_frontend_library_info_build() {
   foreach(glob(\Drupal::root() . $js_path . '*.js') as $full_path) {
     $basename = basename($full_path);
     $libraries['dkan_js_frontend']['js'][$js_path . $basename] = [
-      "minified" => isset($minified) ? $minified : false,
-      "preprocess" => isset($preprocess) ? $preprocess : true,
+      "minified" => $minified ?? false,
+      "preprocess" => $preprocess ?? true,
     ];
   }
   foreach(glob(\Drupal::root() . $css_path . '*.css') as $full_path) {
     $basename = basename($full_path);
     $libraries['dkan_js_frontend']['css']['theme'][$css_path . $basename] = [
-      "minified" => isset($minified) ? $minified : false,
-      "preprocess" => isset($preprocess) ? $preprocess : true,
+      "minified" => $minified ?? false,
+      "preprocess" => $preprocess ?? true,
     ];
   }
   $libraries['dkan_js_frontend']['dependencies'] = [