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

Open in your IDE?
  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 as LegacyIriConverterInterface;
  17. use ApiPlatform\Api\ResourceClassResolverInterface as LegacyResourceClassResolverInterface;
  18. use ApiPlatform\Api\UriVariablesConverterInterface as LegacyUriVariablesConverterInterface;
  19. use ApiPlatform\Exception\InvalidIdentifierException;
  20. use ApiPlatform\Metadata\IriConverterInterface;
  21. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  22. use ApiPlatform\Metadata\ResourceClassResolverInterface;
  23. use ApiPlatform\Metadata\UriVariablesConverterInterface;
  24. use ApiPlatform\Metadata\Util\ClassInfoTrait;
  25. use ApiPlatform\State\ProcessorInterface;
  26. use ApiPlatform\State\UriVariablesResolverTrait;
  27. use ApiPlatform\State\Util\OperationRequestInitiatorTrait;
  28. use ApiPlatform\Symfony\Util\RequestAttributesExtractor;
  29. use Symfony\Component\HttpFoundation\Response;
  30. use Symfony\Component\HttpKernel\Event\ViewEvent;
  31. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  33. /**
  34.  * Bridges persistence and the API system.
  35.  *
  36.  * @author Kévin Dunglas <dunglas@gmail.com>
  37.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  38.  */
  39. final class WriteListener
  40. {
  41.     use ClassInfoTrait;
  42.     use OperationRequestInitiatorTrait;
  43.     use UriVariablesResolverTrait;
  45.     public function __construct(
  46.         private readonly ProcessorInterface $processor,
  47.         private readonly LegacyIriConverterInterface|IriConverterInterface $iriConverter,
  48.         private readonly ResourceClassResolverInterface|LegacyResourceClassResolverInterface $resourceClassResolver,
  49.         ?ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null,
  50.         LegacyUriVariablesConverterInterface|UriVariablesConverterInterface|null $uriVariablesConverter = null,
  51.     ) {
  52.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  53.         $this->uriVariablesConverter = $uriVariablesConverter;
  54.     }
  56.     /**
  57.      * Persists, updates or delete data return by the controller if applicable.
  58.      */
  59.     public function onKernelView(ViewEvent $event): void
  60.     {
  61.         $controllerResult = $event->getControllerResult();
  62.         $request = $event->getRequest();
  63.         $operation = $this->initializeOperation($request);
  65.         // API Platform 3.2 has a MainController where everything is handled by processors/providers
  66.         if ('api_platform.symfony.main_controller' === $operation?->getController() || $request->attributes->get('_api_platform_disable_listeners')) {
  67.             return;
  68.         }
  70.         if (
  71.             $controllerResult instanceof Response
  72.             || $request->isMethodSafe()
  73.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  74.         ) {
  75.             return;
  76.         }
  78.         if (!$attributes['persist'] || !($operation?->canWrite() ?? true)) {
  79.             return;
  80.         }
  82.         if (!$operation?->getProcessor()) {
  83.             return;
  84.         }
  86.         $context = [
  87.             'operation' => $operation,
  88.             'resource_class' => $attributes['resource_class'],
  89.             'previous_data' => $attributes['previous_data'] ?? null,
  90.         ];
  92.         try {
  93.             $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $attributes['resource_class']);
  94.         } catch (InvalidIdentifierException $e) {
  95.             throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
  96.         }
  98.         switch ($request->getMethod()) {
  99.             case 'PUT':
  100.             case 'PATCH':
  101.             case 'POST':
  102.                 $persistResult = $this->processor->process($controllerResult, $operation, $uriVariables, $context);
  104.                 if ($persistResult) {
  105.                     $controllerResult = $persistResult;
  106.                     $event->setControllerResult($controllerResult);
  107.                 }
  109.                 if ($controllerResult instanceof Response) {
  110.                     break;
  111.                 }
  113.                 $outputMetadata = $operation->getOutput() ?? ['class' => $attributes['resource_class']];
  114.                 $hasOutput = \is_array($outputMetadata) && \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];
  115.                 if (!$hasOutput) {
  116.                     break;
  117.                 }
  119.                 if ($this->resourceClassResolver->isResourceClass($this->getObjectClass($controllerResult))) {
  120.                     $request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromResource($controllerResult));
  121.                 }
  123.                 break;
  124.             case 'DELETE':
  125.                 $this->processor->process($controllerResult, $operation, $uriVariables, $context);
  126.                 $event->setControllerResult(null);
  127.                 break;
  128.         }
  129.     }
  130. }