]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Config.php
Fewer Defaults
[friendica.git] / src / Core / Config.php
index f3c5dc13a1800c9e7b015c8c233519221968ca73..5e162a3fa4e36536c9dbb562071b669099d7396a 100644 (file)
@@ -1,28 +1,31 @@
 <?php
-namespace Friendica\Core;
-
-use dba;
-use dbm;
-
 /**
+ * System Configuration Class
+ *
  * @file include/Core/Config.php
  *
- *  @brief Contains the class with methods for system configuration
+ * @brief Contains the class with methods for system configuration
  */
+namespace Friendica\Core;
+
+use Friendica\Database\DBM;
+use dba;
 
+require_once 'include/dba.php';
 
 /**
  * @brief Arbitrary sytem configuration storage
+ *
  * Note:
- * Please do not store booleans - convert to 0/1 integer values
- * The Config::get() functions return boolean false for keys that are unset,
- * and this could lead to subtle bugs.
+ * If we ever would decide to return exactly the variable type as entered,
+ * we will have fun with the additional features. :-)
+ *
+ * The config class always returns strings but in the default features
+ * we use a "false" to determine if the config value isn't set.
  *
- * There are a few places in the code (such as the admin panel) where boolean
- * configurations need to be fixed as of 10/08/2011.
  */
-class Config {
-
+class Config
+{
        private static $cache;
        private static $in_db;
 
@@ -32,12 +35,12 @@ class Config {
         * All configuration values of the system are stored in global cache
         * which is available under the global variable $a->config
         *
-        * @param string $family
-        *  The category of the configuration value
+        * @param string $family The category of the configuration value
+        *
         * @return void
         */
-       public static function load($family = "config") {
-
+       public static function load($family = "config")
+       {
                // We don't preload "system" anymore.
                // This reduces the number of database reads a lot.
                if ($family === 'system') {
@@ -46,7 +49,7 @@ class Config {
 
                $a = get_app();
 
-               $r = dba::select('config', array('v', 'k'), array('cat' => $family));
+               $r = dba::select('config', ['v', 'k'], ['cat' => $family]);
                while ($rr = dba::fetch($r)) {
                        $k = $rr['k'];
                        if ($family === 'config') {
@@ -57,6 +60,7 @@ class Config {
                                self::$in_db[$family][$k] = true;
                        }
                }
+               dba::close($r);
        }
 
        /**
@@ -71,22 +75,18 @@ class Config {
         * local config cache, pull it into the cache so we don't have
         * to hit the DB again for this item.
         *
-        * @param string $family
-        *  The category of the configuration value
-        * @param string $key
-        *  The configuration key to query
-        * @param mixed $default_value optional
-        *  The value to return if key is not set (default: null)
-        * @param boolean $refresh optional
-        *  If true the config is loaded from the db and not from the cache (default: false)
+        * @param string  $family        The category of the configuration value
+        * @param string  $key           The configuration key to query
+        * @param mixed   $default_value optional, The value to return if key is not set (default: null)
+        * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)
+        *
         * @return mixed Stored value or null if it does not exist
         */
-       public static function get($family, $key, $default_value = null, $refresh = false) {
-
+       public static function get($family, $key, $default_value = null, $refresh = false)
+       {
                $a = get_app();
 
                if (!$refresh) {
-
                        // Do we have the cached value? Then return it
                        if (isset(self::$cache[$family][$key])) {
                                if (self::$cache[$family][$key] === '!<unset>!') {
@@ -97,17 +97,16 @@ class Config {
                        }
                }
 
-               $ret = dba::select('config', array('v'), array('cat' => $family, 'k' => $key), array('limit' => 1));
-               if (dbm::is_result($ret)) {
+               $config = dba::selectFirst('config', ['v'], ['cat' => $family, 'k' => $key]);
+               if (DBM::is_result($config)) {
                        // manage array value
-                       $val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret['v']) ? unserialize($ret['v']) : $ret['v']);
+                       $val = (preg_match("|^a:[0-9]+:{.*}$|s", $config['v']) ? unserialize($config['v']) : $config['v']);
 
                        // Assign the value from the database to the cache
                        self::$cache[$family][$key] = $val;
                        self::$in_db[$family][$key] = true;
                        return $val;
                } elseif (isset($a->config[$family][$key])) {
-
                        // Assign the value (mostly) from the .htconfig.php to the cache
                        self::$cache[$family][$key] = $a->config[$family][$key];
                        self::$in_db[$family][$key] = false;
@@ -129,15 +128,14 @@ class Config {
         *
         * Note: Please do not store booleans - convert to 0/1 integer values!
         *
-        * @param string $family
-        *  The category of the configuration value
-        * @param string $key
-        *  The configuration key to set
-        * @param string $value
-        *  The value to store
+        * @param string $family The category of the configuration value
+        * @param string $key    The configuration key to set
+        * @param mixed  $value  The value to store
+        *
         * @return mixed Stored $value or false if the database update failed
         */
-       public static function set($family, $key, $value) {
+       public static function set($family, $key, $value)
+       {
                $a = get_app();
 
                // We store our setting values in a string variable.
@@ -163,7 +161,7 @@ class Config {
                // manage array value
                $dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
 
-               dba::update('config', array('v' => $dbvalue), array('cat' => $family, 'k' => $key), true);
+               $ret = dba::update('config', ['v' => $dbvalue], ['cat' => $family, 'k' => $key], true);
 
                if ($ret) {
                        self::$in_db[$family][$key] = true;
@@ -178,20 +176,19 @@ class Config {
         * Removes the configured value from the stored cache in $a->config
         * and removes it from the database.
         *
-        * @param string $family
-        *  The category of the configuration value
-        * @param string $key
-        *  The configuration key to delete
+        * @param string $family The category of the configuration value
+        * @param string $key    The configuration key to delete
+        *
         * @return mixed
         */
-       public static function delete($family, $key) {
-
+       public static function delete($family, $key)
+       {
                if (isset(self::$cache[$family][$key])) {
                        unset(self::$cache[$family][$key]);
                        unset(self::$in_db[$family][$key]);
                }
 
-               $ret = dba::delete('config', array('cat' => $family, 'k' => $key));
+               $ret = dba::delete('config', ['cat' => $family, 'k' => $key]);
 
                return $ret;
        }