OS-110 phpcs formatting

Author: stankut

modules/os2forms_digital_signature/README.md

@@ -11,15 +11,17 @@ This module provides functionality for adding digital signature to the webform P
 1. Add the OS2forms attachment element to the form.
 2. Indicate that the OS2Forms attachment requires a digital signature.
 3. Add the Digital Signature Handler to the webform.
-4. If the form requires an email handler, ensure the trigger is set to **...when submission is locked** in the handler’s *Additional settings*.
+4. If the form requires an email handler, ensure the trigger is set to **...when submission is locked** in the handler’s
+*Additional settings*.
 
 ### Flow Explained
 
 1. Upon form submission, a PDF is generated, saved in the private directory, and sent to the signature service via URL.
 2. The user is redirected to the signature service to provide their signature.
 3. After signing, the user is redirected back to the webform solution.
 4. The signed PDF is downloaded and stored in Drupal’s private directory.
-5. When a submission PDF is requested (e.g., via download link or email), the signed PDF is served instead of generating a new one on the fly.
+5. When a submission PDF is requested (e.g., via download link or email), the signed PDF is served instead of generating
+a new one on the fly.
 
 ## Settings page
 
@@ -29,12 +31,10 @@ URL: `admin/os2forms_digital_signature/settings`
 
   The URL of the service providing digital signature. This is the example of a known service https://signering.bellcom.dk/sign.php?
 
-
 - **Hash Salt used for signature**
 
   Must match hash salt on the signature server
 
-
 - **List IPs which can download unsigned PDF submissions**
 
   Only requests from this IP will be able to download PDF which are to be signed.

modules/os2forms_digital_signature/os2forms_digital_signature.module

@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * @file
+ * This module enables Digital Signature functionality for Webforms.
+ */
+
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\StreamWrapper\StreamWrapperManager;
 use Drupal\os2forms_digital_signature\Form\SettingsForm;
@@ -33,7 +38,7 @@ function os2forms_digital_signature_webform_submission_form_alter(array &$form,
       $settings = $config->get('settings');
 
       // Checking if the title has not been overridden.
-      if ($settings['default_submit_button_label'] == $form['actions']['submit']['#value']){
+      if ($settings['default_submit_button_label'] == $form['actions']['submit']['#value']) {
         $form['actions']['submit']['#value'] = t('Sign and submit');
       }
     }

modules/os2forms_digital_signature/os2forms_digital_signature.routing.yml

@@ -13,4 +13,3 @@ os2forms_digital_signature.settings:
     _title: 'Digital signature settings'
   requirements:
     _permission: 'administer site configuration'
-

modules/os2forms_digital_signature/src/Controller/DigitalSignatureController.php

@@ -6,11 +6,12 @@
 use Drupal\Core\File\FileSystemInterface;
 use Drupal\Core\Url;
 use Drupal\file\Entity\File;
-use Drupal\os2forms_digital_signature\Service\SigningService;
-use Drupal\webform\WebformSubmissionInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
+/**
+ * Digital Signature Controller.
+ */
 class DigitalSignatureController {
 
   /**
@@ -29,14 +30,14 @@ public function __construct() {
    *
    * Expecting the file name to be coming as GET parameter.
    *
-   * @param $uuid
+   * @param string $uuid
    *   Webform submission UUID.
-   * @param $hash
-   *    Hash to check if the request is authentic.
-   * @param $fid
-   *    File to replace (optional).
+   * @param string $hash
+   *   Hash to check if the request is authentic.
+   * @param int|null $fid
+   *   File to replace (optional).
    *
-   * @return RedirectResponse
+   * @return \Symfony\Component\HttpFoundation\RedirectResponse
    *   Redirect response to form submission confirmation.
    *
    * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
@@ -49,7 +50,7 @@ public function signCallback($uuid, $hash, $fid = NULL) {
       ->loadByProperties(['uuid' => $uuid]);
 
     // Since loadByProperties returns an array, we need to fetch the first item.
-    /** @var WebformSubmissionInterface $webformSubmission */
+    /** @var \Drupal\webform\WebformSubmissionInterface $webformSubmission */
     $webformSubmission = $submissions ? reset($submissions) : NULL;
     if (!$webformSubmission) {
       // Submission does not exist.
@@ -58,7 +59,7 @@ public function signCallback($uuid, $hash, $fid = NULL) {
 
     $webformId = $webformSubmission->getWebform()->id();
 
-    // Checking the action
+    // Checking the action.
     $action = \Drupal::request()->query->get('action');
     if ($action == 'cancel') {
       $cancelUrl = $webformSubmission->getWebform()->toUrl()->toString();
@@ -76,7 +77,7 @@ public function signCallback($uuid, $hash, $fid = NULL) {
       throw new NotFoundHttpException();
     }
 
-    /** @var SigningService $signingService */
+    /** @var \Drupal\os2forms_digital_signature\Service\SigningService $signingService */
     $signingService = \Drupal::service('os2forms_digital_signature.signing_service');
 
     $signedFilename = \Drupal::request()->get('file');
@@ -86,14 +87,16 @@ public function signCallback($uuid, $hash, $fid = NULL) {
       throw new NotFoundHttpException();
     }
 
-    /** @var FileSystemInterface $file_system */
+    /** @var \Drupal\Core\File\FileSystemInterface $file_system */
     $file_system = \Drupal::service('file_system');
 
-    // If $fid is present - we are replacing uploaded/managed file, otherwise creating a new one.
+    // If $fid is present - we are replacing uploaded/managed file, otherwise
+    // creating a new one.
     if ($fid) {
       $file = File::load($fid);
       $expectedFileUri = $file->getFileUri();
-    } else {
+    }
+    else {
       // Prepare the directory to ensure it exists and is writable.
       $expectedFileUri = "private://webform/$webformId/digital_signature/$uuid.pdf";
       $directory = dirname($expectedFileUri);
@@ -105,7 +108,7 @@ public function signCallback($uuid, $hash, $fid = NULL) {
 
     // Write the data to the file using Drupal's file system service.
     try {
-      $file_system->saveData($signedFileContent, $expectedFileUri , FileSystemInterface::EXISTS_REPLACE);
+      $file_system->saveData($signedFileContent, $expectedFileUri, FileSystemInterface::EXISTS_REPLACE);
 
       // Updating webform submission.
       $webformSubmission->setLocked(TRUE);
@@ -117,7 +120,11 @@ public function signCallback($uuid, $hash, $fid = NULL) {
       }
     }
     catch (\Exception $e) {
-      $this->logger->error('Failed to write to file %uri: @message', ['%uri' => $expectedFileUri, '@message' => $e->getMessage()]);
+      $this->logger->error('Failed to write to file %uri: @message',
+        [
+          '%uri' => $expectedFileUri,
+          '@message' => $e->getMessage(),
+        ]);
     }
 
     // Build the URL for the webform submission confirmation page.

modules/os2forms_digital_signature/src/Element/DigitalSignatureDocument.php

@@ -2,11 +2,10 @@
 
 namespace Drupal\os2forms_digital_signature\Element;
 
-
 use Drupal\webform\Element\WebformManagedFileBase;
 
 /**
- * Provides a webform element for an 'os2forms_digital_signature_document' element.
+ * Provides a element for an 'os2forms_digital_signature_document' element.
  *
  * @FormElement("os2forms_digital_signature_document")
  */

modules/os2forms_digital_signature/src/Form/SettingsForm.php

@@ -79,4 +79,5 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
 
     parent::submitForm($form, $form_state);
   }
+
 }

modules/os2forms_digital_signature/src/Plugin/WebformElement/DigitalSignatureDocument.php

@@ -33,11 +33,10 @@ public function getItemFormats() {
   /**
    * {@inheritdoc}
    */
-  protected function getFileExtensions(array $element = NULL) {
+  protected function getFileExtensions(?array $element = NULL) {
     return 'pdf';
   }
 
-
   /**
    * {@inheritdoc}
    */

modules/os2forms_digital_signature/src/Plugin/WebformHandler/DigitalSignatureWebformHandler.php

@@ -6,14 +6,12 @@
 use Drupal\Core\File\FileExists;
 use Drupal\Core\File\FileSystemInterface;
 use Drupal\Core\Url;
-use Drupal\file\FileInterface;
-use Drupal\os2forms_digital_signature\Service\SigningService;
 use Drupal\webform\Plugin\WebformHandlerBase;
 use Drupal\webform\WebformSubmissionInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * Webform submission debug handler.
+ * Digital signature webform handler.
  *
  * @WebformHandler(
  *   id = "os2forms_digital_signature",
@@ -68,8 +66,8 @@ public static function create(ContainerInterface $container, array $configuratio
   }
 
   /**
-    * {@inheritdoc}
-    */
+   * {@inheritdoc}
+   */
   public function preSave(WebformSubmissionInterface $webform_submission) {
     $webform = $webform_submission->getWebform();
 
@@ -79,7 +77,12 @@ public function preSave(WebformSubmissionInterface $webform_submission) {
 
     $attachment = $this->getSubmissionAttachment($webform_submission);
     if (!$attachment) {
-      $this->logger->error('Attachment cannot be created webform: %webform, webform_submission: %webform_submission', ['%webform' => $webform->id(), '%webform_submission' => $webform_submission->uuid()]);
+      $this->logger->error('Attachment cannot be created webform: %webform, webform_submission: %webform_submission',
+        [
+          '%webform' => $webform->id(),
+          '%webform_submission' => $webform_submission->uuid(),
+        ]
+      );
       return;
     }
 
@@ -89,25 +92,29 @@ public function preSave(WebformSubmissionInterface $webform_submission) {
       return;
     }
 
-    $fileUri = $destinationDir . '/' . $webform_submission->uuid() .'.pdf';
+    $fileUri = $destinationDir . '/' . $webform_submission->uuid() . '.pdf';
 
     // Save the file data.
     try {
-      /** @var FileInterface $fileToSign */
+      /** @var \Drupal\file\FileInterface $fileToSign */
       $fileToSign = \Drupal::service('file.repository')->writeData($attachment['filecontent'], $fileUri, FileExists::Replace);
     }
     catch (\Exception $e) {
-      $this->logger->error('File cannot be saved: %fileUri, error: %error', ['%fileUri' => $fileUri, '%error' => $e->getMessage()]);
+      $this->logger->error('File cannot be saved: %fileUri, error: %error',
+        [
+          '%fileUri' => $fileUri,
+          '%error' => $e->getMessage(),
+        ]);
       return;
     }
 
     $fileToSign->save();
     $fileToSignPublicUrl = \Drupal::service('file_url_generator')->generateAbsoluteString($fileToSign->getFileUri());
 
-    /** @var SigningService $signingService */
+    /** @var \Drupal\os2forms_digital_signature\Service\SigningService $signingService */
     $signingService = \Drupal::service('os2forms_digital_signature.signing_service');
 
-    $cid = $signingService->get_cid();
+    $cid = $signingService->getCid();
     if (empty($cid)) {
       $this->logger->error('Failed to obtain cid. Is server running?');
       return;
@@ -118,20 +125,28 @@ public function preSave(WebformSubmissionInterface $webform_submission) {
     $hash = Crypt::hashBase64($webform_submission->uuid() . $webform->id() . $salt);
 
     $attachmentFid = $attachment['fid'] ?? NULL;
-    $signatureCallbackUrl = Url::fromRoute('os2forms_digital_signature.sign_callback', ['uuid' => $webform_submission->uuid(), 'hash' => $hash, 'fid' => $attachmentFid]);
-
-    // Starting signing, if everything is correct - this funcition will start redirect.
+    $signatureCallbackUrl = Url::fromRoute('os2forms_digital_signature.sign_callback',
+      [
+        'uuid' => $webform_submission->uuid(),
+        'hash' => $hash,
+        'fid' => $attachmentFid,
+      ]
+    );
+
+    // Starting signing, if everything is correct - this funcition will start
+    // redirect.
     $signingService->sign($fileToSignPublicUrl, $cid, $signatureCallbackUrl->setAbsolute()->toString());
   }
 
   /**
    * Get OS2forms file attachment.
    *
    * @param \Drupal\webform\WebformSubmissionInterface $webform_submission
-   *    A webform submission.
+   *   A webform submission.
    *
    * @return array|null
-   *    Array of attachment data.
+   *   Array of attachment data.
+   *
    * @throws \Exception
    */
   protected function getSubmissionAttachment(WebformSubmissionInterface $webform_submission) {
@@ -140,8 +155,8 @@ protected function getSubmissionAttachment(WebformSubmissionInterface $webform_s
 
     // Getting all element types that are added to the webform.
     //
-    // Priority is the following: check for os2forms_digital_signature_document, is not found try serving
-    // os2forms_attachment
+    // Priority is the following: check for os2forms_digital_signature_document,
+    // is not found try serving os2forms_attachment.
     $elementTypes = array_column($this->getWebform()->getElementsDecodedAndFlattened(), '#type');
     $attachmentType = '';
     if (in_array('os2forms_digital_signature_document', $elementTypes)) {
@@ -154,7 +169,8 @@ protected function getSubmissionAttachment(WebformSubmissionInterface $webform_s
     $elements = $this->getWebform()->getElementsInitializedAndFlattened();
     $element_attachments = $this->getWebform()->getElementsAttachments();
     foreach ($element_attachments as $element_attachment) {
-      // Check if the element attachment key is excluded and should not attach any files.
+      // Check if the element attachment key is excluded and should not attach
+      // any files.
       if (isset($this->configuration['excluded_elements'][$element_attachment])) {
         continue;
       }