vendor/shopware/storefront/Theme/ThemeService.php line 186

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Theme;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Exception\InconsistentCriteriaIdsException;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  11. use Shopware\Core\Framework\Log\Package;
  12. use Shopware\Core\Framework\Uuid\Uuid;
  13. use Shopware\Storefront\Theme\ConfigLoader\AbstractConfigLoader;
  14. use Shopware\Storefront\Theme\Event\ThemeAssignedEvent;
  15. use Shopware\Storefront\Theme\Event\ThemeConfigChangedEvent;
  16. use Shopware\Storefront\Theme\Event\ThemeConfigResetEvent;
  17. use Shopware\Storefront\Theme\Exception\InvalidThemeConfigException;
  18. use Shopware\Storefront\Theme\Exception\InvalidThemeException;
  19. use Shopware\Storefront\Theme\StorefrontPluginConfiguration\StorefrontPluginConfigurationCollection;
  20. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  22. #[Package('storefront')]
  23. class ThemeService
  24. {
  25.     /**
  26.      * @internal
  27.      */
  28.     public function __construct(
  29.         private readonly StorefrontPluginRegistryInterface $extensionRegistry,
  30.         private readonly EntityRepository $themeRepository,
  31.         private readonly EntityRepository $themeSalesChannelRepository,
  32.         private readonly ThemeCompilerInterface $themeCompiler,
  33.         private readonly EventDispatcherInterface $dispatcher,
  34.         private readonly AbstractConfigLoader $configLoader,
  35.         private readonly Connection $connection
  36.     ) {
  37.     }
  39.     /**
  40.      * Only compiles a single theme/saleschannel combination.
  41.      * Use `compileThemeById` to compile all dependend saleschannels
  42.      */
  43.     public function compileTheme(
  44.         string $salesChannelId,
  45.         string $themeId,
  46.         Context $context,
  47.         ?StorefrontPluginConfigurationCollection $configurationCollection = null,
  48.         bool $withAssets = true
  49.     ): void {
  50.         $this->themeCompiler->compileTheme(
  51.             $salesChannelId,
  52.             $themeId,
  53.             $this->configLoader->load($themeId, $context),
  54.             $configurationCollection ?? $this->extensionRegistry->getConfigurations(),
  55.             $withAssets,
  56.             $context
  57.         );
  58.     }
  60.     /**
  61.      * Compiles all dependend saleschannel/Theme combinations
  62.      *
  63.      * @return array<int, string>
  64.      */
  65.     public function compileThemeById(
  66.         string $themeId,
  67.         Context $context,
  68.         ?StorefrontPluginConfigurationCollection $configurationCollection = null,
  69.         bool $withAssets = true
  70.     ): array {
  71.         $mappings = $this->getThemeDependencyMapping($themeId);
  73.         $compiledThemeIds = [];
  74.         /** @var ThemeSalesChannel $mapping */
  75.         foreach ($mappings as $mapping) {
  76.             $this->themeCompiler->compileTheme(
  77.                 $mapping->getSalesChannelId(),
  78.                 $mapping->getThemeId(),
  79.                 $this->configLoader->load($mapping->getThemeId(), $context),
  80.                 $configurationCollection ?? $this->extensionRegistry->getConfigurations(),
  81.                 $withAssets,
  82.                 $context
  83.             );
  85.             $compiledThemeIds[] = $mapping->getThemeId();
  86.         }
  88.         return $compiledThemeIds;
  89.     }
  91.     /**
  92.      * @param array<string, mixed>|null $config
  93.      */
  94.     public function updateTheme(string $themeId, ?array $config, ?string $parentThemeId, Context $context): void
  95.     {
  96.         $criteria = new Criteria([$themeId]);
  97.         $criteria->addAssociation('salesChannels');
  98.         /** @var ThemeEntity|null $theme */
  99.         $theme = $this->themeRepository->search($criteria, $context)->get($themeId);
  101.         if (!$theme) {
  102.             throw new InvalidThemeException($themeId);
  103.         }
  105.         $data = ['id' => $themeId];
  106.         if ($config) {
  107.             foreach ($config as $key => $value) {
  108.                 $data['configValues'][$key] = $value;
  109.             }
  110.         }
  112.         if ($parentThemeId) {
  113.             $data['parentThemeId'] = $parentThemeId;
  114.         }
  116.         if (\array_key_exists('configValues', $data)) {
  117.             $this->dispatcher->dispatch(new ThemeConfigChangedEvent($themeId, $data['configValues']));
  118.         }
  120.         if (\array_key_exists('configValues', $data) && $theme->getConfigValues()) {
  121.             $submittedChanges = $data['configValues'];
  122.             $currentConfig = $theme->getConfigValues();
  123.             $data['configValues'] = array_replace_recursive($currentConfig, $data['configValues']);
  125.             foreach ($submittedChanges as $key => $changes) {
  126.                 if (isset($changes['value']) && \is_array($changes['value']) && isset($currentConfig[(string) $key]) && \is_array($currentConfig[(string) $key])) {
  127.                     $data['configValues'][$key]['value'] = array_unique($changes['value']);
  128.                 }
  129.             }
  130.         }
  132.         $this->themeRepository->update([$data], $context);
  134.         if ($theme->getSalesChannels() === null) {
  135.             return;
  136.         }
  138.         $this->compileThemeById($themeId, $context, null, false);
  139.     }
  141.     public function assignTheme(string $themeId, string $salesChannelId, Context $context, bool $skipCompile = false): bool
  142.     {
  143.         if (!$skipCompile) {
  144.             $this->compileTheme($salesChannelId, $themeId, $context);
  145.         }
  147.         $this->themeSalesChannelRepository->upsert([[
  148.             'themeId' => $themeId,
  149.             'salesChannelId' => $salesChannelId,
  150.         ]], $context);
  152.         $this->dispatcher->dispatch(new ThemeAssignedEvent($themeId, $salesChannelId));
  154.         return true;
  155.     }
  157.     public function resetTheme(string $themeId, Context $context): void
  158.     {
  159.         $criteria = new Criteria([$themeId]);
  160.         $theme = $this->themeRepository->search($criteria, $context)->get($themeId);
  162.         if (!$theme) {
  163.             throw new InvalidThemeException($themeId);
  164.         }
  166.         $data = ['id' => $themeId];
  167.         $data['configValues'] = null;
  169.         $this->dispatcher->dispatch(new ThemeConfigResetEvent($themeId));
  171.         $this->themeRepository->update([$data], $context);
  172.     }
  174.     /**
  175.      * @throws InvalidThemeConfigException
  176.      * @throws InvalidThemeException
  177.      * @throws InconsistentCriteriaIdsException
  178.      *
  179.      * @return array<string, mixed>
  180.      */
  181.     public function getThemeConfiguration(string $themeId, bool $translate, Context $context): array
  182.     {
  183.         $criteria = new Criteria();
  184.         $criteria->setTitle('theme-service::load-config');
  186.         $themes = $this->themeRepository->search($criteria, $context);
  188.         $theme = $themes->get($themeId);
  190.         /** @var ThemeEntity|null $theme */
  191.         if (!$theme) {
  192.             throw new InvalidThemeException($themeId);
  193.         }
  195.         /** @var ThemeEntity $baseTheme */
  196.         $baseTheme = $themes->filter(fn (ThemeEntity $themeEntry) => $themeEntry->getTechnicalName() === StorefrontPluginRegistry::BASE_THEME_NAME)->first();
  198.         $baseThemeConfig = $this->mergeStaticConfig($baseTheme);
  200.         $themeConfigFieldFactory = new ThemeConfigFieldFactory();
  201.         $configFields = [];
  202.         $labels = array_replace_recursive($baseTheme->getLabels() ?? [], $theme->getLabels() ?? []);
  203.         $helpTexts = array_replace_recursive($baseTheme->getHelpTexts() ?? [], $theme->getHelpTexts() ?? []);
  205.         if ($theme->getParentThemeId()) {
  206.             $parentThemes = $this->getParentThemeIds($themes, $theme);
  208.             foreach ($parentThemes as $parentTheme) {
  209.                 $configuredParentTheme = $this->mergeStaticConfig($parentTheme);
  210.                 $baseThemeConfig = array_replace_recursive($baseThemeConfig, $configuredParentTheme);
  211.                 $labels = array_replace_recursive($labels, $parentTheme->getLabels() ?? []);
  212.                 $helpTexts = array_replace_recursive($helpTexts, $parentTheme->getHelpTexts() ?? []);
  213.             }
  214.         }
  216.         $configuredTheme = $this->mergeStaticConfig($theme);
  217.         $themeConfig = array_replace_recursive($baseThemeConfig, $configuredTheme);
  219.         foreach ($themeConfig['fields'] ?? [] as $name => &$item) {
  220.             $configFields[$name] = $themeConfigFieldFactory->create($name, $item);
  221.             if (
  222.                 isset($item['value'])
  223.                 && isset($configuredTheme['fields'])
  224.                 && \is_array($item['value'])
  225.                 && \array_key_exists($name, $configuredTheme['fields'])
  226.             ) {
  227.                 $configFields[$name]->setValue($configuredTheme['fields'][$name]['value']);
  228.             }
  229.         }
  231.         $configFields = json_decode((string) json_encode($configFields, \JSON_THROW_ON_ERROR), true, 512, \JSON_THROW_ON_ERROR);
  233.         if ($translate && !empty($labels)) {
  234.             $configFields = $this->translateLabels($configFields, $labels);
  235.         }
  237.         if ($translate && !empty($helpTexts)) {
  238.             $configFields = $this->translateHelpTexts($configFields, $helpTexts);
  239.         }
  241.         $themeConfig['fields'] = $configFields;
  242.         $themeConfig['currentFields'] = [];
  243.         $themeConfig['baseThemeFields'] = [];
  245.         foreach ($themeConfig['fields'] as $field => $fieldItem) {
  246.             $isInherited = $this->fieldIsInherited($field, $configuredTheme);
  247.             $themeConfig['currentFields'][$field]['isInherited'] = $isInherited;
  249.             if ($isInherited) {
  250.                 $themeConfig['currentFields'][$field]['value'] = null;
  251.             } elseif (\array_key_exists('value', $fieldItem)) {
  252.                 $themeConfig['currentFields'][$field]['value'] = $fieldItem['value'];
  253.             }
  255.             $isInherited = $this->fieldIsInherited($field, $baseThemeConfig);
  256.             $themeConfig['baseThemeFields'][$field]['isInherited'] = $isInherited;
  258.             if ($isInherited) {
  259.                 $themeConfig['baseThemeFields'][$field]['value'] = null;
  260.             } elseif (\array_key_exists('value', $fieldItem) && isset($baseThemeConfig['fields'][$field]['value'])) {
  261.                 $themeConfig['baseThemeFields'][$field]['value'] = $baseThemeConfig['fields'][$field]['value'];
  262.             }
  263.         }
  265.         return $themeConfig;
  266.     }
  268.     /**
  269.      * @return array<string, mixed>
  270.      */
  271.     public function getThemeConfigurationStructuredFields(string $themeId, bool $translate, Context $context): array
  272.     {
  273.         $mergedConfig = $this->getThemeConfiguration($themeId, $translate, $context)['fields'];
  275.         $translations = [];
  276.         if ($translate) {
  277.             $translations = $this->getTranslations($themeId, $context);
  278.             $mergedConfig = $this->translateLabels($mergedConfig, $translations);
  279.         }
  281.         $outputStructure = [];
  283.         foreach ($mergedConfig as $fieldName => $fieldConfig) {
  284.             $tab = $this->getTab($fieldConfig);
  285.             $tabLabel = $this->getTabLabel($tab, $translations);
  286.             $block = $this->getBlock($fieldConfig);
  287.             $blockLabel = $this->getBlockLabel($block, $translations);
  288.             $section = $this->getSection($fieldConfig);
  289.             $sectionLabel = $this->getSectionLabel($section, $translations);
  291.             // set default tab
  292.             $outputStructure['tabs']['default']['label'] = '';
  294.             // set labels
  295.             $outputStructure['tabs'][$tab]['label'] = $tabLabel;
  296.             $outputStructure['tabs'][$tab]['blocks'][$block]['label'] = $blockLabel;
  297.             $outputStructure['tabs'][$tab]['blocks'][$block]['sections'][$section]['label'] = $sectionLabel;
  299.             // add fields to sections
  300.             $outputStructure['tabs'][$tab]['blocks'][$block]['sections'][$section]['fields'][$fieldName] = [
  301.                 'label' => $fieldConfig['label'],
  302.                 'helpText' => $fieldConfig['helpText'] ?? null,
  303.                 'type' => $fieldConfig['type'],
  304.                 'custom' => $fieldConfig['custom'],
  305.                 'fullWidth' => $fieldConfig['fullWidth'],
  306.             ];
  307.         }
  309.         return $outputStructure;
  310.     }
  312.     public function getThemeDependencyMapping(string $themeId): ThemeSalesChannelCollection
  313.     {
  314.         $mappings = new ThemeSalesChannelCollection();
  315.         $themeData = $this->connection->fetchAllAssociative(
  316.             'SELECT LOWER(HEX(theme.id)) as id, LOWER(HEX(childTheme.id)) as dependentId,
  317.             LOWER(HEX(tsc.sales_channel_id)) as saleschannelId,
  318.             LOWER(HEX(dtsc.sales_channel_id)) as dsaleschannelId
  319.             FROM theme
  320.             LEFT JOIN theme as childTheme ON childTheme.parent_theme_id = theme.id
  321.             LEFT JOIN theme_sales_channel as tsc ON theme.id = tsc.theme_id
  322.             LEFT JOIN theme_sales_channel as dtsc ON childTheme.id = dtsc.theme_id
  323.             WHERE theme.id = :id',
  324.             ['id' => Uuid::fromHexToBytes($themeId)]
  325.         );
  327.         foreach ($themeData as $data) {
  328.             if (isset($data['id']) && isset($data['saleschannelId']) && $data['id'] === $themeId) {
  329.                 $mappings->add(new ThemeSalesChannel($data['id'], $data['saleschannelId']));
  330.             }
  331.             if (isset($data['dependentId']) && isset($data['dsaleschannelId'])) {
  332.                 $mappings->add(new ThemeSalesChannel($data['dependentId'], $data['dsaleschannelId']));
  333.             }
  334.         }
  336.         return $mappings;
  337.     }
  339.     /**
  340.      * @param array<string, mixed> $parentThemes
  341.      *
  342.      * @return array<string, mixed>
  343.      */
  344.     private function getParentThemeIds(EntitySearchResult $themes, ThemeEntity $mainTheme, array $parentThemes = []): array
  345.     {
  346.         foreach ($this->getConfigInheritance($mainTheme) as $parentThemeName) {
  347.             $parentTheme = $themes->filter(fn (ThemeEntity $themeEntry) => $themeEntry->getTechnicalName() === str_replace('@', '', (string) $parentThemeName))->first();
  349.             if ($parentTheme instanceof ThemeEntity && !\array_key_exists($parentTheme->getId(), $parentThemes)) {
  350.                 $parentThemes[$parentTheme->getId()] = $parentTheme;
  352.                 if ($parentTheme->getParentThemeId()) {
  353.                     $parentThemes = $this->getParentThemeIds($themes, $mainTheme, $parentThemes);
  354.                 }
  355.             }
  356.         }
  358.         if ($mainTheme->getParentThemeId()) {
  359.             $parentTheme = $themes->filter(fn (ThemeEntity $themeEntry) => $themeEntry->getId() === $mainTheme->getParentThemeId())->first();
  361.             if ($parentTheme instanceof ThemeEntity && !\array_key_exists($parentTheme->getId(), $parentThemes)) {
  362.                 $parentThemes[$parentTheme->getId()] = $parentTheme;
  363.                 if ($parentTheme->getParentThemeId()) {
  364.                     $parentThemes = $this->getParentThemeIds($themes, $mainTheme, $parentThemes);
  365.                 }
  366.             }
  367.         }
  369.         return $parentThemes;
  370.     }
  372.     /**
  373.      * @return array<string, mixed>
  374.      */
  375.     private function getConfigInheritance(ThemeEntity $mainTheme): array
  376.     {
  377.         if (\is_array($mainTheme->getBaseConfig())
  378.             && \array_key_exists('configInheritance', $mainTheme->getBaseConfig())
  379.             && \is_array($mainTheme->getBaseConfig()['configInheritance'])
  380.             && !empty($mainTheme->getBaseConfig()['configInheritance'])
  381.         ) {
  382.             return $mainTheme->getBaseConfig()['configInheritance'];
  383.         }
  385.         return [];
  386.     }
  388.     /**
  389.      * @return array<string, mixed>
  390.      */
  391.     private function mergeStaticConfig(ThemeEntity $theme): array
  392.     {
  393.         $configuredTheme = [];
  395.         $pluginConfig = null;
  396.         if ($theme->getTechnicalName()) {
  397.             $pluginConfig = $this->extensionRegistry->getConfigurations()->getByTechnicalName($theme->getTechnicalName());
  398.         }
  400.         if ($pluginConfig !== null) {
  401.             $configuredTheme = $pluginConfig->getThemeConfig();
  402.         }
  404.         if ($theme->getBaseConfig() !== null) {
  405.             $configuredTheme = array_replace_recursive($configuredTheme ?? [], $theme->getBaseConfig());
  406.         }
  408.         if ($theme->getConfigValues() !== null) {
  409.             foreach ($theme->getConfigValues() as $fieldName => $configValue) {
  410.                 if (\array_key_exists('value', $configValue)) {
  411.                     $configuredTheme['fields'][$fieldName]['value'] = $configValue['value'];
  412.                 }
  413.             }
  414.         }
  416.         return $configuredTheme ?: [];
  417.     }
  419.     /**
  420.      * @param array<string, mixed> $fieldConfig
  421.      */
  422.     private function getTab(array $fieldConfig): string
  423.     {
  424.         $tab = 'default';
  426.         if (isset($fieldConfig['tab'])) {
  427.             $tab = $fieldConfig['tab'];
  428.         }
  430.         return $tab;
  431.     }
  433.     /**
  434.      * @param array<string, mixed> $fieldConfig
  435.      */
  436.     private function getBlock(array $fieldConfig): string
  437.     {
  438.         $block = 'default';
  440.         if (isset($fieldConfig['block'])) {
  441.             $block = $fieldConfig['block'];
  442.         }
  444.         return $block;
  445.     }
  447.     /**
  448.      * @param array<string, mixed> $fieldConfig
  449.      */
  450.     private function getSection(array $fieldConfig): string
  451.     {
  452.         $section = 'default';
  454.         if (isset($fieldConfig['section'])) {
  455.             $section = $fieldConfig['section'];
  456.         }
  458.         return $section;
  459.     }
  461.     /**
  462.      * @param array<string, mixed> $translations
  463.      */
  464.     private function getTabLabel(string $tabName, array $translations): string
  465.     {
  466.         if ($tabName === 'default') {
  467.             return '';
  468.         }
  470.         return $translations['tabs.' . $tabName] ?? $tabName;
  471.     }
  473.     /**
  474.      * @param array<string, mixed> $translations
  475.      */
  476.     private function getBlockLabel(string $blockName, array $translations): string
  477.     {
  478.         if ($blockName === 'default') {
  479.             return '';
  480.         }
  482.         return $translations['blocks.' . $blockName] ?? $blockName;
  483.     }
  485.     /**
  486.      * @param array<string, mixed> $translations
  487.      */
  488.     private function getSectionLabel(string $sectionName, array $translations): string
  489.     {
  490.         if ($sectionName === 'default') {
  491.             return '';
  492.         }
  494.         return $translations['sections.' . $sectionName] ?? $sectionName;
  495.     }
  497.     /**
  498.      * @param array<string, mixed> $themeConfiguration
  499.      * @param array<string, mixed> $translations
  500.      *
  501.      * @return array<string, mixed>
  502.      */
  503.     private function translateLabels(array $themeConfiguration, array $translations): array
  504.     {
  505.         foreach ($themeConfiguration as $key => &$value) {
  506.             $value['label'] = $translations['fields.' . $key] ?? $key;
  507.         }
  509.         return $themeConfiguration;
  510.     }
  512.     /**
  513.      * @param array<string, mixed> $themeConfiguration
  514.      * @param array<string, mixed> $translations
  515.      *
  516.      * @return array<string, mixed>
  517.      */
  518.     private function translateHelpTexts(array $themeConfiguration, array $translations): array
  519.     {
  520.         foreach ($themeConfiguration as $key => &$value) {
  521.             $value['helpText'] = $translations['fields.' . $key] ?? null;
  522.         }
  524.         return $themeConfiguration;
  525.     }
  527.     /**
  528.      * @return array<string, mixed>
  529.      */
  530.     private function getTranslations(string $themeId, Context $context): array
  531.     {
  532.         /** @var ThemeEntity $theme */
  533.         $theme = $this->themeRepository->search(new Criteria([$themeId]), $context)->get($themeId);
  534.         $translations = $theme->getLabels() ?: [];
  536.         if ($theme->getParentThemeId()) {
  537.             $criteria = new Criteria();
  538.             $criteria->setTitle('theme-service::load-translations');
  540.             $themes = $this->themeRepository->search($criteria, $context);
  541.             $parentThemes = $this->getParentThemeIds($themes, $theme);
  543.             foreach ($parentThemes as $parentTheme) {
  544.                 $parentTranslations = $parentTheme->getLabels() ?: [];
  545.                 $translations = array_replace_recursive($parentTranslations, $translations);
  546.             }
  547.         }
  549.         return $translations;
  550.     }
  552.     /**
  553.      * @param array<string, mixed> $configuration
  554.      */
  555.     private function fieldIsInherited(string $fieldName, array $configuration): bool
  556.     {
  557.         if (!isset($configuration['fields'])) {
  558.             return true;
  559.         }
  561.         if (!\is_array($configuration['fields'])) {
  562.             return true;
  563.         }
  565.         if (!\array_key_exists($fieldName, $configuration['fields'])) {
  566.             return true;
  567.         }
  569.         return false;
  570.     }
  571. }