src/Core/System/CustomField/CustomFieldService.php line 68

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\CustomField;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Field\BoolField;
  7. use Shopware\Core\Framework\DataAbstractionLayer\Field\DateTimeField;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Field\Field;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\AllowHtml;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\ApiAware;
  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\Field\PriceField;
  16. use Shopware\Core\Framework\Log\Package;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Contracts\Service\ResetInterface;
  20. /**
  21.  * @internal
  22.  */
  23. #[Package('core')]
  24. class CustomFieldService implements EventSubscriberInterface, ResetInterface
  25. {
  26.     /**
  27.      * @var array<string>|null
  28.      */
  29.     private ?array $customFields = null;
  31.     /**
  32.      * @internal
  33.      */
  34.     public function __construct(private readonly Connection $connection)
  35.     {
  36.     }
  38.     public function getCustomField(string $attributeName): ?Field
  39.     {
  40.         $type = $this->getCustomFields()[$attributeName] ?? null;
  41.         if (!$type) {
  42.             return null;
  43.         }
  45.         return match ($type) {
  46.             CustomFieldTypes::INT => (new IntField($attributeName, $attributeName))->addFlags(new ApiAware()),
  47.             CustomFieldTypes::FLOAT => (new FloatField($attributeName, $attributeName))->addFlags(new ApiAware()),
  48.             CustomFieldTypes::BOOL => (new BoolField($attributeName, $attributeName))->addFlags(new ApiAware()),
  49.             CustomFieldTypes::DATETIME => (new DateTimeField($attributeName, $attributeName))->addFlags(new ApiAware()),
  50.             CustomFieldTypes::TEXT => (new LongTextField($attributeName, $attributeName))->addFlags(new ApiAware()),
  51.             CustomFieldTypes::HTML => (new LongTextField($attributeName, $attributeName))->addFlags(new ApiAware(), new AllowHtml()),
  52.             CustomFieldTypes::PRICE => (new PriceField($attributeName, $attributeName))->addFlags(new ApiAware()),
  53.             default => (new JsonField($attributeName, $attributeName))->addFlags(new ApiAware()),
  54.         };
  55.     }
  57.     /**
  58.      * @return array<string, string>
  59.      */
  60.     public static function getSubscribedEvents(): array
  61.     {
  62.         return [
  63.             CustomFieldEvents::CUSTOM_FIELD_DELETED_EVENT => 'reset',
  64.             CustomFieldEvents::CUSTOM_FIELD_WRITTEN_EVENT => 'reset',
  65.         ];
  66.     }
  68.     public function reset(): void
  69.     {
  70.         $this->customFields = null;
  71.     }
  73.     /**
  74.      * @return array<string>
  75.      */
  76.     private function getCustomFields(): array
  77.     {
  78.         if ($this->customFields !== null) {
  79.             return $this->customFields;
  80.         }
  82.         $this->customFields = $this->connection->fetchAllKeyValue('SELECT `name`, `type` FROM `custom_field` WHERE `active` = 1');
  84.         return $this->customFields;
  85.     }
  86. }