src/Core/Config/Model/ReadOnlyFileConfig.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  * Creates a basic, readonly model for the file-based configuration
  31  */
  32 class ReadOnlyFileConfig implements IManageConfigValues
  33 {
  34         /** @var Cache */
  35         protected $configCache;
  36
  37         /**
  38          * @param Cache $configCache The configuration cache (based on the config-files)
  39          */
  40         public function __construct(Cache $configCache)
  41         {
  42                 $this->configCache = $configCache;
  43         }
  44
  45         /**
  46          * {@inheritDoc}
  47          */
  48         public function getCache(): Cache
  49         {
  50                 return $this->configCache;
  51         }
  52
  53         /**    {@inheritDoc} */
  54         public function beginTransaction(): ISetConfigValuesTransactionally
  55         {
  56                 throw new ConfigPersistenceException('beginTransaction not allowed.');
  57         }
  58
  59         /** {@inheritDoc} */
  60         public function reload()
  61         {
  62                 throw new ConfigPersistenceException('reload not allowed.');
  63         }
  64
  65         /** {@inheritDoc} */
  66         public function get(string $cat, string $key = null, $default_value = null)
  67         {
  68                 return $this->configCache->get($cat, $key) ?? $default_value;
  69         }
  70
  71         /** {@inheritDoc} */
  72         public function isWritable(string $cat, string $key): bool
  73         {
  74                 return $this->configCache->getSource($cat, $key) < Cache::SOURCE_ENV;
  75         }
  76
  77         /** {@inheritDoc} */
  78         public function set(string $cat, string $key, $value): bool
  79         {
  80                 throw new ConfigPersistenceException('set not allowed.');
  81         }
  82
  83         /** {@inheritDoc} */
  84         public function delete(string $cat, string $key): bool
  85         {
  86                 throw new ConfigPersistenceException('Save not allowed');
  87         }
  88 }