vendor/shopware/core/Framework/DataAbstractionLayer/Field/Field.php line 117

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer\Field;
  5. use Shopware\Core\Framework\Api\Context\AdminApiSource;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\FieldAccessorBuilder\DefaultFieldAccessorBuilder;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\FieldAccessorBuilder\FieldAccessorBuilderInterface;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Dbal\FieldResolver\AbstractFieldResolver;
  9. use Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\ApiAware;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\Flag;
  12. use Shopware\Core\Framework\DataAbstractionLayer\FieldSerializer\FieldSerializerInterface;
  13. use Shopware\Core\Framework\Struct\Struct;
  15. abstract class Field extends Struct
  16. {
  17.     /**
  18.      * @var Flag[]
  19.      */
  20.     protected $flags = [];
  22.     /**
  23.      * @var string
  24.      */
  25.     protected $propertyName;
  27.     /**
  28.      * @var FieldSerializerInterface
  29.      */
  30.     private $serializer;
  32.     /**
  33.      * @var AbstractFieldResolver|null
  34.      */
  35.     private $resolver;
  37.     /**
  38.      * @var FieldAccessorBuilderInterface|null
  39.      */
  40.     private $accessorBuilder;
  42.     /**
  43.      * @var DefinitionInstanceRegistry
  44.      */
  45.     private $registry;
  47.     public function __construct(string $propertyName)
  48.     {
  49.         $this->propertyName = $propertyName;
  50.         $this->addFlags(new ApiAware(AdminApiSource::class));
  51.     }
  53.     public function compile(DefinitionInstanceRegistry $registry): void
  54.     {
  55.         $this->registry = $registry;
  56.     }
  58.     public function getPropertyName(): string
  59.     {
  60.         return $this->propertyName;
  61.     }
  63.     public function getExtractPriority(): int
  64.     {
  65.         return 0;
  66.     }
  68.     public function setFlags(Flag ...$flags): self
  69.     {
  70.         $this->flags = [];
  71.         foreach ($flags as $flag) {
  72.             $this->flags[\get_class($flag)] = $flag;
  73.         }
  74.         if (!$this->is(ApiAware::class)) {
  75.             $this->addFlags(new ApiAware(AdminApiSource::class));
  76.         }
  78.         return $this;
  79.     }
  81.     public function addFlags(Flag ...$flags): self
  82.     {
  83.         foreach ($flags as $flag) {
  84.             $this->flags[\get_class($flag)] = $flag;
  85.         }
  87.         return $this;
  88.     }
  90.     public function removeFlag(string $class): self
  91.     {
  92.         unset($this->flags[$class]);
  94.         return $this;
  95.     }
  97.     public function is(string $class): bool
  98.     {
  99.         return $this->getFlag($class) !== null;
  100.     }
  102.     public function getFlag(string $class): ?Flag
  103.     {
  104.         return $this->flags[$class] ?? null;
  105.     }
  107.     /**
  108.      * @return Flag[]
  109.      */
  110.     public function getFlags(): array
  111.     {
  112.         return array_values($this->flags);
  113.     }
  115.     public function getSerializer(): FieldSerializerInterface
  116.     {
  117.         $this->initLazy();
  119.         return $this->serializer;
  120.     }
  122.     /**
  123.      * @return AbstractFieldResolver|null
  124.      */
  125.     public function getResolver()
  126.     {
  127.         $this->initLazy();
  129.         return $this->resolver;
  130.     }
  132.     public function getAccessorBuilder(): ?FieldAccessorBuilderInterface
  133.     {
  134.         $this->initLazy();
  136.         return $this->accessorBuilder;
  137.     }
  139.     public function isCompiled(): bool
  140.     {
  141.         return $this->registry !== null;
  142.     }
  144.     abstract protected function getSerializerClass(): string;
  146.     protected function getResolverClass(): ?string
  147.     {
  148.         return null;
  149.     }
  151.     protected function getAccessorBuilderClass(): ?string
  152.     {
  153.         if ($this instanceof StorageAware) {
  154.             return DefaultFieldAccessorBuilder::class;
  155.         }
  157.         return null;
  158.     }
  160.     private function initLazy(): void
  161.     {
  162.         if ($this->serializer !== null) {
  163.             return;
  164.         }
  166.         $this->serializer = $this->registry->getSerializer($this->getSerializerClass());
  168.         $resolverClass = $this->getResolverClass();
  169.         if ($resolverClass !== null) {
  170.             $this->resolver = $this->registry->getResolver($resolverClass);
  171.         }
  173.         $accessorBuilderClass = $this->getAccessorBuilderClass();
  174.         if ($accessorBuilderClass !== null) {
  175.             $this->accessorBuilder = $this->registry->getAccessorBuilder($accessorBuilderClass);
  176.         }
  177.     }
  178. }