src/Core/Config/Factory/Config.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\Factory;
  23
  24 use Friendica\Core\Config\Util;
  25 use Friendica\Core\Config\ValueObject\Cache;
  26
  27 /**
  28  * The config factory for creating either the cache or the whole model
  29  */
  30 class Config
  31 {
  32         /**
  33          * The key of the $_SERVER variable to override the config directory
  34          *
  35          * @var string
  36          */
  37         const CONFIG_DIR_ENV = 'FRIENDICA_CONFIG_DIR';
  38
  39         /**
  40          * The Sub directory of the config-files
  41          *
  42          * @var string
  43          */
  44         const CONFIG_DIR = 'config';
  45
  46         /**
  47          * The Sub directory of the static config-files
  48          *
  49          * @var string
  50          */
  51         const STATIC_DIR = 'static';
  52
  53         /**
  54          * @param string $basePath The basepath of FRIENDICA
  55          * @param array  $server   The $_SERVER array
  56          *
  57          * @return Util\ConfigFileManager
  58          */
  59         public function createConfigFileManager(string $basePath, array $server = []): Util\ConfigFileManager
  60         {
  61                 if (!empty($server[self::CONFIG_DIR_ENV]) && is_dir($server[self::CONFIG_DIR_ENV])) {
  62                         $configDir = $server[self::CONFIG_DIR_ENV];
  63                 } else {
  64                         $configDir = $basePath . DIRECTORY_SEPARATOR . self::CONFIG_DIR;
  65                 }
  66                 $staticDir = $basePath . DIRECTORY_SEPARATOR . self::STATIC_DIR;
  67
  68                 return new Util\ConfigFileManager($basePath, $configDir, $staticDir, $server);
  69         }
  70
  71         /**
  72          * @param Util\ConfigFileManager $configFileManager The Config Cache manager (INI/config/.htconfig)
  73          *
  74          * @return Cache
  75          */
  76         public function createCache(Util\ConfigFileManager $configFileManager): Cache
  77         {
  78                 $configCache = new Cache();
  79                 $configFileManager->setupCache($configCache);
  80
  81                 return $configCache;
  82         }
  83 }