Merge pull request #8 from itk-dev/feature/add-submission-exists-filter

Added filter for existing submissions

Author: martinyde

os2forms_failed_jobs.module

@@ -53,6 +53,18 @@ function os2forms_failed_jobs_views_data(): array {
       'title' => t('Submission serial id'),
       'field' => 'id',
       'id' => 'advancedqueue_job_submission_serial',
+      'allow empty' => TRUE,
+    ],
+  ];
+
+  $data['advancedqueue']['webform_submission_serial_exists'] = [
+    'title' => t('Webform submission serial exists filter'),
+    'help' => t('Provides a filter for checking if webform submission exists from job'),
+    'filter' => [
+      'title' => t('Submission serial exists'),
+      'field' => 'id',
+      'id' => 'advancedqueue_job_submission_exists',
+      'allow empty' => TRUE,
     ],
   ];
 

src/Plugin/views/filter/SubmissionExistsFilter.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace Drupal\os2forms_failed_jobs\Plugin\views\filter;
+
+use Drupal\Core\Database\Connection;
+use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\os2forms_failed_jobs\Helper\Helper;
+use Drupal\views\Plugin\views\filter\StringFilter;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Filter by submission exists.
+ *
+ * @ingroup views_filter_handlers
+ *
+ * @ViewsFilter("advancedqueue_job_submission_exists")
+ */
+final class SubmissionExistsFilter extends StringFilter {
+
+  /**
+   * Class constructor.
+   *
+   * @phpstan-param array<string, mixed> $configuration
+   */
+  public function __construct(
+    $configuration,
+    $plugin_id,
+    $plugin_definition,
+    Connection $connection,
+    protected Helper $helper,
+    protected RouteMatchInterface $routeMatch
+  ) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition, $connection);
+  }
+
+  /**
+   * {@inheritdoc}
+   *
+   * @phpstan-param array<string, mixed> $configuration
+   */
+  public static function create(ContainerInterface $container, $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('database'),
+      $container->get(Helper::class),
+      $container->get('current_route_match'),
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function query(): void {
+    $this->ensureMyTable();
+
+    /** @var \Drupal\views\Plugin\views\query\Sql $query */
+    $query = $this->query;
+    $table = array_key_first($query->tables);
+
+    $webform = $this->routeMatch->getParameter('webform');
+
+    if ($webform) {
+      $jobs = [];
+      $jobIds = $this->helper->getQueueJobIds($webform->get('id'));
+      foreach ($jobIds as $job) {
+        if ($this->helper->getSubmissionSerialIdFromJob($job) > 0) {
+          $jobs[] = $job;
+        }
+      }
+      if (empty($jobs)) {
+        // The 'IN' operator requires a non empty array.
+        $jobs = [0];
+      }
+
+      $query->addWhere($this->options['group'], $table . '.job_id', $jobs, 'IN');
+    }
+  }
+
+}

src/Plugin/views/filter/SubmissionSerialFilter.php

@@ -58,17 +58,19 @@ public function query(): void {
     /** @var \Drupal\views\Plugin\views\query\Sql $query */
     $query = $this->query;
     $table = array_key_first($query->tables);
+
     $input = $this->value;
     $webform = $this->routeMatch->getParameter('webform');
 
-    $jobs = $this->helper->getQueueJobIdsFromSerial($input, $webform->get('id'));
+    if ($webform) {
+      $jobs = $this->helper->getQueueJobIdsFromSerial($input, $webform->get('id'));
+      if (empty($jobs)) {
+        // The 'IN' operator requires a non empty array.
+        $jobs = [0];
+      }
 
-    if (empty($jobs)) {
-      // The 'IN' operator requires a non empty array.
-      $jobs = [0];
+      $query->addWhere($this->options['group'], $table . '.job_id', $jobs, 'IN');
     }
-
-    $query->addWhere($this->options['group'], $table . '.job_id', $jobs, 'IN');
   }
 
 }