vendor/shopware/core/System/SystemConfig/Api/SystemConfigController.php line 57

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\System\SystemConfig\Api;
  5. use Shopware\Core\Framework\Context;
  6. use Shopware\Core\Framework\Feature;
  7. use Shopware\Core\Framework\Log\Package;
  8. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  9. use Shopware\Core\System\SystemConfig\Service\ConfigurationService;
  10. use Shopware\Core\System\SystemConfig\SystemConfigService;
  11. use Shopware\Core\System\SystemConfig\Validation\SystemConfigValidator;
  12. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  13. use Symfony\Component\HttpFoundation\JsonResponse;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\Routing\Annotation\Route;
  18. #[Route(defaults: ['_routeScope' => ['api']])]
  19. #[Package('system-settings')]
  20. class SystemConfigController extends AbstractController
  21. {
  22.     /**
  23.      * @internal
  24.      */
  25.     public function __construct(
  26.         private readonly ConfigurationService $configurationService,
  27.         private readonly SystemConfigService $systemConfig,
  28.         private readonly SystemConfigValidator $systemConfigValidator
  29.     ) {
  30.     }
  32.     #[Route(path: '/api/_action/system-config/check', name: 'api.action.core.system-config.check', methods: ['GET'], defaults: ['_acl' => ['system_config:read']])]
  33.     public function checkConfiguration(Request $request, Context $context): JsonResponse
  34.     {
  35.         $domain = (string) $request->query->get('domain');
  37.         if ($domain === '') {
  38.             return new JsonResponse(false);
  39.         }
  41.         return new JsonResponse($this->configurationService->checkConfiguration($domain, $context));
  42.     }
  44.     #[Route(path: '/api/_action/system-config/schema', name: 'api.action.core.system-config', methods: ['GET'])]
  45.     public function getConfiguration(Request $request, Context $context): JsonResponse
  46.     {
  47.         $domain = (string) $request->query->get('domain');
  49.         if ($domain === '') {
  50.             throw new MissingRequestParameterException('domain');
  51.         }
  53.         return new JsonResponse($this->configurationService->getConfiguration($domain, $context));
  54.     }
  56.     #[Route(path: '/api/_action/system-config', name: 'api.action.core.system-config.value', methods: ['GET'], defaults: ['_acl' => ['system_config:read']])]
  57.     public function getConfigurationValues(Request $request): JsonResponse
  58.     {
  59.         $domain = (string) $request->query->get('domain');
  60.         if ($domain === '') {
  61.             throw new MissingRequestParameterException('domain');
  62.         }
  64.         $salesChannelId = $request->query->get('salesChannelId');
  65.         if (!\is_string($salesChannelId)) {
  66.             $salesChannelId = null;
  67.         }
  69.         $values = $this->systemConfig->getDomain($domain, $salesChannelId);
  70.         if (empty($values)) {
  71.             $json = '{}';
  72.         } else {
  73.             $json = json_encode($values, \JSON_PRESERVE_ZERO_FRACTION);
  74.         }
  76.         return new JsonResponse($json, 200, [], true);
  77.     }
  79.     #[Route(path: '/api/_action/system-config', name: 'api.action.core.save.system-config', methods: ['POST'], defaults: ['_acl' => ['system_config:update', 'system_config:create', 'system_config:delete']])]
  80.     public function saveConfiguration(Request $request): JsonResponse
  81.     {
  82.         $salesChannelId = $request->query->get('salesChannelId');
  83.         if (!\is_string($salesChannelId)) {
  84.             $salesChannelId = null;
  85.         }
  87.         $kvs = $request->request->all();
  88.         $this->saveKeyValues($salesChannelId, $kvs);
  90.         return new JsonResponse(null, Response::HTTP_NO_CONTENT);
  91.     }
  93.     /**
  94.      * @deprecated tag:v6.6.0 $context param will be required
  95.      */
  96.     #[Route(path: '/api/_action/system-config/batch', name: 'api.action.core.save.system-config.batch', methods: ['POST'], defaults: ['_acl' => ['system_config:update', 'system_config:create', 'system_config:delete']])]
  97.     public function batchSaveConfiguration(Request $request, ?Context $context = null): JsonResponse
  98.     {
  99.         if (!$context) {
  100.             Feature::triggerDeprecationOrThrow(
  101.                 'v6.6.0.0',
  102.                 'Second parameter `$context` will be required in method `batchSaveConfiguration()` in `SystemConfigController` in v6.6.0.0'
  103.             );
  105.             $context = Context::createDefaultContext();
  106.         }
  108.         $this->systemConfigValidator->validate($request->request->all(), $context);
  110.         /**
  111.          * @var string $salesChannelId
  112.          * @var array<string, mixed> $kvs
  113.          */
  114.         foreach ($request->request->all() as $salesChannelId => $kvs) {
  115.             if ($salesChannelId === 'null') {
  116.                 $salesChannelId = null;
  117.             }
  118.             $this->saveKeyValues($salesChannelId, $kvs);
  119.         }
  121.         return new JsonResponse(null, Response::HTTP_NO_CONTENT);
  122.     }
  124.     /**
  125.      * @param array<string, mixed> $kvs
  126.      */
  127.     private function saveKeyValues(?string $salesChannelId, array $kvs): void
  128.     {
  129.         foreach ($kvs as $key => $value) {
  130.             $this->systemConfig->set($key, $value, $salesChannelId);
  131.         }
  132.     }
  133. }