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

  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\Put;
  18. use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
  20. class DeprecationResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
  21. {
  22.     // Hashmap to avoid triggering too many deprecations
  23.     private array $deprecated;
  25.     public function __construct(private readonly ResourceMetadataCollectionFactoryInterface $decorated)
  26.     {
  27.     }
  29.     public function create(string $resourceClass): ResourceMetadataCollection
  30.     {
  31.         $resourceMetadataCollection = $this->decorated->create($resourceClass);
  33.         foreach ($resourceMetadataCollection as $resourceMetadata) {
  34.             foreach ($resourceMetadata->getOperations() as $operation) {
  35.                 if ($operation instanceof Put && null === ($operation->getExtraProperties()['standard_put'] ?? null)) {
  36.                     $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.');
  37.                 }
  38.             }
  39.         }
  41.         return $resourceMetadataCollection;
  42.     }
  44.     private function triggerDeprecationOnce(Operation $operation, string $deprecationName, string $deprecationReason): void
  45.     {
  46.         if (isset($this->deprecated[$operation->getClass().$deprecationName])) {
  47.             return;
  48.         }
  50.         $this->deprecated[$operation->getClass().$deprecationName] = true;
  52.         trigger_deprecation('api-platform/core', '3.1', $deprecationReason);
  53.     }
  54. }