Added AvailableWebform entity

Author: rimi-itk

src/Controller/WebformController.php

@@ -10,6 +10,7 @@
 use Drupal\Core\Routing\TrustedRedirectResponse;
 use Drupal\Core\Serialization\Yaml;
 use Drupal\Core\Url;
+use Drupal\os2forms_sync\Entity\AvailableWebform;
 use Drupal\os2forms_sync\Helper\ImportHelper;
 use Drupal\os2forms_sync\Helper\WebformHelper;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -79,14 +80,14 @@ public function index(): array {
     // Filter available webforms.
     switch ($this->requestStack->getCurrentRequest()->get(self::FILTER_QUERY_NAME)) {
       case self::FILTER_WEBFORMS_IMPORTED:
-        $webforms = array_filter($webforms, static function (array $webform) use ($importedWebforms) {
-          return isset($importedWebforms[$webform['links']['self']]);
+        $webforms = array_filter($webforms, static function (AvailableWebform $webform) use ($importedWebforms) {
+          return isset($importedWebforms[$webform->sourceUrl]);
         });
         break;
 
       case self::FILTER_WEBFORMS_NOT_IMPORTED:
-        $webforms = array_filter($webforms, static function (array $webform) use ($importedWebforms) {
-          return !isset($importedWebforms[$webform['links']['self']]);
+        $webforms = array_filter($webforms, static function (AvailableWebform $webform) use ($importedWebforms) {
+          return !isset($importedWebforms[$webform->sourceUrl]);
         });
         break;
     }
@@ -137,12 +138,12 @@ public function index(): array {
     }
     else {
       foreach ($webforms as $webform) {
-        $attributes = $webform['attributes'];
+        $attributes = $webform->attributes;
         $form = $this->webformHelper->getSubmissionForm($attributes['elements']);
         // Make sure that the form cannot be submitted (hopefully).
         $form['#attributes']['onsubmit'] = 'return false';
 
-        $sourceUrl = $webform['links']['self'];
+        $sourceUrl = $webform->sourceUrl;
         $importedWebform = $importedWebforms[$sourceUrl] ?? NULL;
 
         $item = [

src/Entity/AvailableWebform.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Drupal\os2forms_sync\Entity;
+
+/**
+ * Available webform.
+ */
+class AvailableWebform {
+  /**
+   * The webform id.
+   *
+   * @var string
+   */
+  public string $id;
+
+  /**
+   * The source url.
+   *
+   * @var string
+   */
+  public string $sourceUrl;
+
+  /**
+   * The attributes.
+   *
+   * @var array
+   *
+   * @phpstan-var array<string, mixed>
+   */
+  public array $attributes;
+
+  /**
+   * Constructor.
+   *
+   * @phpstan-param array<string, mixed> $data
+   */
+  public function __construct(array $data) {
+    $this->id = $data['id'];
+    $this->sourceUrl = $data['links']['self'];
+    $this->attributes = $data['attributes'];
+  }
+
+}

src/Helper/ImportHelper.php

@@ -9,6 +9,7 @@
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\Core\Serialization\Yaml;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\os2forms_sync\Entity\AvailableWebform;
 use Drupal\os2forms_sync\Entity\ImportedWebform;
 use Drupal\webform\Entity\Webform;
 use Drupal\webform\WebformEntityStorageInterface;
@@ -314,7 +315,8 @@ public function deleteWebform(WebformInterface $webform): void {
   /**
    * Get available published webforms.
    *
-   * @phpstan-return array<mixed>
+   * @return \Drupal\os2forms_sync\Entity\AvailableWebform[]|array
+   *   The available webforms.
    */
   public function getAvailableWebforms(): array {
     $sources = array_unique($this->settings->getSources());
@@ -329,16 +331,22 @@ public function getAvailableWebforms(): array {
     );
 
     if ($ttl > 0 && $hit = $this->cache->get($cacheKey)) {
-      return $hit->data;
+      $webforms = $hit->data;
     }
+    else {
+      $webforms = $this->fetchAvailableWebforms($sources);
 
-    $webforms = $this->fetchAvailableWebforms($sources);
-
-    if ($ttl > 0) {
-      $this->cache->set($cacheKey, $webforms, time() + $ttl);
+      if ($ttl > 0) {
+        $this->cache->set($cacheKey, $webforms, time() + $ttl);
+      }
     }
 
-    return $webforms;
+    return array_map(
+      static function ($webform) {
+        return new AvailableWebform($webform);
+      },
+      $webforms
+    );
   }
 
   /**
@@ -367,12 +375,10 @@ public function fetchAvailableWebforms(array $sources): array {
    * @param string $url
    *   The webform url.
    *
-   * @return array|null
+   * @return \Drupal\os2forms_sync\Entity\AvailableWebform|null
    *   The webform if any.
-   *
-   * @phpstan-return null|array<string, mixed>
    */
-  public function getAvailableWebform(string $url): ?array {
+  public function getAvailableWebform(string $url): ?AvailableWebform {
     $webforms = $this->getAvailableWebforms();
     foreach ($webforms as $webform) {
       if ($url === ($webform['links']['self'] ?? NULL)) {