vendor/shopware/core/Framework/Api/Converter/DefaultApiConverter.php line 46

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Api\Converter;
  5. use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\Deprecated;
  7. use Shopware\Core\Framework\Feature;
  8. use Shopware\Core\Framework\Log\Package;
  9. use Shopware\Core\PlatformRequest;
  10. use Symfony\Component\HttpFoundation\RequestStack;
  12. /**
  13.  * @deprecated tag:v6.5.0 - Will be removed. Api payloads will be no longer converted over the Deprecated flag
  14.  */
  15. #[Package('core')]
  16. class DefaultApiConverter
  17. {
  18.     /**
  19.      * @var DefinitionInstanceRegistry
  20.      */
  21.     private $definitionInstanceRegistry;
  23.     /**
  24.      * @var array
  25.      */
  26.     private $deprecations;
  28.     /**
  29.      * @var RequestStack
  30.      */
  31.     private $requestStack;
  33.     /**
  34.      * @internal
  35.      */
  36.     public function __construct(DefinitionInstanceRegistry $definitionInstanceRegistry, RequestStack $requestStack)
  37.     {
  38.         $this->definitionInstanceRegistry = $definitionInstanceRegistry;
  39.         $this->requestStack = $requestStack;
  40.     }
  42.     public function convert(string $entityName, array $payload): array
  43.     {
  44.         Feature::triggerDeprecationOrThrow(
  45.             'v6.5.0.0',
  46.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  47.         );
  49.         $definition = $this->definitionInstanceRegistry->getByEntityName($entityName);
  51.         $fields = $definition->getFields()->filterByFlag(Deprecated::class);
  52.         if ($fields->count() === 0) {
  53.             return $payload;
  54.         }
  56.         foreach ($fields as $field) {
  57.             /** @var Deprecated|null $deprecated */
  58.             $deprecated = $field->getFlag(Deprecated::class);
  60.             if ($deprecated === null) {
  61.                 continue;
  62.             }
  64.             if ($deprecated->getReplaceBy() === null) {
  65.                 continue;
  66.             }
  68.             // When the user sends both fields. The prefer the replaceBy field
  69.             if (isset($payload[$field->getPropertyName()], $payload[$deprecated->getReplaceBy()])) {
  70.                 unset($payload[$field->getPropertyName()]);
  71.             }
  72.         }
  74.         return $payload;
  75.     }
  77.     public function isDeprecated(string $entityName, ?string $fieldName = null): bool
  78.     {
  79.         Feature::triggerDeprecationOrThrow(
  80.             'v6.5.0.0',
  81.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  82.         );
  84.         if ($this->ignoreDeprecations()) {
  85.             return false;
  86.         }
  88.         if ($fieldName === null) {
  89.             return \array_key_exists($entityName, $this->getDeprecations()) && !\is_array($this->getDeprecations()[$entityName]);
  90.         }
  92.         return \in_array($fieldName, $this->getDeprecations()[$entityName] ?? [], true);
  93.     }
  95.     protected function getDeprecations(): array
  96.     {
  97.         Feature::triggerDeprecationOrThrow(
  98.             'v6.5.0.0',
  99.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  100.         );
  102.         if ($this->deprecations !== null) {
  103.             return $this->deprecations;
  104.         }
  106.         foreach ($this->definitionInstanceRegistry->getDefinitions() as $definition) {
  107.             $this->deprecations[$definition->getEntityName()] = [];
  109.             $fields = $definition->getFields()->filterByFlag(Deprecated::class);
  111.             foreach ($fields as $field) {
  112.                 $this->deprecations[$definition->getEntityName()][] = $field->getPropertyName();
  113.             }
  114.         }
  116.         return $this->deprecations;
  117.     }
  119.     protected function ignoreDeprecations(): bool
  120.     {
  121.         Feature::triggerDeprecationOrThrow(
  122.             'v6.5.0.0',
  123.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  124.         );
  126.         // We don't have a request
  127.         if ($this->requestStack->getMainRequest() === null) {
  128.             return false;
  129.         }
  131.         return $this->requestStack->getMainRequest()->headers->get(PlatformRequest::HEADER_IGNORE_DEPRECATIONS) === 'true';
  132.     }
  133. }