-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5 from OS2Forms/feature/FORMS-984-rest-webform-al…
…l-submissions FORMS-984: Added rest webform endpoint for getting all submissions
- Loading branch information
Showing
5 changed files
with
259 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| <?php | ||
|
|
||
| namespace Drupal\os2forms_rest_api\Plugin\rest\resource; | ||
|
|
||
| use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException; | ||
| use Drupal\Component\Plugin\Exception\PluginNotFoundException; | ||
| use Drupal\Core\Url; | ||
| use Drupal\os2forms_rest_api\WebformHelper; | ||
| use Drupal\rest\ModifiedResourceResponse; | ||
| use Drupal\rest\Plugin\ResourceBase; | ||
| use Symfony\Component\DependencyInjection\ContainerInterface; | ||
| use Symfony\Component\HttpFoundation\Response; | ||
|
|
||
| /** | ||
| * Creates a rest resource for retrieving webform submissions. | ||
| * | ||
| * @RestResource( | ||
| * id = "webform_rest_form_submissions", | ||
| * label = @Translation("Webform - submissions for a form"), | ||
| * uri_paths = { | ||
| * "canonical" = "/webform_rest/{webform_id}/submissions" | ||
| * } | ||
| * ) | ||
| */ | ||
| class WebformAllFormSubmissions extends ResourceBase { | ||
| /** | ||
| * Allowed DateTime query parameters and their operation. | ||
| */ | ||
| private const ALLOWED_DATETIME_QUERY_PARAMS = [ | ||
| 'starttime' => '>=', | ||
| 'endtime' => '<=', | ||
| ]; | ||
|
|
||
| /** | ||
| * The current request. | ||
| * | ||
| * @var \Symfony\Component\HttpFoundation\Request | ||
| */ | ||
| private $currentRequest; | ||
|
|
||
| /** | ||
| * The entity type manager object. | ||
| * | ||
| * @var \Drupal\Core\Entity\EntityTypeManager | ||
| */ | ||
| private $entityTypeManager; | ||
|
|
||
| /** | ||
| * The webform helper. | ||
| * | ||
| * @var \Drupal\os2forms_rest_api\WebformHelper | ||
| */ | ||
| private $webformHelper; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| * | ||
| * @phpstan-param array<string, mixed> $configuration | ||
| */ | ||
| public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { | ||
| $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition); | ||
|
|
||
| $instance->entityTypeManager = $container->get('entity_type.manager'); | ||
| $instance->currentRequest = $container->get('request_stack')->getCurrentRequest(); | ||
| $instance->webformHelper = $container->get(WebformHelper::class); | ||
|
|
||
| return $instance; | ||
| } | ||
|
|
||
| /** | ||
| * Get submissions for a given webform. | ||
| * | ||
| * @param string $webform_id | ||
| * Webform ID. | ||
| * | ||
| * @return \Drupal\rest\ModifiedResourceResponse | ||
| * Response object. | ||
| */ | ||
| public function get(string $webform_id): ModifiedResourceResponse { | ||
| if (empty($webform_id)) { | ||
| $errors = [ | ||
| 'error' => [ | ||
| 'message' => 'Webform ID is required.', | ||
| ], | ||
| ]; | ||
| return new ModifiedResourceResponse($errors, Response::HTTP_BAD_REQUEST); | ||
| } | ||
|
|
||
| // Attempt finding webform. | ||
| $webform = $this->webformHelper->getWebform($webform_id); | ||
|
|
||
| if (NULL === $webform) { | ||
| $errors = [ | ||
| 'error' => [ | ||
| 'message' => $this->t('Could not find webform with id :webform_id', [':webform_id' => $webform_id]), | ||
| ], | ||
| ]; | ||
|
|
||
| return new ModifiedResourceResponse($errors, Response::HTTP_NOT_FOUND); | ||
| } | ||
|
|
||
| // Webform access check. | ||
| if (!$this->webformHelper->hasWebformAccess($webform, $this->webformHelper->getCurrentUser())) { | ||
| $errors = [ | ||
| 'error' => [ | ||
| 'message' => $this->t('Access denied'), | ||
| ], | ||
| ]; | ||
|
|
||
| return new ModifiedResourceResponse($errors, Response::HTTP_UNAUTHORIZED); | ||
| } | ||
|
|
||
| $result = ['webform_id' => $webform_id]; | ||
|
|
||
| try { | ||
| $submissionEntityStorage = $this->entityTypeManager->getStorage('webform_submission'); | ||
| } | ||
| catch (InvalidPluginDefinitionException | PluginNotFoundException $e) { | ||
| $errors = [ | ||
| 'error' => [ | ||
| 'message' => $this->t('Could not load webform submission storage'), | ||
| ], | ||
| ]; | ||
|
|
||
| return new ModifiedResourceResponse($errors, Response::HTTP_INTERNAL_SERVER_ERROR); | ||
| } | ||
|
|
||
| // Query for webform submissions with this webform_id. | ||
| $submissionQuery = $submissionEntityStorage->getQuery() | ||
| ->condition('webform_id', $webform_id); | ||
|
|
||
| $requestQuery = $this->currentRequest->query; | ||
|
|
||
| foreach (self::ALLOWED_DATETIME_QUERY_PARAMS as $param => $operator) { | ||
| $value = $requestQuery->get($param); | ||
|
|
||
| if (!empty($value)) { | ||
| try { | ||
| $dateTime = new \DateTimeImmutable($value); | ||
| $submissionQuery->condition('created', $dateTime->getTimestamp(), $operator); | ||
| $result[$param] = $value; | ||
| } | ||
| catch (\Exception $e) { | ||
| $errors = [ | ||
| 'error' => [ | ||
| 'message' => $this->t('Invalid :param: :value', [':param' => $param, ':value' => $value]), | ||
| ], | ||
| ]; | ||
|
|
||
| return new ModifiedResourceResponse($errors, Response::HTTP_BAD_REQUEST); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Complete query. | ||
| $submissionQuery->accessCheck(FALSE); | ||
| $sids = $submissionQuery->execute(); | ||
|
|
||
| // Generate submission URLs. | ||
| try { | ||
| $result['submissions'] = array_map( | ||
| static fn($submission) => Url::fromRoute( | ||
| 'rest.webform_rest_submission.GET', | ||
| [ | ||
| 'webform_id' => $webform_id, | ||
| 'uuid' => $submission->uuid(), | ||
| ] | ||
| ) | ||
| ->setAbsolute() | ||
| ->toString(TRUE)->getGeneratedUrl(), | ||
| $submissionEntityStorage->loadMultiple($sids ?: []) | ||
| ); | ||
| } | ||
| catch (\Exception $e) { | ||
| $errors = [ | ||
| 'error' => [ | ||
| 'message' => $this->t('Could not generate submission URLs'), | ||
| ], | ||
| ]; | ||
|
|
||
| return new ModifiedResourceResponse($errors, Response::HTTP_INTERNAL_SERVER_ERROR); | ||
| } | ||
|
|
||
| return new ModifiedResourceResponse($result); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters