Documentation added

[friendica.git] / include / Core / PConfig.php

diff --git a/include/Core/PConfig.php b/include/Core/PConfig.php
index bf563d06e01a5bf242fe084872b7e7cca4e34bde..6ced9fc7553fc6fa1198848c123db0405490f5c9 100644 (file)
--- a/include/Core/PConfig.php
+++ b/include/Core/PConfig.php
@@ -1,5 +1,8 @@
 <?php
 namespace Friendica\Core;
+
+use dbm;
+
 /**
  * @file include/Core/PConfig.php
  * @brief contains the class with methods for the management
@@ -15,6 +18,8 @@ namespace Friendica\Core;
  */
 class PConfig {
 
+       private static $in_db;
+
        /**
         * @brief Loads all configuration values of a user's config family into a cached storage.
         *
@@ -27,16 +32,17 @@ class PConfig {
         *  The category of the configuration value
         * @return void
         */
-       public static function load($uid,$family) {
-               global $a;
-               $r = q("SELECT `v`,`k` FROM `pconfig` WHERE `cat` = '%s' AND `uid` = %d",
+       public static function load($uid, $family) {
+               $a = get_app();
+               $r = q("SELECT `v`,`k` FROM `pconfig` WHERE `cat` = '%s' AND `uid` = %d ORDER BY `cat`, `k`, `id`",
                        dbesc($family),
                        intval($uid)
                );
-               if(count($r)) {
-                       foreach($r as $rr) {
+               if (dbm::is_result($r)) {
+                       foreach ($r as $rr) {
                                $k = $rr['k'];
                                $a->config[$uid][$family][$k] = $rr['v'];
+                               self::$in_db[$uid][$family][$k] = true;
                        }
                } else if ($family != 'config') {
                        // Negative caching
@@ -65,40 +71,42 @@ class PConfig {
         */
        public static function get($uid, $family, $key, $default_value = null, $refresh = false) {
 
-               global $a;
+               $a = get_app();
 
-               if(! $instore) {
+               if (!$refresh) {
                        // Looking if the whole family isn't set
-                       if(isset($a->config[$uid][$family])) {
-                               if($a->config[$uid][$family] === '!<unset>!') {
+                       if (isset($a->config[$uid][$family])) {
+                               if ($a->config[$uid][$family] === '!<unset>!') {
                                        return $default_value;
                                }
                        }
 
-                       if(isset($a->config[$uid][$family][$key])) {
-                               if($a->config[$uid][$family][$key] === '!<unset>!') {
+                       if (isset($a->config[$uid][$family][$key])) {
+                               if ($a->config[$uid][$family][$key] === '!<unset>!') {
                                        return $default_value;
                                }
                                return $a->config[$uid][$family][$key];
                        }
                }
 
-               $ret = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' LIMIT 1",
+               $ret = q("SELECT `v` FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s' ORDER BY `id` DESC LIMIT 1",
                        intval($uid),
                        dbesc($family),
                        dbesc($key)
                );
 
-               if(count($ret)) {
+               if (count($ret)) {
                        $val = (preg_match("|^a:[0-9]+:{.*}$|s", $ret[0]['v'])?unserialize( $ret[0]['v']):$ret[0]['v']);
                        $a->config[$uid][$family][$key] = $val;
+                       self::$in_db[$uid][$family][$key] = true;
 
                        return $val;
-               }
-               else {
+               } else {
                        $a->config[$uid][$family][$key] = '!<unset>!';
+                       self::$in_db[$uid][$family][$key] = false;
+
+                       return $default_value;
                }
-               return $default_value;
        }
 
        /**
@@ -119,36 +127,47 @@ class PConfig {
         *  The value to store
         * @return mixed Stored $value or false
         */
-       public static function set($uid,$family,$key,$value) {
+       public static function set($uid, $family, $key, $value) {
+
+               $a = get_app();
 
-               global $a;
+               // We store our setting values in a string variable.
+               // So we have to do the conversion here so that the compare below works.
+               // The exception are array values.
+               $dbvalue = (!is_array($value) ? (string)$value : $value);
+
+               $stored = self::get($uid, $family, $key, null, true);
+
+               if (($stored === $dbvalue) AND self::$in_db[$uid][$family][$key]) {
+                       return true;
+               }
+
+               $a->config[$uid][$family][$key] = $dbvalue;
 
                // manage array value
-               $dbvalue = (is_array($value)?serialize($value):$value);
+               $dbvalue = (is_array($value) ? serialize($value) : $dbvalue);
 
-               if(is_null(self::get($uid,$family,$key,null, true))) {
-                       $a->config[$uid][$family][$key] = $value;
-                       $ret = q("INSERT INTO `pconfig` ( `uid`, `cat`, `k`, `v` ) VALUES ( %d, '%s', '%s', '%s' ) ",
+               if (is_null($stored) OR !self::$in_db[$uid][$family][$key]) {
+                       $ret = q("INSERT INTO `pconfig` (`uid`, `cat`, `k`, `v`) VALUES (%d, '%s', '%s', '%s') ON DUPLICATE KEY UPDATE `v` = '%s'",
                                intval($uid),
                                dbesc($family),
                                dbesc($key),
+                               dbesc($dbvalue),
                                dbesc($dbvalue)
                        );
-                       if($ret) 
-                               return $value;
-                       return $ret;
+               } else {
+                       $ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
+                               dbesc($dbvalue),
+                               intval($uid),
+                               dbesc($family),
+                               dbesc($key)
+                       );
                }
-               $ret = q("UPDATE `pconfig` SET `v` = '%s' WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
-                       dbesc($dbvalue),
-                       intval($uid),
-                       dbesc($family),
-                       dbesc($key)
-               );
-
-               $a->config[$uid][$family][$key] = $value;
 
-               if($ret)
+               if ($ret) {
+                       self::$in_db[$uid][$family][$key] = true;
                        return $value;
+               }
                return $ret;
        }
 
@@ -167,14 +186,19 @@ class PConfig {
         */
        public static function delete($uid,$family,$key) {
 
-               global $a;
-               if(x($a->config[$uid][$family],$key))
+               $a = get_app();
+
+               if (x($a->config[$uid][$family], $key)) {
                        unset($a->config[$uid][$family][$key]);
+                       unset(self::$in_db[$uid][$family][$key]);
+               }
+
                $ret = q("DELETE FROM `pconfig` WHERE `uid` = %d AND `cat` = '%s' AND `k` = '%s'",
                        intval($uid),
                        dbesc($family),
                        dbesc($key)
                );
+
                return $ret;
        }
 }