src/Core/Config/Model/ConfigTransaction.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Config\Model;
  23
  24 use Friendica\Core\Config\Capability\IManageConfigValues;
  25 use Friendica\Core\Config\Capability\ISetConfigValuesTransactionally;
  26 use Friendica\Core\Config\Exception\ConfigPersistenceException;
  27 use Friendica\Core\Config\ValueObject\Cache;
  28
  29 /**
  30  * Transaction class for configurations, which sets values into a temporary buffer until "save()" is called
  31  */
  32 class ConfigTransaction implements ISetConfigValuesTransactionally
  33 {
  34         /** @var IManageConfigValues */
  35         protected $config;
  36         /** @var Cache */
  37         protected $cache;
  38         /** @var bool field to check if something is to save */
  39         protected $changedConfig = false;
  40
  41         public function __construct(IManageConfigValues $config)
  42         {
  43                 $this->config = $config;
  44                 $this->cache  = clone $config->getCache();
  45         }
  46
  47         /** {@inheritDoc} */
  48         public function set(string $cat, string $key, $value): ISetConfigValuesTransactionally
  49         {
  50                 $this->cache->set($cat, $key, $value, Cache::SOURCE_DATA);
  51                 $this->changedConfig = true;
  52
  53                 return $this;
  54         }
  55
  56
  57         /** {@inheritDoc} */
  58         public function delete(string $cat, string $key): ISetConfigValuesTransactionally
  59         {
  60                 $this->cache->delete($cat, $key, Cache::SOURCE_DATA);
  61                 $this->changedConfig = true;
  62
  63                 return $this;
  64         }
  65
  66         /** {@inheritDoc} */
  67         public function commit(): void
  68         {
  69                 // If nothing changed, just do nothing :)
  70                 if (!$this->changedConfig) {
  71                         return;
  72                 }
  73
  74                 try {
  75                         $this->config->load($this->cache);
  76                         $this->cache = clone $this->config->getCache();
  77                 } catch (\Exception $e) {
  78                         throw new ConfigPersistenceException('Cannot save config', $e);
  79                 }
  80         }
  81 }