vendor/api-platform/core/src/Metadata/Resource/Factory/DeprecationResourceMetadataCollectionFactory.php line 66

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\Metadata\Resource\Factory;
  16. use ApiPlatform\Metadata\Operation;
  17. use ApiPlatform\Metadata\Operations;
  18. use ApiPlatform\Metadata\Put;
  19. use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
  21. /**
  22.  * Triggers resource deprecations.
  23.  *
  24.  * @final
  25.  *
  26.  * @internal
  27.  */
  28. class DeprecationResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
  29. {
  30.     // Hashmap to avoid triggering too many deprecations
  31.     private array $deprecated;
  33.     public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $decorated)
  34.     {
  35.     }
  37.     public function create(string $resourceClass): ResourceMetadataCollection
  38.     {
  39.         $resourceMetadataCollection = $this->decorated->create($resourceClass);
  41.         foreach ($resourceMetadataCollection as $i => $resourceMetadata) {
  42.             $newOperations = [];
  43.             foreach ($resourceMetadata->getOperations() as $operationName => $operation) {
  44.                 $extraProperties = $operation->getExtraProperties();
  45.                 if ($operation instanceof Put && null === ($extraProperties['standard_put'] ?? null)) {
  46.                     $this->triggerDeprecationOnce($operation, 'extraProperties["standard_put"]', 'In API Platform 4 PUT will always replace the data, use extraProperties["standard_put"] to "true" on every operation to avoid breaking PUT\'s behavior. Use PATCH to use the old behavior.');
  47.                 }
  49.                 $newOperations[$operationName] = $operation;
  50.             }
  52.             $resourceMetadataCollection[$i] = $resourceMetadata->withOperations(new Operations($newOperations));
  53.         }
  55.         return $resourceMetadataCollection;
  56.     }
  58.     private function triggerDeprecationOnce(Operation $operation, string $deprecationName, string $deprecationReason): void
  59.     {
  60.         if (isset($this->deprecated[$operation->getClass().$deprecationName])) {
  61.             return;
  62.         }
  64.         $this->deprecated[$operation->getClass().$deprecationName] = true;
  66.         trigger_deprecation('api-platform/core', '3.1', $deprecationReason);
  67.     }
  68. }