Bugfixing PConfig

[friendica.git] / src / Core / Config / IConfigAdapter.php

diff --git a/src/Core/Config/IConfigAdapter.php b/src/Core/Config/IConfigAdapter.php
index ee5ca3ca544f759ca606a8610711464bcfd23357..5bbb61ae80119ff5d9e02cbe3b2b5f78fe1dc90b 100644 (file)
--- a/src/Core/Config/IConfigAdapter.php
+++ b/src/Core/Config/IConfigAdapter.php
@@ -1,72 +1,72 @@
-<?php\r
-\r
-namespace Friendica\Core\Config;\r
-\r
-/**\r
- *\r
- * @author Hypolite Petovan <mrpetovan@gmail.com>\r
- */\r
-interface IConfigAdapter\r
-{\r
-       /**\r
-        * @brief Loads all configuration values into a cached storage.\r
-        *\r
-        * All configuration values of the system are stored in global cache\r
-        * which is available under the global variable $a->config\r
-        *\r
-        * @param string  $cat The category of the configuration values to load\r
-        *\r
-        * @return void\r
-        */\r
-       public function load($cat = "config");\r
-\r
-       /**\r
-        * @brief Get a particular user's config variable given the category name\r
-        * ($family) and a key.\r
-        *\r
-        * Get a particular config value from the given category ($family)\r
-        * and the $key from a cached storage in $a->config[$uid].\r
-        * $instore is only used by the set_config function\r
-        * to determine if the key already exists in the DB\r
-        * If a key is found in the DB but doesn't exist in\r
-        * local config cache, pull it into the cache so we don't have\r
-        * to hit the DB again for this item.\r
-        *\r
-        * @param string  $cat           The category of the configuration value\r
-        * @param string  $k             The configuration key to query\r
-        * @param mixed   $default_value optional, The value to return if key is not set (default: null)\r
-        * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)\r
-        *\r
-        * @return mixed Stored value or null if it does not exist\r
-        */\r
-       public function get($cat, $k, $default_value = null, $refresh = false);\r
-\r
-       /**\r
-        * @brief Sets a configuration value for system config\r
-        *\r
-        * Stores a config value ($value) in the category ($family) under the key ($key)\r
-        * for the user_id $uid.\r
-        *\r
-        * Note: Please do not store booleans - convert to 0/1 integer values!\r
-        *\r
-        * @param string $family The category of the configuration value\r
-        * @param string $key    The configuration key to set\r
-        * @param mixed  $value  The value to store\r
-        *\r
-        * @return mixed Stored $value or false if the database update failed\r
-        */\r
-       public function set($cat, $k, $value);\r
-\r
-       /**\r
-        * @brief Deletes the given key from the system configuration.\r
-        *\r
-        * Removes the configured value from the stored cache in $a->config\r
-        * and removes it from the database.\r
-        *\r
-        * @param string $cat The category of the configuration value\r
-        * @param string $k   The configuration key to delete\r
-        *\r
-        * @return mixed\r
-        */\r
-       public function delete($cat, $k);\r
-}\r
+<?php
+
+namespace Friendica\Core\Config;
+
+/**
+ *
+ * @author Hypolite Petovan <hypolite@mrpetovan.com>
+ */
+interface IConfigAdapter
+{
+       /**
+        * @brief Loads all configuration values into a cached storage.
+        *
+        * All configuration values of the system are stored in global cache
+        * which is available under the global variable Config::$config
+        *
+        * @param string  $cat The category of the configuration values to load
+        *
+        * @return void
+        */
+       public function load($cat = "config");
+
+       /**
+        * @brief Get a particular user's config variable given the category name
+        * ($family) and a key.
+        *
+        * Get a particular config value from the given category ($family)
+        * and the $key from a cached storage in static::$config[$uid].
+        * $instore is only used by the set_config function
+        * to determine if the key already exists in the DB
+        * If a key is found in the DB but doesn't exist in
+        * local config cache, pull it into the cache so we don't have
+        * to hit the DB again for this item.
+        *
+        * @param string  $cat           The category of the configuration value
+        * @param string  $k             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 function get($cat, $k, $default_value = null, $refresh = false);
+
+       /**
+        * @brief Sets a configuration value for system config
+        *
+        * Stores a config value ($value) in the category ($family) under the key ($key)
+        * for the user_id $uid.
+        *
+        * Note: Please do not store booleans - convert to 0/1 integer values!
+        *
+        * @param string $cat   The category of the configuration value
+        * @param string $k     The configuration key to set
+        * @param mixed  $value The value to store
+        *
+        * @return bool Operation success
+        */
+       public function set($cat, $k, $value);
+
+       /**
+        * @brief Deletes the given key from the system configuration.
+        *
+        * Removes the configured value from the stored cache in Config::$config
+        * and removes it from the database.
+        *
+        * @param string $cat The category of the configuration value
+        * @param string $k   The configuration key to delete
+        *
+        * @return mixed
+        */
+       public function delete($cat, $k);
+}