src/Core/BasePConfig.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   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;
  23
  24 use Friendica\Core\PConfig\Cache;
  25 use Friendica\Core\PConfig\IPConfig;
  26 use Friendica\Model;
  27
  28 /**
  29  * This class is responsible for the user-specific configuration values in Friendica
  30  * The values are set through the Config-DB-Table (per Config-DB-model @see Model\Config\PConfig)
  31  *
  32  * The configuration cache (@see Cache\PConfigCache) is used for temporary caching of database calls. This will
  33  * increase the performance.
  34  */
  35 abstract class BasePConfig implements IPConfig
  36 {
  37         /**
  38          * @var Cache
  39          */
  40         protected $configCache;
  41
  42         /**
  43          * @var Model\Config\PConfig
  44          */
  45         protected $configModel;
  46
  47         /**
  48          * @param Cache $configCache The configuration cache
  49          * @param Model\Config\PConfig          $configModel The configuration model
  50          */
  51         public function __construct(Cache $configCache, Model\Config\PConfig $configModel)
  52         {
  53                 $this->configCache = $configCache;
  54                 $this->configModel = $configModel;
  55         }
  56
  57         /**
  58          * Returns the Config Cache
  59          *
  60          * @return Cache
  61          */
  62         public function getCache()
  63         {
  64                 return $this->configCache;
  65         }
  66 }