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 $setCache;
  38         /** @var Cache */
  39         protected $delCache;
  40         /** @var bool field to check if something is to save */
  41         protected $changedConfig = false;
  42
  43         public function __construct(DatabaseConfig $config)
  44         {
  45                 $this->config   = $config;
  46                 $this->setCache = new Cache();
  47                 $this->delCache = new Cache();
  48         }
  49
  50         /** {@inheritDoc} */
  51         public function set(string $cat, string $key, $value): ISetConfigValuesTransactionally
  52         {
  53                 $this->setCache->set($cat, $key, $value, Cache::SOURCE_DATA);
  54                 $this->changedConfig = true;
  55
  56                 return $this;
  57         }
  58
  59
  60         /** {@inheritDoc} */
  61         public function delete(string $cat, string $key): ISetConfigValuesTransactionally
  62         {
  63                 $this->delCache->set($cat, $key, true, Cache::SOURCE_DATA);
  64                 $this->changedConfig = true;
  65
  66                 return $this;
  67         }
  68
  69         /** {@inheritDoc} */
  70         public function commit(): void
  71         {
  72                 // If nothing changed, just do nothing :)
  73                 if (!$this->changedConfig) {
  74                         return;
  75                 }
  76
  77                 try {
  78                         $this->config->setAndSave($this->setCache, $this->delCache);
  79                         $this->setCache = new Cache();
  80                         $this->delCache = new Cache();
  81                 } catch (\Exception $e) {
  82                         throw new ConfigPersistenceException('Cannot save config', $e);
  83                 }
  84         }
  85 }