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

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\Log\Package;
  14. use Shopware\Core\Framework\Struct\Struct;
  16. #[Package('core')]
  17. abstract class Field extends Struct
  18. {
  19.     /**
  20.      * @var Flag[]
  21.      */
  22.     protected $flags = [];
  24.     /**
  25.      * @var string
  26.      */
  27.     protected $propertyName;
  29.     /**
  30.      * @var FieldSerializerInterface
  31.      */
  32.     private $serializer;
  34.     /**
  35.      * @var AbstractFieldResolver|null
  36.      */
  37.     private $resolver;
  39.     /**
  40.      * @var FieldAccessorBuilderInterface|null
  41.      */
  42.     private $accessorBuilder;
  44.     /**
  45.      * @var DefinitionInstanceRegistry
  46.      */
  47.     private $registry;
  49.     public function __construct(string $propertyName)
  50.     {
  51.         $this->propertyName = $propertyName;
  52.         $this->addFlags(new ApiAware(AdminApiSource::class));
  53.     }
  55.     public function compile(DefinitionInstanceRegistry $registry): void
  56.     {
  57.         $this->registry = $registry;
  58.     }
  60.     public function getPropertyName(): string
  61.     {
  62.         return $this->propertyName;
  63.     }
  65.     public function getExtractPriority(): int
  66.     {
  67.         return 0;
  68.     }
  70.     public function setFlags(Flag ...$flags): self
  71.     {
  72.         $this->flags = [];
  73.         foreach ($flags as $flag) {
  74.             $this->flags[\get_class($flag)] = $flag;
  75.         }
  76.         if (!$this->is(ApiAware::class)) {
  77.             $this->addFlags(new ApiAware(AdminApiSource::class));
  78.         }
  80.         return $this;
  81.     }
  83.     public function addFlags(Flag ...$flags): self
  84.     {
  85.         foreach ($flags as $flag) {
  86.             $this->flags[\get_class($flag)] = $flag;
  87.         }
  89.         return $this;
  90.     }
  92.     public function removeFlag(string $class): self
  93.     {
  94.         unset($this->flags[$class]);
  96.         return $this;
  97.     }
  99.     public function is(string $class): bool
  100.     {
  101.         return $this->getFlag($class) !== null;
  102.     }
  104.     public function getFlag(string $class): ?Flag
  105.     {
  106.         return $this->flags[$class] ?? null;
  107.     }
  109.     /**
  110.      * @return Flag[]
  111.      */
  112.     public function getFlags(): array
  113.     {
  114.         return array_values($this->flags);
  115.     }
  117.     public function getSerializer(): FieldSerializerInterface
  118.     {
  119.         $this->initLazy();
  121.         return $this->serializer;
  122.     }
  124.     /**
  125.      * @return AbstractFieldResolver|null
  126.      */
  127.     public function getResolver()
  128.     {
  129.         $this->initLazy();
  131.         return $this->resolver;
  132.     }
  134.     public function getAccessorBuilder(): ?FieldAccessorBuilderInterface
  135.     {
  136.         $this->initLazy();
  138.         return $this->accessorBuilder;
  139.     }
  141.     public function isCompiled(): bool
  142.     {
  143.         return $this->registry !== null;
  144.     }
  146.     abstract protected function getSerializerClass(): string;
  148.     protected function getResolverClass(): ?string
  149.     {
  150.         return null;
  151.     }
  153.     protected function getAccessorBuilderClass(): ?string
  154.     {
  155.         if ($this instanceof StorageAware) {
  156.             return DefaultFieldAccessorBuilder::class;
  157.         }
  159.         return null;
  160.     }
  162.     private function initLazy(): void
  163.     {
  164.         if ($this->serializer !== null) {
  165.             return;
  166.         }
  168.         $this->serializer = $this->registry->getSerializer($this->getSerializerClass());
  170.         $resolverClass = $this->getResolverClass();
  171.         if ($resolverClass !== null) {
  172.             $this->resolver = $this->registry->getResolver($resolverClass);
  173.         }
  175.         $accessorBuilderClass = $this->getAccessorBuilderClass();
  176.         if ($accessorBuilderClass !== null) {
  177.             $this->accessorBuilder = $this->registry->getAccessorBuilder($accessorBuilderClass);
  178.         }
  179.     }
  180. }