vendor/api-platform/core/src/Symfony/EventListener/WriteListener.php line 56

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\Symfony\EventListener;
  16. use ApiPlatform\Api\IriConverterInterface;
  17. use ApiPlatform\Api\ResourceClassResolverInterface;
  18. use ApiPlatform\Api\UriVariablesConverterInterface;
  19. use ApiPlatform\Exception\InvalidIdentifierException;
  20. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  21. use ApiPlatform\State\ProcessorInterface;
  22. use ApiPlatform\State\UriVariablesResolverTrait;
  23. use ApiPlatform\Util\ClassInfoTrait;
  24. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  25. use ApiPlatform\Util\RequestAttributesExtractor;
  26. use Symfony\Component\HttpFoundation\Response;
  27. use Symfony\Component\HttpKernel\Event\ViewEvent;
  28. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  30. /**
  31.  * Bridges persistence and the API system.
  32.  *
  33.  * @author Kévin Dunglas <dunglas@gmail.com>
  34.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  35.  */
  36. final class WriteListener
  37. {
  38.     use ClassInfoTrait;
  39.     use OperationRequestInitiatorTrait;
  40.     use UriVariablesResolverTrait;
  42.     public function __construct(
  43.         private readonly ProcessorInterface $processor,
  44.         private readonly IriConverterInterface $iriConverter,
  45.         private readonly ResourceClassResolverInterface $resourceClassResolver,
  46.         ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null,
  47.         ?UriVariablesConverterInterface $uriVariablesConverter = null,
  48.     ) {
  49.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  50.         $this->uriVariablesConverter = $uriVariablesConverter;
  51.     }
  53.     /**
  54.      * Persists, updates or delete data return by the controller if applicable.
  55.      */
  56.     public function onKernelView(ViewEvent $event): void
  57.     {
  58.         $controllerResult = $event->getControllerResult();
  59.         $request = $event->getRequest();
  60.         $operation = $this->initializeOperation($request);
  62.         if (
  63.             $controllerResult instanceof Response
  64.             || $request->isMethodSafe()
  65.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  66.         ) {
  67.             return;
  68.         }
  70.         if (!$attributes['persist'] || !($operation?->canWrite() ?? true)) {
  71.             return;
  72.         }
  74.         if (!$operation?->getProcessor()) {
  75.             return;
  76.         }
  78.         $context = [
  79.             'operation' => $operation,
  80.             'resource_class' => $attributes['resource_class'],
  81.             'previous_data' => $attributes['previous_data'] ?? null,
  82.         ];
  84.         try {
  85.             $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $attributes['resource_class']);
  86.         } catch (InvalidIdentifierException $e) {
  87.             throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
  88.         }
  90.         switch ($request->getMethod()) {
  91.             case 'PUT':
  92.             case 'PATCH':
  93.             case 'POST':
  94.                 $persistResult = $this->processor->process($controllerResult, $operation, $uriVariables, $context);
  96.                 if ($persistResult) {
  97.                     $controllerResult = $persistResult;
  98.                     $event->setControllerResult($controllerResult);
  99.                 }
  101.                 if ($controllerResult instanceof Response) {
  102.                     break;
  103.                 }
  105.                 $outputMetadata = $operation->getOutput() ?? ['class' => $attributes['resource_class']];
  106.                 $hasOutput = \is_array($outputMetadata) && \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];
  107.                 if (!$hasOutput) {
  108.                     break;
  109.                 }
  111.                 if ($this->resourceClassResolver->isResourceClass($this->getObjectClass($controllerResult))) {
  112.                     $request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromResource($controllerResult));
  113.                 }
  115.                 break;
  116.             case 'DELETE':
  117.                 $this->processor->process($controllerResult, $operation, $uriVariables, $context);
  118.                 $event->setControllerResult(null);
  119.                 break;
  120.         }
  121.     }
  122. }