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

  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 const OPERATION_ATTRIBUTE_KEY = 'write';
  44.     public function __construct(private readonly ProcessorInterface $processor, private readonly IriConverterInterface $iriConverter, private readonly ResourceClassResolverInterface $resourceClassResolver, ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, ?UriVariablesConverterInterface $uriVariablesConverter = null)
  45.     {
  46.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  47.         $this->uriVariablesConverter = $uriVariablesConverter;
  48.     }
  50.     /**
  51.      * Persists, updates or delete data return by the controller if applicable.
  52.      */
  53.     public function onKernelView(ViewEvent $event): void
  54.     {
  55.         $controllerResult = $event->getControllerResult();
  56.         $request = $event->getRequest();
  57.         $operation = $this->initializeOperation($request);
  59.         if (
  60.             $controllerResult instanceof Response
  61.             || $request->isMethodSafe()
  62.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  63.         ) {
  64.             return;
  65.         }
  67.         if (!($operation?->canWrite() ?? true) || !$attributes['persist']) {
  68.             return;
  69.         }
  71.         if (!$operation?->getProcessor()) {
  72.             return;
  73.         }
  75.         $context = ['operation' => $operation, 'resource_class' => $attributes['resource_class'], 'previous_data' => $attributes['previous_data'] ?? null];
  76.         try {
  77.             $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $attributes['resource_class']);
  78.         } catch (InvalidIdentifierException $e) {
  79.             throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
  80.         }
  82.         switch ($request->getMethod()) {
  83.             case 'PUT':
  84.             case 'PATCH':
  85.             case 'POST':
  86.                 $persistResult = $this->processor->process($controllerResult, $operation, $uriVariables, $context);
  88.                 if ($persistResult) {
  89.                     $controllerResult = $persistResult;
  90.                     $event->setControllerResult($controllerResult);
  91.                 }
  93.                 if ($controllerResult instanceof Response) {
  94.                     break;
  95.                 }
  97.                 $outputMetadata = $operation->getOutput() ?? ['class' => $attributes['resource_class']];
  98.                 $hasOutput = \is_array($outputMetadata) && \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];
  99.                 if (!$hasOutput) {
  100.                     break;
  101.                 }
  103.                 if ($this->resourceClassResolver->isResourceClass($this->getObjectClass($controllerResult))) {
  104.                     $request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromResource($controllerResult));
  105.                 }
  107.                 break;
  108.             case 'DELETE':
  109.                 $this->processor->process($controllerResult, $operation, $uriVariables, $context);
  110.                 $event->setControllerResult(null);
  111.                 break;
  112.         }
  113.     }
  114. }