vendor/shopware/core/System/CustomField/CustomFieldService.php line 79

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\CustomField;
  5. use Shopware\Core\Framework\Context;
  6. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepositoryInterface;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Field\BoolField;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Field\DateTimeField;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Field\Field;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\AllowHtml;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Field\FloatField;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Field\IntField;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Field\JsonField;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Field\LongTextField;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. class CustomFieldService implements EventSubscriberInterface
  20. {
  21.     /**
  22.      * @var EntityRepositoryInterface
  23.      */
  24.     private $attributeRepository;
  26.     /**
  27.      * @var CustomFieldEntity[]|null
  28.      */
  29.     private $customFields;
  31.     public function __construct(EntityRepositoryInterface $attributeRepository)
  32.     {
  33.         $this->attributeRepository = $attributeRepository;
  34.     }
  36.     public function getCustomField(string $attributeName): ?Field
  37.     {
  38.         $attribute = $this->getCustomFields()[$attributeName] ?? null;
  39.         if (!$attribute) {
  40.             return null;
  41.         }
  43.         switch ($attribute->getType()) {
  44.             case CustomFieldTypes::INT:
  45.                 return new IntField($attributeName, $attributeName);
  47.             case CustomFieldTypes::FLOAT:
  48.                 return new FloatField($attributeName, $attributeName);
  50.             case CustomFieldTypes::BOOL:
  51.                 return new BoolField($attributeName, $attributeName);
  53.             case CustomFieldTypes::DATETIME:
  54.                 return new DateTimeField($attributeName, $attributeName);
  56.             case CustomFieldTypes::TEXT:
  57.                 return new LongTextField($attributeName, $attributeName);
  59.             case CustomFieldTypes::HTML:
  60.                 return (new LongTextField($attributeName, $attributeName))->addFlags(new AllowHtml());
  62.             case CustomFieldTypes::JSON:
  63.             default:
  64.                 return new JsonField($attributeName, $attributeName);
  65.         }
  66.     }
  68.     public static function getSubscribedEvents(): array
  69.     {
  70.         return [
  71.             CustomFieldEvents::CUSTOM_FIELD_DELETED_EVENT => 'invalidateCache',
  72.             CustomFieldEvents::CUSTOM_FIELD_WRITTEN_EVENT => 'invalidateCache',
  73.         ];
  74.     }
  76.     /**
  77.      * @internal
  78.      */
  79.     public function invalidateCache(): void
  80.     {
  81.         $this->customFields = null;
  82.     }
  84.     /**
  85.      * @return CustomFieldEntity[]
  86.      */
  87.     private function getCustomFields(): array
  88.     {
  89.         if ($this->customFields !== null) {
  90.             return $this->customFields;
  91.         }
  93.         $this->customFields = [];
  95.         $criteria = new Criteria();
  96.         $criteria->addFilter(new EqualsFilter('active', true));
  98.         // attributes should not be context dependent
  99.         $result = $this->attributeRepository->search($criteria, Context::createDefaultContext());
  100.         /** @var CustomFieldEntity $attribute */
  101.         foreach ($result as $attribute) {
  102.             $this->customFields[$attribute->getName()] = $attribute;
  103.         }
  105.         return $this->customFields;
  106.     }
  107. }