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

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;
  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\OperationRequestInitiatorTrait;
  24. use ApiPlatform\Util\RequestAttributesExtractor;
  25. use ApiPlatform\Util\ResourceClassInfoTrait;
  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 OperationRequestInitiatorTrait;
  39.     use ResourceClassInfoTrait;
  41.     use UriVariablesResolverTrait;
  43.     public const OPERATION_ATTRIBUTE_KEY = 'write';
  45.     private $processor;
  46.     private $iriConverter;
  48.     public function __construct(ProcessorInterface $processor, IriConverterInterface $iriConverter, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ResourceClassResolverInterface $resourceClassResolver, ?UriVariablesConverterInterface $uriVariablesConverter = null)
  49.     {
  50.         $this->processor = $processor;
  51.         $this->iriConverter = $iriConverter;
  52.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  53.         // TODO 3.0: see ResourceClassInfoTrait
  54.         $this->resourceMetadataFactory = $resourceMetadataCollectionFactory;
  55.         $this->resourceClassResolver = $resourceClassResolver;
  56.         $this->uriVariablesConverter = $uriVariablesConverter;
  57.     }
  59.     /**
  60.      * Persists, updates or delete data return by the controller if applicable.
  61.      */
  62.     public function onKernelView(ViewEvent $event): void
  63.     {
  64.         $controllerResult = $event->getControllerResult();
  65.         $request = $event->getRequest();
  66.         $operation = $this->initializeOperation($request);
  68.         if (
  69.             $controllerResult instanceof Response
  70.             || $request->isMethodSafe()
  71.             || !($attributes = RequestAttributesExtractor::extractAttributes($request))
  72.         ) {
  73.             return;
  74.         }
  76.         if (!$operation || ($operation->getExtraProperties()['is_legacy_resource_metadata'] ?? false) || !($operation->canWrite() ?? true) || !$attributes['persist']) {
  77.             return;
  78.         }
  80.         if (!$operation->getProcessor()) {
  81.             return;
  82.         }
  84.         $context = ['operation' => $operation, 'resource_class' => $attributes['resource_class'], 'previous_data' => $attributes['previous_data'] ?? null];
  85.         try {
  86.             $uriVariables = $this->getOperationUriVariables($operation, $request->attributes->all(), $attributes['resource_class']);
  87.         } catch (InvalidIdentifierException $e) {
  88.             throw new NotFoundHttpException('Invalid identifier value or configuration.', $e);
  89.         }
  91.         switch ($request->getMethod()) {
  92.             case 'PUT':
  93.             case 'PATCH':
  94.             case 'POST':
  95.                 $persistResult = $this->processor->process($controllerResult, $operation, $uriVariables, $context);
  97.                 if ($persistResult) {
  98.                     $controllerResult = $persistResult;
  99.                     $event->setControllerResult($controllerResult);
  100.                 }
  102.                 if ($controllerResult instanceof Response) {
  103.                     break;
  104.                 }
  106.                 $outputMetadata = $operation->getOutput() ?? ['class' => $attributes['resource_class']];
  107.                 $hasOutput = \is_array($outputMetadata) && \array_key_exists('class', $outputMetadata) && null !== $outputMetadata['class'];
  108.                 if (!$hasOutput) {
  109.                     break;
  110.                 }
  112.                 if ($this->isResourceClass($this->getObjectClass($controllerResult))) {
  113.                     $request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromResource($controllerResult));
  114.                 }
  116.                 break;
  117.             case 'DELETE':
  118.                 $this->processor->process($controllerResult, $operation, $uriVariables, $context);
  119.                 $event->setControllerResult(null);
  120.                 break;
  121.         }
  122.     }
  123. }