vendor/api-platform/core/src/Core/EventListener/WriteListener.php line 67

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the API Platform project.
  4.  *
  5.  * (c) Kévin Dunglas <dunglas@gmail.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. declare(strict_types=1);
  11. namespace ApiPlatform\Core\EventListener;
  12. use ApiPlatform\Api\IriConverterInterface;
  13. use ApiPlatform\Core\Api\IriConverterInterface as LegacyIriConverterInterface;
  14. use ApiPlatform\Core\Api\ResourceClassResolverInterface;
  15. use ApiPlatform\Core\DataPersister\DataPersisterInterface;
  16. use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
  17. use ApiPlatform\Core\Metadata\Resource\ToggleableOperationAttributeTrait;
  18. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  19. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  20. use ApiPlatform\Util\RequestAttributesExtractor;
  21. use ApiPlatform\Util\ResourceClassInfoTrait;
  22. use Symfony\Component\HttpFoundation\Response;
  23. use Symfony\Component\HttpKernel\Event\ViewEvent;
  24. /**
  25.  * Bridges persistence and the API system.
  26.  *
  27.  * @author Kévin Dunglas <dunglas@gmail.com>
  28.  * @author Baptiste Meyer <baptiste.meyer@gmail.com>
  29.  *
  30.  * @deprecated
  31.  */
  32. final class WriteListener
  33. {
  34.     use OperationRequestInitiatorTrait;
  35.     use ResourceClassInfoTrait;
  36.     use ToggleableOperationAttributeTrait;
  37.     public const OPERATION_ATTRIBUTE_KEY 'write';
  38.     private $dataPersister;
  39.     /** @var LegacyIriConverterInterface|IriConverterInterface|null */
  40.     private $iriConverter;
  41.     private $metadataBackwardCompatibilityLayer;
  42.     public function __construct(DataPersisterInterface $dataPersister$iriConverter nullResourceMetadataFactoryInterface $resourceMetadataFactory nullResourceClassResolverInterface $resourceClassResolver nullResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory null, ?bool $metadataBackwardCompatibilityLayer null)
  43.     {
  44.         $this->dataPersister $dataPersister;
  45.         $this->iriConverter $iriConverter;
  46.         $this->resourceMetadataFactory $resourceMetadataFactory;
  47.         $this->resourceClassResolver $resourceClassResolver;
  48.         $this->resourceMetadataCollectionFactory $resourceMetadataCollectionFactory;
  49.         $this->metadataBackwardCompatibilityLayer $metadataBackwardCompatibilityLayer;
  50.         if ($metadataBackwardCompatibilityLayer || null === $metadataBackwardCompatibilityLayer) {
  51.             trigger_deprecation('api-platform/core''2.7'sprintf('The listener "%s" is deprecated and will be removed in 3.0, use "%s" instead'__CLASS__\ApiPlatform\Symfony\EventListener\WriteListener::class));
  52.         }
  53.     }
  54.     /**
  55.      * Persists, updates or delete data return by the controller if applicable.
  56.      */
  57.     public function onKernelView(ViewEvent $event): void
  58.     {
  59.         $controllerResult $event->getControllerResult();
  60.         $request $event->getRequest();
  61.         $operation $this->initializeOperation($request);
  62.         if (
  63.             $controllerResult instanceof Response
  64.             || $request->isMethodSafe()
  65.             || !($attributes RequestAttributesExtractor::extractAttributes($request))
  66.             || !$attributes['persist']
  67.             || ($operation && !($operation->getExtraProperties()['is_legacy_resource_metadata'] ?? false))
  68.             || $this->isOperationAttributeDisabled($attributesself::OPERATION_ATTRIBUTE_KEY)
  69.         ) {
  70.             return;
  71.         }
  72.         if (false === $this->metadataBackwardCompatibilityLayer) {
  73.             trigger_deprecation('api-platform/core''2.7''The operation you requested uses legacy metadata, switch to #[ApiPlatform\Metadata\ApiResource].');
  74.         }
  75.         if (!$this->dataPersister->supports($controllerResult$attributes)) {
  76.             return;
  77.         }
  78.         switch ($request->getMethod()) {
  79.             case 'PUT':
  80.             case 'PATCH':
  81.             case 'POST':
  82.                 $persistResult $this->dataPersister->persist($controllerResult$attributes);
  83.                 if (!\is_object($persistResult)) {
  84.                     @trigger_error(sprintf('Not returning an object from %s::persist() is deprecated since API Platform 2.3 and will not be supported in API Platform 3.'DataPersisterInterface::class), \E_USER_DEPRECATED);
  85.                 } else {
  86.                     $controllerResult $persistResult;
  87.                     $event->setControllerResult($controllerResult);
  88.                 }
  89.                 if ($controllerResult instanceof Response) {
  90.                     break;
  91.                 }
  92.                 $hasOutput true;
  93.                 if ($this->resourceMetadataFactory instanceof ResourceMetadataFactoryInterface) {
  94.                     $resourceMetadata $this->resourceMetadataFactory->create($attributes['resource_class']);
  95.                     $outputMetadata $resourceMetadata->getOperationAttribute($attributes'output', [
  96.                         'class' => $attributes['resource_class'],
  97.                     ], true);
  98.                     $hasOutput \array_key_exists('class'$outputMetadata) && null !== $outputMetadata['class'];
  99.                 }
  100.                 if (!$hasOutput) {
  101.                     break;
  102.                 }
  103.                 if ($this->isResourceClass($this->getObjectClass($controllerResult))) {
  104.                     $request->attributes->set('_api_write_item_iri'$this->iriConverter instanceof LegacyIriConverterInterface $this->iriConverter->getIriFromItem($controllerResult) : $this->iriConverter->getIriFromResource($controllerResult));
  105.                 }
  106.                 break;
  107.             case 'DELETE':
  108.                 $this->dataPersister->remove($controllerResult$attributes);
  109.                 $event->setControllerResult(null);
  110.                 break;
  111.         }
  112.     }
  113. }