From ac5bcb62ec67b97fce9c982b0c6ed4624e8e6671 Mon Sep 17 00:00:00 2001 From: logmanoriginal Date: Sun, 18 Nov 2018 15:52:28 +0100 Subject: [PATCH] [Configuration] Add documentation for defined constants --- lib/Configuration.php | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lib/Configuration.php b/lib/Configuration.php index 9dfd2938..4f6f2f64 100644 --- a/lib/Configuration.php +++ b/lib/Configuration.php @@ -138,8 +138,6 @@ final class Configuration { * _Notice_: The configuration is stored in {@see Configuration::$config}. * * @return void - * - * @todo Add documentation for constants defined by this function. */ public static function loadConfiguration() { @@ -165,22 +163,27 @@ final class Configuration { if(!is_string(self::getConfig('proxy', 'url'))) die('Parameter [proxy] => "url" is not a valid string! Please check "config.ini.php"!'); - if(!empty(self::getConfig('proxy', 'url'))) + if(!empty(self::getConfig('proxy', 'url'))) { + /** URL of the proxy server */ define('PROXY_URL', self::getConfig('proxy', 'url')); + } if(!is_bool(self::getConfig('proxy', 'by_bridge'))) die('Parameter [proxy] => "by_bridge" is not a valid Boolean! Please check "config.ini.php"!'); + /** True if proxy usage can be enabled selectively for each bridge */ define('PROXY_BYBRIDGE', self::getConfig('proxy', 'by_bridge')); if(!is_string(self::getConfig('proxy', 'name'))) die('Parameter [proxy] => "name" is not a valid string! Please check "config.ini.php"!'); + /** Name of the proxy server */ define('PROXY_NAME', self::getConfig('proxy', 'name')); if(!is_bool(self::getConfig('cache', 'custom_timeout'))) die('Parameter [cache] => "custom_timeout" is not a valid Boolean! Please check "config.ini.php"!'); + /** True if the cache timeout can be specified by the user */ define('CUSTOM_CACHE_TIMEOUT', self::getConfig('cache', 'custom_timeout')); if(!is_bool(self::getConfig('authentication', 'enable')))