Merge pull request #3 from itk-dev/feature/attachments-data

Attachments data

Author: rimi-itk

README.md

@@ -169,7 +169,28 @@ To make using the REST API easier we add linked data to `GET` responses:
 }
 ```
 
-### Technical details on linked data
+## Attachments
+
+Attachment elements are added to `GET` responses:
+
+```json
+{
+  …
+  "data": {
+    …
+    "attachments": {
+      "attachment_pdf": {
+        "name": "Attachment (pdf)",
+        "type": "pdf",
+        "url": "http://os2forms.example.com/da/webform/os2forms/submissions/42/attachment/pdf/pdf.pdf"
+      },
+      …
+    }
+  }
+}
+```
+
+### Technical details on linked data and attachments
 
 In order to add linked data, we apply a patch,
 [webform_rest_submission.patch](patches/webform_rest_submission.patch), to the

src/EventSubscriber/WebformSubmissionDataEventSubscriber.php

@@ -5,6 +5,8 @@
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\file\FileInterface;
 use Drupal\webform\WebformInterface;
+use Drupal\webform\WebformSubmissionInterface;
+use Drupal\webform_entity_print_attachment\Element\WebformEntityPrintAttachment;
 use Drupal\webform_rest\Event\WebformSubmissionDataEvent;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\LoggerInterface;
@@ -53,6 +55,11 @@ public function onWebformSubmissionDataEvent(WebformSubmissionDataEvent $event):
     if (!empty($linkedData)) {
       $event->setData($event->getData() + ['linked' => $linkedData]);
     }
+
+    $attachments = $this->buildAttachments($event->getWebformSubmission(), $event->getData());
+    if (!empty($attachments)) {
+      $event->setData($event->getData() + ['attachments' => $attachments]);
+    }
   }
 
   /**
@@ -115,6 +122,35 @@ private function buildLinked(WebformInterface $webform, array $data): array {
     return $linked;
   }
 
+  /**
+   * Builds attachment data.
+   *
+   * @phpstan-param array<string, mixed> $data
+   * @phpstan-return array<string, mixed>
+   */
+  private function buildAttachments(WebformSubmissionInterface $submission, array $data): array {
+    $attachments = [];
+
+    $webform = $submission->getWebform();
+    $attachmentElements = $webform->getElementsAttachments();
+
+    foreach ($attachmentElements as $key => $name) {
+      $element = $webform->getElement($key);
+
+      if (preg_match('/^webform_entity_print_attachment:(?<type>.+)/', $element['#type'] ?? '', $matches)) {
+        $type = $matches['type'];
+        $url = WebformEntityPrintAttachment::getFileUrl($element, $submission);
+        $attachments[$key] = [
+          'name' => $element['#title'] ?? $name,
+          'type' => $type,
+          'url' => $url->toString(TRUE)->getGeneratedUrl(),
+        ];
+      }
+    }
+
+    return $attachments;
+  }
+
   /**
    * {@inheritdoc}
    */