custom/plugins/PickwareErpStarter/vendor/pickware/shopware-extensions-bundle/src/Mail/SystemConfigServiceDecorator.php line 135

Open in your IDE?
  1. <?php
  2. /*
  3.  * Copyright (c) Pickware GmbH. All rights reserved.
  4.  * This file is part of software that is released under a proprietary license.
  5.  * You must not copy, modify, distribute, make publicly available, or execute
  6.  * its contents or parts thereof without express permission by the copyright
  7.  * holder, unless otherwise permitted by law.
  8.  */
  10. declare(strict_types=1);
  12. namespace Pickware\ShopwareExtensionsBundle\Mail;
  14. use Closure;
  15. use Shopware\Core\Framework\Bundle;
  16. use Shopware\Core\System\SystemConfig\SystemConfigService;
  18. /**
  19.  * To avoid unwanted side effects when disabling mail delivery (because the state is saved in DB)
  20.  * we need this Decorator to override the 'core.mailerSettings.disableDelivery' on request level.
  21.  * Use this Decorator in combination with the following Service:
  22.  * @see MailSendSuppressionService
  23.  */
  24. class SystemConfigServiceDecorator extends SystemConfigService
  25. {
  26.     /**
  27.      * In Shopware in src/Core/Framework/Test/TestCaseBase/SystemConfigTestBehaviour.php in
  28.      * versions <= 6.4.9.0, there is direct access to $configs: `$property = $reflection->getProperty('configs');`.
  29.      * This is why we have to declare the property, even though we do not use it, as otherwise
  30.      * tests that include src/Core/Framework/Test/TestCaseBase/IntegrationTestBehaviour.php will fail.
  31.      */
  32.     public $configs = [];
  34.     /**
  35.      * The pickware key is just saved in the current request.
  36.      */
  37.     public const PICKWARE_DISABLE_MAIL_DELIVERY = 'PickwareShopwareExtensionsBundle.mailerSettings.disableDelivery';
  39.     /**
  40.      * When the user asks for the setting of 'core.mailerSettings.disableDelivery' the decorator
  41.      * checks state against the pickware custom property ($disableMailDelivery) and the original key (from database).
  42.      */
  43.     private const SHOPWARE_DISABLE_MAIL_DELIVERY = 'core.mailerSettings.disableDelivery';
  45.     private SystemConfigService $decoratedSystemConfigService;
  46.     private bool $disableMailDelivery = false;
  48.     public function __construct(SystemConfigService $decoratedSystemConfigService)
  49.     {
  50.         $this->decoratedSystemConfigService = $decoratedSystemConfigService;
  51.     }
  53.     public function get(string $key, ?string $salesChannelId = null)
  54.     {
  55.         // For 'core.mailerSettings.disableDelivery' check pickware custom override property and then shopware setting.
  56.         if ($key === self::SHOPWARE_DISABLE_MAIL_DELIVERY) {
  57.             return $this->disableMailDelivery || $this->decoratedSystemConfigService->get($key, $salesChannelId);
  58.         }
  60.         return $this->decoratedSystemConfigService->get($key, $salesChannelId);
  61.     }
  63.     public function getString(string $key, ?string $salesChannelId = null): string
  64.     {
  65.         return $this->decoratedSystemConfigService->getString($key, $salesChannelId);
  66.     }
  68.     public function getInt(string $key, ?string $salesChannelId = null): int
  69.     {
  70.         return $this->decoratedSystemConfigService->getInt($key, $salesChannelId);
  71.     }
  73.     public function getFloat(string $key, ?string $salesChannelId = null): float
  74.     {
  75.         return $this->decoratedSystemConfigService->getFloat($key, $salesChannelId);
  76.     }
  78.     public function getBool(string $key, ?string $salesChannelId = null): bool
  79.     {
  80.         // For 'core.mailerSettings.disableDelivery' check pickware custom override property and then shopware setting.
  81.         if ($key === self::SHOPWARE_DISABLE_MAIL_DELIVERY) {
  82.             return $this->disableMailDelivery || $this->decoratedSystemConfigService->getBool($key, $salesChannelId);
  83.         }
  85.         return $this->decoratedSystemConfigService->getBool($key, $salesChannelId);
  86.     }
  88.     public function all(?string $salesChannelId = null): array
  89.     {
  90.         return $this->decoratedSystemConfigService->all($salesChannelId);
  91.     }
  93.     public function getDomain(string $domain, ?string $salesChannelId = null, bool $inherit = false): array
  94.     {
  95.         return $this->decoratedSystemConfigService->getDomain($domain, $salesChannelId, $inherit);
  96.     }
  98.     public function set(string $key, $value, ?string $salesChannelId = null): void
  99.     {
  100.         // The pickware key is not saved in the database! The key is scoped to the request.
  101.         if ($key === self::PICKWARE_DISABLE_MAIL_DELIVERY) {
  102.             $this->disableMailDelivery = (bool) $value;
  104.             return;
  105.         }
  107.         $this->decoratedSystemConfigService->set($key, $value, $salesChannelId);
  108.     }
  110.     public function delete(string $key, ?string $salesChannel = null): void
  111.     {
  112.         $this->decoratedSystemConfigService->delete($key, $salesChannel);
  113.     }
  115.     public function savePluginConfiguration(Bundle $bundle, bool $override = false): void
  116.     {
  117.         $this->decoratedSystemConfigService->savePluginConfiguration($bundle, $override);
  118.     }
  120.     public function saveConfig(array $config, string $prefix, bool $override): void
  121.     {
  122.         $this->decoratedSystemConfigService->saveConfig($config, $prefix, $override);
  123.     }
  125.     public function deletePluginConfiguration(Bundle $bundle): void
  126.     {
  127.         $this->decoratedSystemConfigService->deletePluginConfiguration($bundle);
  128.     }
  130.     public function deleteExtensionConfiguration(string $extensionName, array $config): void
  131.     {
  132.         $this->decoratedSystemConfigService->deleteExtensionConfiguration($extensionName, $config);
  133.     }
  135.     public function trace(string $key, Closure $param)
  136.     {
  137.         return $this->decoratedSystemConfigService->trace($key, $param);
  138.     }
  140.     public function getTrace(string $key): array
  141.     {
  142.         return $this->decoratedSystemConfigService->getTrace($key);
  143.     }
  144. }