JuKu / JuKuCMS

system/packages/com.jukusoft.cms.settings/classes/settings.php

Indentation +247 added lines, -247 removed lines

@@ -25,277 +25,277 @@
  */
 class Settings {
 
-	//in-memory cache of settings
-	protected static $settings = array();
-
-	//flag, if global settings was initialized
-	protected static $initialized = false;
-
-	protected static $async_save_list = array();
-
-	/**
-	 * get value of setting
-	 *
-	 * @package com.jukusoft.cms.settings
-	 *
-	 * @param key setting
-	 *
-	 * @throws IllegalStateException of key doesnt exists and no default value is set
-	 *
-	 * @return mixed or null, if key doesnt exists in database / default value, if set
-	 */
-	public static function get (string $key, $default_value = null) {
-		//load settings if neccessary
-		self::loadSettingsIfAbsent();
-
-		if (!isset(self::$settings[$key])) {
-			if ($default_value !== null) {
-				return $default_value;
-			} else {
-				throw new IllegalStateException("Settings key '" . $key . "' doesnt exists.");
-			}
-		} else {
-			return unserialize(self::$settings[$key]);
-		}
-	}
-
-	/**
-	 * set setting
-	 *
-	 * @param $key setting
-	 * @param $value mixed value to set
-	 */
-	public static function set (string $key, $value) {
-		//serialize data
-		$value = serialize($value);
-
-		//update database
-		Database::getInstance()->execute("UPDATE `{praefix}global_settings` SET `value` = :value WHERE `key` = :key;", array(
-			'value' => $value,
-			'key' => $key
-		));
-
-		//update local in-memory cache
-		self::$settings[$key] = $value;
-
-		//clear cache (area "global_settings")
-		Cache::clear("global_settings");
-	}
-
-	public static function setAsync (string $key, $value) {
-		self::$async_save_list[$key] = serialize($value);
-
-		//update local in-memory cache
-		self::$settings[$key] = $value;
-	}
-
-	public static function saveAsync () {
-		if (!empty(self::$async_save_list)) {
-			foreach (self::$async_save_list as $key=>$value) {
-				Settings::set($key, $value);
-			}
-		}
-	}
-
-	/**
-	 * check if settings key exists
-	 *
-	 * @param $key string settings key
-	 *
-	 * @return true if setting key exists
-	 */
-	public static function contains (string $key) : bool {
-		//load settings if neccessary
-		self::loadSettingsIfAbsent();
-
-		//escape key
-		//$key = Database::getInstance()->escape($key);
-
-		return isset(self::$settings[$key]);
-	}
-
-	/**
-	 * set setting if key is absent
-	 *
-	 * @param $key setting
-	 * @param $value mixed value to set
-	 */
-	public static function setIfAbsent (string $key, $value) {
-		self::loadSettingsIfAbsent();
-
-		if (!isset(self::$settings[$key])) {
-			self::set($key, $value);
-		}
-	}
-
-	/**
-	 * create setting (so it can be shown on settings page)
-	 */
-	public static function create (string $key, $value, string $title, string $description, string $owner, string $category = "general", string $datatype = "DataType_String", $datatype_params = "", bool $editable = true, $visible_permissions = "can_see_global_settings", $change_permissions = "can_change_global_settings", int $order = 10, string $icon_path = "none", string $last_update = "0000-00-00 00:00:00") {
-		self::loadSettingsIfAbsent();
-
-		if (strlen($key) > 255) {
-			throw new IllegalArgumentException("max key length is 255, your key: " . $key);
-		}
-
-		//check, if setting already exists
-		/*if (isset(self::$settings[$key])) {
+    //in-memory cache of settings
+    protected static $settings = array();
+
+    //flag, if global settings was initialized
+    protected static $initialized = false;
+
+    protected static $async_save_list = array();
+
+    /**
+     * get value of setting
+     *
+     * @package com.jukusoft.cms.settings
+     *
+     * @param key setting
+     *
+     * @throws IllegalStateException of key doesnt exists and no default value is set
+     *
+     * @return mixed or null, if key doesnt exists in database / default value, if set
+     */
+    public static function get (string $key, $default_value = null) {
+        //load settings if neccessary
+        self::loadSettingsIfAbsent();
+
+        if (!isset(self::$settings[$key])) {
+            if ($default_value !== null) {
+                return $default_value;
+            } else {
+                throw new IllegalStateException("Settings key '" . $key . "' doesnt exists.");
+            }
+        } else {
+            return unserialize(self::$settings[$key]);
+        }
+    }
+
+    /**
+     * set setting
+     *
+     * @param $key setting
+     * @param $value mixed value to set
+     */
+    public static function set (string $key, $value) {
+        //serialize data
+        $value = serialize($value);
+
+        //update database
+        Database::getInstance()->execute("UPDATE `{praefix}global_settings` SET `value` = :value WHERE `key` = :key;", array(
+            'value' => $value,
+            'key' => $key
+        ));
+
+        //update local in-memory cache
+        self::$settings[$key] = $value;
+
+        //clear cache (area "global_settings")
+        Cache::clear("global_settings");
+    }
+
+    public static function setAsync (string $key, $value) {
+        self::$async_save_list[$key] = serialize($value);
+
+        //update local in-memory cache
+        self::$settings[$key] = $value;
+    }
+
+    public static function saveAsync () {
+        if (!empty(self::$async_save_list)) {
+            foreach (self::$async_save_list as $key=>$value) {
+                Settings::set($key, $value);
+            }
+        }
+    }
+
+    /**
+     * check if settings key exists
+     *
+     * @param $key string settings key
+     *
+     * @return true if setting key exists
+     */
+    public static function contains (string $key) : bool {
+        //load settings if neccessary
+        self::loadSettingsIfAbsent();
+
+        //escape key
+        //$key = Database::getInstance()->escape($key);
+
+        return isset(self::$settings[$key]);
+    }
+
+    /**
+     * set setting if key is absent
+     *
+     * @param $key setting
+     * @param $value mixed value to set
+     */
+    public static function setIfAbsent (string $key, $value) {
+        self::loadSettingsIfAbsent();
+
+        if (!isset(self::$settings[$key])) {
+            self::set($key, $value);
+        }
+    }
+
+    /**
+     * create setting (so it can be shown on settings page)
+     */
+    public static function create (string $key, $value, string $title, string $description, string $owner, string $category = "general", string $datatype = "DataType_String", $datatype_params = "", bool $editable = true, $visible_permissions = "can_see_global_settings", $change_permissions = "can_change_global_settings", int $order = 10, string $icon_path = "none", string $last_update = "0000-00-00 00:00:00") {
+        self::loadSettingsIfAbsent();
+
+        if (strlen($key) > 255) {
+            throw new IllegalArgumentException("max key length is 255, your key: " . $key);
+        }
+
+        //check, if setting already exists
+        /*if (isset(self::$settings[$key])) {
 			throw new IllegalArgumentException("global setting key '" . $key . "' already exists in database.");
 		}*/
 
-		//allow more than one possible permission as array
-		if (is_array($visible_permissions)) {
-			$visible_permissions = implode("|", $visible_permissions);
-		}
+        //allow more than one possible permission as array
+        if (is_array($visible_permissions)) {
+            $visible_permissions = implode("|", $visible_permissions);
+        }
 
-		//allow more than one possible permission as array
-		if (is_array($change_permissions)) {
-			$change_permissions = implode("|", $change_permissions);
-		}
+        //allow more than one possible permission as array
+        if (is_array($change_permissions)) {
+            $change_permissions = implode("|", $change_permissions);
+        }
 
-		//serialize value
-		$value = serialize($value);
-		$datatype_params = serialize($datatype_params);
+        //serialize value
+        $value = serialize($value);
+        $datatype_params = serialize($datatype_params);
 
-		//insert setting into database
-		Database::getInstance()->execute("INSERT INTO `{praefix}global_settings` (
+        //insert setting into database
+        Database::getInstance()->execute("INSERT INTO `{praefix}global_settings` (
 			`key`, `value`, `title`, `description`, `visible_permission`, `change_permission`, `owner`, `order`, `icon_path`, `last_update`, `datatype`, `datatype_params`, `editable`, `category`, `activated`
 		) VALUES (
 			:key, :value, :title, :description, :visible_permissions, :change_permissions, :owner, :order, :icon_path, '0000-00-00 00:00:00', :datatype, :datatype_params, :editable, :category, :activated
 		) ON DUPLICATE KEY UPDATE `title` = :title, `description` = :description, `visible_permission` = :visible_permissions, `change_permission` = :change_permissions, `owner` = :owner, `order` = :order, `icon_path` = :icon_path, `last_update` = CURRENT_TIMESTAMP, `datatype` = :datatype, `datatype_params` = :datatype_params, `editable` = :editable, `category` = :category; ", array(
-			'key' => $key,
-			'value' => $value,
-			'title' => $title,
-			'description' => $description,
-			'visible_permissions' => $visible_permissions,
-			'change_permissions' => $change_permissions,
-			'owner' => $owner,
-			'order' => (int) $order,
-			'icon_path' => $icon_path,
-			'datatype' => $datatype,
-			'datatype_params' => $datatype_params,
-			'editable' => ($editable ? 1 : 0),
-			'category' => $category,
-			'activated' => 1
-		));
-
-		//update value in local in-memory cache
-		self::$settings[$key] = $value;
-
-		//clear cache (area "global_settings")
-		Cache::clear("global_settings");
-	}
-
-	/**
-	 * delete setting
-	 */
-	public static function delete (string $key) {
-		//remove from in-memory cache
-		unset(self::$settings[$key]);
-
-		//remove key in database
-		Database::getInstance()->execute("DELETE FROM `{praefix}global_settings` WHERE `key` = :key; ", array('key' => $key));
-
-		//clear cache (area "global_settings")
-		Cache::clear("global_settings");
-	}
-
-	/**
-	 * initialize settings and get global settings
-	 */
-	protected static function loadCategorySettings (string $category) {
-		//$category = Database::getInstance()->escape($category);
-
-		$category_settings = array();
-
-		if (Cache::contains("global_settings", "settings-category-" + $category)) {
-			$category_settings = Cache::get("global_settings", "settings-category-" + $category);
-		} else {
-			//load settings from database
-			$rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}global_settings` WHERE `category` = :category AND `activated` = '1' ORDER BY `order`; ", array(
-				'category' => array(
-					'type' => PDO::PARAM_STR,
-					'value' => $category
-				)
-			));
-
-			foreach ($rows as $row) {
-				$category_settings[$row['key']] = $row['value'];
-			}
-
-			//cache rows
-			Cache::put("global_settings", "settings-category-" + $category, $category_settings);
-		}
-
-		//merge arrays
-		self::$settings = array_merge(self::$settings, $category_settings);
-
-		self::$initialized = true;
-	}
-
-	/**
-	 * initialize settings and get global settings
-	 */
-	protected static function loadAllSettings () {
-		if (Cache::contains("global_settings", "all-settings")) {
-			self::$settings = Cache::get("global_settings", "all-settings");
-		} else {
-			//load settings from database
-			$rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}global_settings` WHERE `activated` = '1' ORDER BY `order`; ");
+            'key' => $key,
+            'value' => $value,
+            'title' => $title,
+            'description' => $description,
+            'visible_permissions' => $visible_permissions,
+            'change_permissions' => $change_permissions,
+            'owner' => $owner,
+            'order' => (int) $order,
+            'icon_path' => $icon_path,
+            'datatype' => $datatype,
+            'datatype_params' => $datatype_params,
+            'editable' => ($editable ? 1 : 0),
+            'category' => $category,
+            'activated' => 1
+        ));
+
+        //update value in local in-memory cache
+        self::$settings[$key] = $value;
+
+        //clear cache (area "global_settings")
+        Cache::clear("global_settings");
+    }
+
+    /**
+     * delete setting
+     */
+    public static function delete (string $key) {
+        //remove from in-memory cache
+        unset(self::$settings[$key]);
+
+        //remove key in database
+        Database::getInstance()->execute("DELETE FROM `{praefix}global_settings` WHERE `key` = :key; ", array('key' => $key));
+
+        //clear cache (area "global_settings")
+        Cache::clear("global_settings");
+    }
+
+    /**
+     * initialize settings and get global settings
+     */
+    protected static function loadCategorySettings (string $category) {
+        //$category = Database::getInstance()->escape($category);
+
+        $category_settings = array();
+
+        if (Cache::contains("global_settings", "settings-category-" + $category)) {
+            $category_settings = Cache::get("global_settings", "settings-category-" + $category);
+        } else {
+            //load settings from database
+            $rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}global_settings` WHERE `category` = :category AND `activated` = '1' ORDER BY `order`; ", array(
+                'category' => array(
+                    'type' => PDO::PARAM_STR,
+                    'value' => $category
+                )
+            ));
+
+            foreach ($rows as $row) {
+                $category_settings[$row['key']] = $row['value'];
+            }
+
+            //cache rows
+            Cache::put("global_settings", "settings-category-" + $category, $category_settings);
+        }
+
+        //merge arrays
+        self::$settings = array_merge(self::$settings, $category_settings);
+
+        self::$initialized = true;
+    }
+
+    /**
+     * initialize settings and get global settings
+     */
+    protected static function loadAllSettings () {
+        if (Cache::contains("global_settings", "all-settings")) {
+            self::$settings = Cache::get("global_settings", "all-settings");
+        } else {
+            //load settings from database
+            $rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}global_settings` WHERE `activated` = '1' ORDER BY `order`; ");
 			
-			self::$settings = array();
+            self::$settings = array();
 
-			foreach ($rows as $row) {
-				self::$settings[$row['key']] = $row['value'];
-			}
+            foreach ($rows as $row) {
+                self::$settings[$row['key']] = $row['value'];
+            }
 
-			//cache rows
-			Cache::put("global_settings", "all-settings", self::$settings);
-		}
+            //cache rows
+            Cache::put("global_settings", "all-settings", self::$settings);
+        }
 
-		self::$initialized = true;
-	}
+        self::$initialized = true;
+    }
 
-	public static function listAllSettingsByCategory () {
-		//load settings if neccessary
-		self::loadSettingsIfAbsent();
+    public static function listAllSettingsByCategory () {
+        //load settings if neccessary
+        self::loadSettingsIfAbsent();
 
-		$rows = array();
+        $rows = array();
 
-		if (Cache::contains("global_settings", "all_rows")) {
-			$rows = Cache::get("global_settings", "all_rows");
-		} else {
-			//load settings from database
-			$rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}global_settings` WHERE `activated` = '1' ORDER BY `order`; ");
+        if (Cache::contains("global_settings", "all_rows")) {
+            $rows = Cache::get("global_settings", "all_rows");
+        } else {
+            //load settings from database
+            $rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}global_settings` WHERE `activated` = '1' ORDER BY `order`; ");
 
-			Cache::put("global_settings", "all_rows", $rows);
-		}
+            Cache::put("global_settings", "all_rows", $rows);
+        }
 
-		$list = array();
+        $list = array();
 
-		foreach ($rows as $row) {
-			$category = $row['category'];
-			$key = $row['key'];
+        foreach ($rows as $row) {
+            $category = $row['category'];
+            $key = $row['key'];
 
-			//add array, if key doesnt exists in array
-			if (!isset($list[$category])) {
-				$list[$category] = array();
-			}
+            //add array, if key doesnt exists in array
+            if (!isset($list[$category])) {
+                $list[$category] = array();
+            }
 
-			$list[$category][$key] = $row;
-		}
+            $list[$category][$key] = $row;
+        }
 
-		return $list;
-	}
+        return $list;
+    }
 
-	/**
-	 * load settings, if class was not initialized yet
-	 */
-	protected static function loadSettingsIfAbsent () {
-		if (!self::$initialized) {
-			self::loadAllSettings();
-		}
-	}
+    /**
+     * load settings, if class was not initialized yet
+     */
+    protected static function loadSettingsIfAbsent () {
+        if (!self::$initialized) {
+            self::loadAllSettings();
+        }
+    }
 
 }
 

Spacing +15 added lines, -15 removed lines

@@ -44,7 +44,7 @@ 
 	 *
 	 * @return mixed or null, if key doesnt exists in database / default value, if set
 	 */
-	public static function get (string $key, $default_value = null) {
+	public static function get(string $key, $default_value = null) {
 		//load settings if neccessary
 		self::loadSettingsIfAbsent();
 
@@ -65,7 +65,7 @@ 
 	 * @param $key setting
 	 * @param $value mixed value to set
 	 */
-	public static function set (string $key, $value) {
+	public static function set(string $key, $value) {
 		//serialize data
 		$value = serialize($value);
 
@@ -82,14 +82,14 @@ 
 		Cache::clear("global_settings");
 	}
 
-	public static function setAsync (string $key, $value) {
+	public static function setAsync(string $key, $value) {
 		self::$async_save_list[$key] = serialize($value);
 
 		//update local in-memory cache
 		self::$settings[$key] = $value;
 	}
 
-	public static function saveAsync () {
+	public static function saveAsync() {
 		if (!empty(self::$async_save_list)) {
 			foreach (self::$async_save_list as $key=>$value) {
 				Settings::set($key, $value);
@@ -104,7 +104,7 @@ 
 	 *
 	 * @return true if setting key exists
 	 */
-	public static function contains (string $key) : bool {
+	public static function contains(string $key) : bool {
 		//load settings if neccessary
 		self::loadSettingsIfAbsent();
 
@@ -120,7 +120,7 @@ 
 	 * @param $key setting
 	 * @param $value mixed value to set
 	 */
-	public static function setIfAbsent (string $key, $value) {
+	public static function setIfAbsent(string $key, $value) {
 		self::loadSettingsIfAbsent();
 
 		if (!isset(self::$settings[$key])) {
@@ -131,7 +131,7 @@ 
 	/**
 	 * create setting (so it can be shown on settings page)
 	 */
-	public static function create (string $key, $value, string $title, string $description, string $owner, string $category = "general", string $datatype = "DataType_String", $datatype_params = "", bool $editable = true, $visible_permissions = "can_see_global_settings", $change_permissions = "can_change_global_settings", int $order = 10, string $icon_path = "none", string $last_update = "0000-00-00 00:00:00") {
+	public static function create(string $key, $value, string $title, string $description, string $owner, string $category = "general", string $datatype = "DataType_String", $datatype_params = "", bool $editable = true, $visible_permissions = "can_see_global_settings", $change_permissions = "can_change_global_settings", int $order = 10, string $icon_path = "none", string $last_update = "0000-00-00 00:00:00") {
 		self::loadSettingsIfAbsent();
 
 		if (strlen($key) > 255) {
@@ -189,7 +189,7 @@ 
 	/**
 	 * delete setting
 	 */
-	public static function delete (string $key) {
+	public static function delete(string $key) {
 		//remove from in-memory cache
 		unset(self::$settings[$key]);
 
@@ -203,13 +203,13 @@ 
 	/**
 	 * initialize settings and get global settings
 	 */
-	protected static function loadCategorySettings (string $category) {
+	protected static function loadCategorySettings(string $category) {
 		//$category = Database::getInstance()->escape($category);
 
 		$category_settings = array();
 
-		if (Cache::contains("global_settings", "settings-category-" + $category)) {
-			$category_settings = Cache::get("global_settings", "settings-category-" + $category);
+		if (Cache::contains("global_settings", "settings-category-" +$category)) {
+			$category_settings = Cache::get("global_settings", "settings-category-" +$category);
 		} else {
 			//load settings from database
 			$rows = Database::getInstance()->listRows("SELECT * FROM `{praefix}global_settings` WHERE `category` = :category AND `activated` = '1' ORDER BY `order`; ", array(
@@ -224,7 +224,7 @@ 
 			}
 
 			//cache rows
-			Cache::put("global_settings", "settings-category-" + $category, $category_settings);
+			Cache::put("global_settings", "settings-category-" +$category, $category_settings);
 		}
 
 		//merge arrays
@@ -236,7 +236,7 @@ 
 	/**
 	 * initialize settings and get global settings
 	 */
-	protected static function loadAllSettings () {
+	protected static function loadAllSettings() {
 		if (Cache::contains("global_settings", "all-settings")) {
 			self::$settings = Cache::get("global_settings", "all-settings");
 		} else {
@@ -256,7 +256,7 @@ 
 		self::$initialized = true;
 	}
 
-	public static function listAllSettingsByCategory () {
+	public static function listAllSettingsByCategory() {
 		//load settings if neccessary
 		self::loadSettingsIfAbsent();
 
@@ -291,7 +291,7 @@ 
 	/**
 	 * load settings, if class was not initialized yet
 	 */
-	protected static function loadSettingsIfAbsent () {
+	protected static function loadSettingsIfAbsent() {
 		if (!self::$initialized) {
 			self::loadAllSettings();
 		}