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

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\PlatformRequest;
  9. use Symfony\Component\HttpFoundation\RequestStack;
  11. /**
  12.  * @deprecated tag:v6.5.0 - Will be removed. Api payloads will be no longer converted over the Deprecated flag
  13.  */
  14. class DefaultApiConverter
  15. {
  16.     /**
  17.      * @var DefinitionInstanceRegistry
  18.      */
  19.     private $definitionInstanceRegistry;
  21.     /**
  22.      * @var array
  23.      */
  24.     private $deprecations;
  26.     /**
  27.      * @var RequestStack
  28.      */
  29.     private $requestStack;
  31.     /**
  32.      * @internal
  33.      */
  34.     public function __construct(DefinitionInstanceRegistry $definitionInstanceRegistry, RequestStack $requestStack)
  35.     {
  36.         $this->definitionInstanceRegistry = $definitionInstanceRegistry;
  37.         $this->requestStack = $requestStack;
  38.     }
  40.     public function convert(string $entityName, array $payload): array
  41.     {
  42.         Feature::triggerDeprecationOrThrow(
  43.             'v6.5.0.0',
  44.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  45.         );
  47.         $definition = $this->definitionInstanceRegistry->getByEntityName($entityName);
  49.         $fields = $definition->getFields()->filterByFlag(Deprecated::class);
  50.         if ($fields->count() === 0) {
  51.             return $payload;
  52.         }
  54.         foreach ($fields as $field) {
  55.             /** @var Deprecated|null $deprecated */
  56.             $deprecated = $field->getFlag(Deprecated::class);
  58.             if ($deprecated === null) {
  59.                 continue;
  60.             }
  62.             if ($deprecated->getReplaceBy() === null) {
  63.                 continue;
  64.             }
  66.             // When the user sends both fields. The prefer the replaceBy field
  67.             if (isset($payload[$field->getPropertyName()], $payload[$deprecated->getReplaceBy()])) {
  68.                 unset($payload[$field->getPropertyName()]);
  69.             }
  70.         }
  72.         return $payload;
  73.     }
  75.     public function isDeprecated(string $entityName, ?string $fieldName = null): bool
  76.     {
  77.         Feature::triggerDeprecationOrThrow(
  78.             'v6.5.0.0',
  79.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  80.         );
  82.         if ($this->ignoreDeprecations()) {
  83.             return false;
  84.         }
  86.         if ($fieldName === null) {
  87.             return \array_key_exists($entityName, $this->getDeprecations()) && !\is_array($this->getDeprecations()[$entityName]);
  88.         }
  90.         return \in_array($fieldName, $this->getDeprecations()[$entityName] ?? [], true);
  91.     }
  93.     protected function getDeprecations(): array
  94.     {
  95.         Feature::triggerDeprecationOrThrow(
  96.             'v6.5.0.0',
  97.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  98.         );
  100.         if ($this->deprecations !== null) {
  101.             return $this->deprecations;
  102.         }
  104.         foreach ($this->definitionInstanceRegistry->getDefinitions() as $definition) {
  105.             $this->deprecations[$definition->getEntityName()] = [];
  107.             $fields = $definition->getFields()->filterByFlag(Deprecated::class);
  109.             foreach ($fields as $field) {
  110.                 $this->deprecations[$definition->getEntityName()][] = $field->getPropertyName();
  111.             }
  112.         }
  114.         return $this->deprecations;
  115.     }
  117.     protected function ignoreDeprecations(): bool
  118.     {
  119.         Feature::triggerDeprecationOrThrow(
  120.             'v6.5.0.0',
  121.             Feature::deprecatedClassMessage(__CLASS__, 'v6.5.0.0')
  122.         );
  124.         // We don't have a request
  125.         if ($this->requestStack->getMainRequest() === null) {
  126.             return false;
  127.         }
  129.         return $this->requestStack->getMainRequest()->headers->get(PlatformRequest::HEADER_IGNORE_DEPRECATIONS) === 'true';
  130.     }
  131. }