vendor/pimcore/pimcore/lib/Model/Dao/PimcoreLocationAwareConfigDao.php line 89

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Model\Dao;
  18. use Pimcore\Config;
  20. abstract class PimcoreLocationAwareConfigDao implements DaoInterface
  21. {
  22.     use DaoTrait;
  24.     private static array $cache = [];
  26.     protected ?string $settingsStoreScope = null;
  28.     protected ?string $dataSource = null;
  30.     private ?string $id = null;
  32.     private Config\LocationAwareConfigRepository $locationAwareConfigRepository;
  34.     /**
  35.      * {@inheritdoc}
  36.      */
  37.     public function configure()
  38.     {
  39.         $params = func_get_arg(0);
  40.         $this->settingsStoreScope = $params['settingsStoreScope'] ?? 'pimcore_config';
  42.         if (!isset(self::$cache[$this->settingsStoreScope])) {
  43.             // initialize runtime cache
  44.             self::$cache[$this->settingsStoreScope] = [];
  45.         }
  47.         $this->locationAwareConfigRepository = new Config\LocationAwareConfigRepository(
  48.             $params['containerConfig'] ?? [],
  49.             $this->settingsStoreScope,
  50.             $params['storageDirectory'] ?? null,
  51.             $params['writeTargetEnvVariableName'] ?? null,
  52.             $params['defaultWriteLocation'] ?? null,
  53.             $params['legacyConfigFile'] ?? null
  54.         );
  55.     }
  57.     /**
  58.      * @param string $id
  59.      *
  60.      * @return mixed
  61.      */
  62.     protected function getDataByName(string $id)
  63.     {
  64.         $this->id = $id;
  66.         if (isset(self::$cache[$this->settingsStoreScope][$id])) {
  67.             $this->dataSource = self::$cache[$this->settingsStoreScope][$id]['datasource'];
  69.             return self::$cache[$this->settingsStoreScope][$id]['data'];
  70.         }
  72.         list($data, $this->dataSource) = $this->locationAwareConfigRepository->loadConfigByKey($id);
  74.         if ($data) {
  75.             self::$cache[$this->settingsStoreScope][$id] = [
  76.                 'datasource' => $this->dataSource,
  77.                 'data' => $data,
  78.             ];
  79.         }
  81.         return $data;
  82.     }
  84.     /**
  85.      * @return array
  86.      */
  87.     protected function loadIdList(): array
  88.     {
  89.         return $this->locationAwareConfigRepository->fetchAllKeys();
  90.     }
  92.     /**
  93.      * Removes config with corresponding id from the cache.
  94.      * A new cache entry will be generated upon requesting the config again.
  95.      *
  96.      * @param string $id
  97.      */
  98.     protected function invalidateCache(string $id): void
  99.     {
  100.         unset(self::$cache[$this->settingsStoreScope][$id]);
  101.     }
  103.     /**
  104.      * @param string $id
  105.      * @param array $data
  106.      *
  107.      * @throws \Exception
  108.      */
  109.     protected function saveData(string $id, $data)
  110.     {
  111.         $dao = $this;
  112.         $this->invalidateCache($id);
  113.         $this->locationAwareConfigRepository->saveConfig($id, $data, function ($id, $data) use ($dao) {
  114.             return $dao->prepareDataStructureForYaml($id, $data);
  115.         });
  116.     }
  118.     /**
  119.      * Hook to prepare config data structure for yaml
  120.      *
  121.      * @param string $id
  122.      * @param mixed $data
  123.      *
  124.      * @return mixed
  125.      */
  126.     protected function prepareDataStructureForYaml(string $id, $data)
  127.     {
  128.         return $data;
  129.     }
  131.     /**
  132.      * @return string Can be either yaml (var/config/...) or "settings-store". defaults to "yaml"
  133.      *
  134.      * @throws \Exception
  135.      */
  136.     public function getWriteTarget(): string
  137.     {
  138.         return $this->locationAwareConfigRepository->getWriteTarget();
  139.     }
  141.     /**
  142.      * @return bool
  143.      */
  144.     public function isWriteable(): bool
  145.     {
  146.         return $this->locationAwareConfigRepository->isWriteable($this->id, $this->dataSource);
  147.     }
  149.     /**
  150.      * @param string $id
  151.      *
  152.      * @throws \Exception
  153.      */
  154.     protected function deleteData(string $id): void
  155.     {
  156.         $this->invalidateCache($id);
  157.         $this->locationAwareConfigRepository->deleteData($id, $this->dataSource);
  158.     }
  159. }