OS2FORMS-380 Fixed coding standards issues

Author: andriyun

CHANGELOG.md

@@ -11,6 +11,7 @@ before starting to add changes.
 
 ### Added
 - Github CI action for checking Drupal Coding standards with PHP Code Sniffer
+- Fixed coding standards issues
 
 
 ## Example of change log record

css/gin-custom.css

@@ -1,3 +1,3 @@
 .ui-dialog:not(.ui-dialog-off-canvas) {
-    width: 70vw!important;
+  width: 70vw!important;
 }

os2forms_forloeb.info.yml

@@ -6,51 +6,51 @@ core: 8.x
 core_version_requirement: ^8 || ^9
 
 dependencies:
-  - admin_toolbar_tools
-  - coc_forms_auto_export
-  - config_entity_revisions
-  - diff
-  - entity_print
-  - eu_cookie_compliance
-  - events_logging
-  - gin_toolbar
-  - honeypot
-  - libraries
-  - maestro
-  - mailsystem
-  - masquerade
-  - os2forms
-  - os2forms_nemid
-  - os2forms_dawa
-  - os2forms_sbsys
-  - os2web_simplesaml
-  - pathauto
-  - r4032login
-  - redirect
-  - smtp
-  - system
-  - switch_page_theme
-  - token
-  - ultimate_cron
-  - user_default_page
-  - webform
-  - webform_ui
-  - webform_access
-  - webform_attachment
-  - webform_composite
-  - webform_embed
-  - webform_entity_print
-  - webform_entity_print_attachment
-  - webform_migrate
-  - webform_node_element
-  - webform_remote_handlers
-  - webform_rest
-  - webform_revisions
-  - webform_share
-  - webform_scheduled_email
-  - webform_submission_export_import
-  - webform_submission_log
-  - webform_templates
-  - workflow_participants
+  - 'drupal:admin_toolbar_tools'
+  - 'drupal:coc_forms_auto_export'
+  - 'drupal:config_entity_revisions'
+  - 'drupal:diff'
+  - 'drupal:entity_print'
+  - 'drupal:eu_cookie_compliance'
+  - 'drupal:events_logging'
+  - 'drupal:gin_toolbar'
+  - 'drupal:honeypot'
+  - 'drupal:libraries'
+  - 'drupal:maestro'
+  - 'drupal:mailsystem'
+  - 'drupal:masquerade'
+  - 'drupal:os2forms'
+  - 'drupal:os2forms_nemid'
+  - 'drupal:os2forms_dawa'
+  - 'drupal:os2forms_sbsys'
+  - 'drupal:os2web_simplesaml'
+  - 'drupal:pathauto'
+  - 'drupal:r4032login'
+  - 'drupal:redirect'
+  - 'drupal:smtp'
+  - 'drupal:system'
+  - 'drupal:switch_page_theme'
+  - 'drupal:token'
+  - 'drupal:ultimate_cron'
+  - 'drupal:user_default_page'
+  - 'drupal:webform'
+  - 'drupal:webform_ui'
+  - 'drupal:webform_access'
+  - 'drupal:webform_attachment'
+  - 'drupal:webform_composite'
+  - 'drupal:webform_embed'
+  - 'drupal:webform_entity_print'
+  - 'drupal:webform_entity_print_attachment'
+  - 'drupal:webform_migrate'
+  - 'drupal:webform_node_element'
+  - 'drupal:webform_remote_handlers'
+  - 'drupal:webform_rest'
+  - 'drupal:webform_revisions'
+  - 'drupal:webform_share'
+  - 'drupal:webform_scheduled_email'
+  - 'drupal:webform_submission_export_import'
+  - 'drupal:webform_submission_log'
+  - 'drupal:webform_templates'
+  - 'drupal:workflow_participants'
 'interface translation project': os2forms_forloeb
 'interface translation server pattern': modules/contrib/os2forms_forloeb/translations/os2forms_forloeb.da.po

os2forms_forloeb.module

@@ -1,5 +1,12 @@
 <?php
 
+/**
+ * @file
+ * Install, update and uninstall functions for the os2forms_forloeb.
+ */
+
+use Drupal\Core\Session\AccountInterface;
+use Drupal\Core\Entity\EntityInterface;
 use Drupal\webform\WebformInterface;
 use Drupal\Core\Access\AccessResult;
 use Drupal\Core\Form\FormStateInterface;
@@ -10,12 +17,9 @@ use Drupal\webform\Entity\WebformSubmission;
 use Drupal\user\Entity\User;
 
 /**
- * @file
- * Install, update and uninstall functions for the os2forms_forloeb_profile installation profile.
- */
-
-/**
- * Implements hook_maestro_interactive_handlers() for the return of an Array
+ * Implements hook_maestro_interactive_handlers().
+ *
+ * Handler for the return of an Array
  * of function names and help text that will be displayed in the edit task
  * form under the handler field.
  */
@@ -35,70 +39,75 @@ function os2forms_forloeb_maestro_interactive_handlers() {
  * @param int $queueID
  *   The queueID from Maestro.
  */
-function os2forms_forloeb_workflow_maestro_reassign_form(&$form, $obj, $queueID = 0) {
+function os2forms_forloeb_workflow_maestro_reassign_form(array &$form, $obj, $queueID = 0) {
 
-  $form['reviewer'] = array(
+  $form['reviewer'] = [
     '#id' => 'select_assigned_user',
     '#type' => 'entity_autocomplete',
     '#target_type' => 'user',
     '#default_value' => '',
     '#selection_settings' => ['include_anonymous' => FALSE],
-    '#title' =>  t('Assign for Review to'),
-  );
+    '#title' => t('Assign for Review to'),
+  ];
 
-  $form['queueID'] = array(
+  $form['queueID'] = [
     '#type' => 'hidden',
     '#title' => 'the queue ID in the event we need it in later processing',
     '#default_value' => $queueID,
     '#description' => ('queueID'),
-  );
+  ];
 
-  //overriding the default label "complete"
+  // Overriding the default label "complete".
   $form['actions']['submit']['#value'] = t('Assign');
 
   return $form;
 }
 
-
 /**
- * This is the submit handler for the Reassign for Approval form use in maestro workflows.
+ * Submit handler for The Reassign for Approval form.
+ *
+ * This is the submit handler for the Reassign for Approval form
+ * used in maestro workflows.
  */
 function os2forms_forloeb_workflow_maestro_reassign_form_submit(&$form, &$form_state) {
 
   $queueID = intval($form_state->getValue('queueID'));
   $processID = MaestroEngine::getProcessIdFromQueueId($queueID);
 
-  //Who was selected? Load their username, which is the user attribute that Maestro assigns tasks by.
+  // Who was selected? Load their username, which is the user attribute
+  // that Maestro assigns tasks by.
   $reviewer_uid = $form_state->getValue('reviewer');
-  $reviewer = User::load($reviewer_uid); // pass your uid
+  // Pass your uid.
+  $reviewer = User::load($reviewer_uid);
   $reviewer_username = $reviewer->getAccountName();
 
-  //add that user to our maestro process variable.
+  // Add that user to our maestro process variable.
   MaestroEngine::setProcessVariable("assigned_to", $reviewer_username, $processID);
 
-  //Provide some feedback
+  // Provide some feedback.
   \Drupal::messenger()->addStatus("Content Reassigned");
-
 }
 
 /**
- *  * Implements hook_maestro_batch_handlers().
- *   *
- *    * Array of function names and help text that will be displayed
- *     * in the edit task form under the handler field.
- *      */
+ * Implements hook_maestro_batch_handlers().
+ *
+ * Array of function names and help text that will be displayed
+ * in the edit task form under the handler field.
+ */
 function os2forms_forloeb_maestro_batch_handlers() {
   return [
     'end_notification_batch_function' => t('Batch function to send out flow completion notification to initiator.'),
   ];
 }
 
 /**
- *  * @param int $processID
- *   *   The Maestro process ID.
- *    * @param int $queueID
- *     *   The Maestro queue ID.
- *      */
+ * Finishing callback for batch handler.
+ *
+ * @param int $processID
+ *   The Maestro process ID.
+ * @param int $queueID
+ *   The Maestro queue ID.
+ */
 function end_notification_batch_function($processID, $queueID) {
 
   /*
@@ -116,7 +125,7 @@ function end_notification_batch_function($processID, $queueID) {
 
   if ($sid) {
     $webform_submission = WebformSubmission::load($sid);
-    $webform =  $webform_submission->getWebform();
+    $webform = $webform_submission->getWebform();
     $handlers = $webform->getHandlers();
 
     foreach ($handlers as $handler) {
@@ -131,27 +140,29 @@ function end_notification_batch_function($processID, $queueID) {
 }
 
 /**
- * Implements hook_ENTITY_TYPE_create()
+ * Implements hook_ENTITY_TYPE_create().
+ *
  * Sets a global purge setting for all webform submissions to 30 days.
  */
 function os2forms_forloeb_webform_create(WebformInterface $webform) {
-    // Set purge of all users submissions.
-    $webform->setSetting('purge', 'all');
-    // Set purge of submissions more than 30 days old.
-    if (empty($webform->getSetting('purge_days'))) {
-        $webform->setSetting('purge_days', '30');
-    }
+  // Set purge of all users submissions.
+  $webform->setSetting('purge', 'all');
+  // Set purge of submissions more than 30 days old.
+  if (empty($webform->getSetting('purge_days'))) {
+    $webform->setSetting('purge_days', '30');
+  }
 }
 
 /**
- * Implements hook_ENTITY_TYPE_presave()
+ * Implements hook_ENTITY_TYPE_presave().
+ *
  * Update webform specific submissions purge settings.
  */
 function os2forms_forloeb_webform_presave(WebformInterface $webform) {
-    // Add a purge time frame if not set.
-    if (empty($webform->getSetting('purge_days'))) {
-        $webform->setSetting('purge_days', 30);
-    }
+  // Add a purge time frame if not set.
+  if (empty($webform->getSetting('purge_days'))) {
+    $webform->setSetting('purge_days', 30);
+  }
 }
 
 /**
@@ -203,8 +214,7 @@ function os2forms_forloeb_spv_fetch_entity_username($uniqueWebformIdentifier, $w
 }
 
 /**
- * Returns array of custom task-types for OS2forms
- *
+ * Returns array of custom task-types for OS2forms.
  */
 function os2forms_forloeb_get_custom_task_types() {
   return ['MaestroWebformMultiple', 'MaestroWebformInherit'];
@@ -216,28 +226,29 @@ function os2forms_forloeb_get_custom_task_types() {
  * This has been copied from
  * maestro/maestro_webform/maestro_webform.module with a minimal but
  * necessary change. See https://www.drupal.org/project/maestro/issues/3243510
- * When that issue has been fixed, this hook implementation can be safely deleted.
- *
+ * When that issue has been fixed, this hook implementation
+ * can be safely deleted.
  */
 function os2forms_forloeb_form_alter(&$form, FormStateInterface $form_state, $form_id) {
   $queueID = intval(\Drupal::request()->query->get('queueid', 0));
   $isMaestro = intval(\Drupal::request()->query->get('maestro', 0));
   // Both these keys need to exist.
   if ($isMaestro && $queueID) {
     $templateTask = MaestroEngine::getTemplateTaskByQueueID($queueID);
-    // Get array of custom task-types
+    // Get array of custom task-types.
     $os2forms_forloeb_custom_task_types = os2forms_forloeb_get_custom_task_types();
-    // We only care about custom Task-types defined in os2forms_forloeb_get_custom_task_types()
+    // We only care about custom Task-types
+    // defined in os2forms_forloeb_get_custom_task_types()
     if ($templateTask && in_array($templateTask['tasktype'], $os2forms_forloeb_custom_task_types)) {
       $storage = $form_state->getStorage();
       if ($storage && array_key_exists('form_display', $storage)) {
-        $webformTypes = \Drupal::entityTypeManager()->getStorage('node_type')->loadMultiple();
         $thisForm = $storage['form_display']->get('bundle');
         $targetEntityType = $storage['form_display']->get('targetEntityType');
         if ($isMaestro == 1 &&
             $targetEntityType == 'webform_submission' &&
             $templateTask['data']['webform_machine_name'] == $thisForm) {
-          // We now know this is a webform submission.  We are going to add in our own form fields here.
+          // We now know this is a webform submission.
+          // We are going to add in our own form fields here.
           $form['maestro'] = [
             '#tree' => TRUE,
           ];
@@ -268,8 +279,11 @@ function os2forms_forloeb_form_alter(&$form, FormStateInterface $form_state, $fo
   }
 }
 
+/**
+ * Implements hook_preprocess_page().
+ */
 function os2forms_forloeb_preprocess_page(&$variables) {
-    $variables['#attached']['library'][] = 'os2forms_forloeb/os2forms_forloeb';
+  $variables['#attached']['library'][] = 'os2forms_forloeb/os2forms_forloeb';
 }
 
 /**
@@ -304,9 +318,10 @@ function os2forms_forloeb_tokens($type, array $tokens, array $data, array $optio
 
 /**
  * Implements hook_entity_access().
+ *
  * Allows requests with tokens to view the entity.
  */
-function os2forms_forloeb_entity_access(\Drupal\Core\Entity\EntityInterface $entity, $operation, \Drupal\Core\Session\AccountInterface $account) {
+function os2forms_forloeb_entity_access(EntityInterface $entity, $operation, AccountInterface $account) {
   if ($operation == 'update' && $entity instanceof WebformSubmission) {
     $token = \Drupal::request()->query->get('os2forms-forloeb-ws-token');
     if ($token && $token === $entity->getToken()) {