<?php /** * This file is part of CodeIgniter 4 framework. * * (c) CodeIgniter Foundation <admin@codeigniter.com> * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. */ namespace CodeIgniter\Config; use Config\Encryption; use Config\Modules; use Config\Services; use ReflectionClass; use ReflectionException; use RuntimeException; /** * Class BaseConfig * * Not intended to be used on its own, this class will attempt to * automatically populate the child class' properties with values * from the environment. * * These can be set within the .env file. */ class BaseConfig { /** * An optional array of classes that will act as Registrars * for rapidly setting config class properties. * * @var array */ public static $registrars = []; /** * Has module discovery happened yet? * * @var bool */ protected static $didDiscovery = false; /** * The modules configuration. * * @var Modules */ protected static $moduleConfig; /** * Will attempt to get environment variables with names * that match the properties of the child class. * * The "shortPrefix" is the lowercase-only config class name. */ public function __construct() { static::$moduleConfig = config('Modules'); $this->registerProperties(); $properties = array_keys(get_object_vars($this)); $prefix = static::class; $slashAt = strrpos($prefix, '\\'); $shortPrefix = strtolower(substr($prefix, $slashAt === false ? 0 : $slashAt + 1)); foreach ($properties as $property) { $this->initEnvValue($this->{$property}, $property, $prefix, $shortPrefix); if ($this instanceof Encryption && $property === 'key') { if (strpos($this->{$property}, 'hex2bin:') === 0) { // Handle hex2bin prefix $this->{$property} = hex2bin(substr($this->{$property}, 8)); } elseif (strpos($this->{$property}, 'base64:') === 0) { // Handle base64 prefix $this->{$property} = base64_decode(substr($this->{$property}, 7), true); } } } } /** * Initialization an environment-specific configuration setting * * @param mixed $property * * @return mixed */ protected function initEnvValue(&$property, string $name, string $prefix, string $shortPrefix) { if (is_array($property)) { foreach (array_keys($property) as $key) { $this->initEnvValue($property[$key], "{$name}.{$key}", $prefix, $shortPrefix); } } elseif (($value = $this->getEnvValue($name, $prefix, $shortPrefix)) !== false && $value !== null) { if ($value === 'false') { $value = false; } elseif ($value === 'true') { $value = true; } $property = is_bool($value) ? $value : trim($value, '\'"'); } return $property; } /** * Retrieve an environment-specific configuration setting * * @return mixed */ protected function getEnvValue(string $property, string $prefix, string $shortPrefix) { $shortPrefix = ltrim($shortPrefix, '\\'); switch (true) { case array_key_exists("{$shortPrefix}.{$property}", $_ENV): return $_ENV["{$shortPrefix}.{$property}"]; case array_key_exists("{$shortPrefix}.{$property}", $_SERVER): return $_SERVER["{$shortPrefix}.{$property}"]; case array_key_exists("{$prefix}.{$property}", $_ENV): return $_ENV["{$prefix}.{$property}"]; case array_key_exists("{$prefix}.{$property}", $_SERVER): return $_SERVER["{$prefix}.{$property}"]; default: $value = getenv("{$shortPrefix}.{$property}"); $value = $value === false ? getenv("{$prefix}.{$property}") : $value; return $value === false ? null : $value; } } /** * Provides external libraries a simple way to register one or more * options into a config file. * * @throws ReflectionException */ protected function registerProperties() { if (! static::$moduleConfig->shouldDiscover('registrars')) { return; } if (! static::$didDiscovery) { $locator = Services::locator(); $registrarsFiles = $locator->search('Config/Registrar.php'); foreach ($registrarsFiles as $file) { $className = $locator->getClassname($file); static::$registrars[] = new $className(); } static::$didDiscovery = true; } $shortName = (new ReflectionClass($this))->getShortName(); // Check the registrar class for a method named after this class' shortName foreach (static::$registrars as $callable) { // ignore non-applicable registrars if (! method_exists($callable, $shortName)) { continue; // @codeCoverageIgnore } $properties = $callable::$shortName(); if (! is_array($properties)) { throw new RuntimeException('Registrars must return an array of properties and their values.'); } foreach ($properties as $property => $value) { if (isset($this->{$property}) && is_array($this->{$property}) && is_array($value)) { $this->{$property} = array_merge($this->{$property}, $value); } else { $this->{$property} = $value; } } } } }