Cast field data when ATTR_EMULATE_PREPARES is enabled

[friendica.git] / src / Model / Config / Config.php

diff --git a/src/Model/Config/Config.php b/src/Model/Config/Config.php
index e7dd0a5693bb30419c0d336c5551f92fd0bb2449..e059a42e98595ebd87439fa93888ccf8d2dd2e02 100644 (file)
--- a/src/Model/Config/Config.php
+++ b/src/Model/Config/Config.php
@@ -1,16 +1,40 @@
 <?php
+/**
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Model\Config;
 
 
+/**
+ * The Config model backend, which is using the general DB-model backend for configs
+ */
 class Config extends DbaConfig
 {
        /**
         * Loads all configuration values and returns the loaded category as an array.
         *
-        * @param string $cat The category of the configuration values to load
+        * @param string|null $cat The category of the configuration values to load
         *
-        * @return array
+        * @return array The config array
+        *
+        * @throws \Exception In case DB calls are invalid
         */
        public function load(string $cat = null)
        {
@@ -38,15 +62,17 @@ class Config extends DbaConfig
        }
 
        /**
-        * Get a particular system-wide config variable given the category name
-        * ($cat) and a key ($key).
+        * Get a particular, system-wide config variable out of the DB with the
+        * given category name ($cat) and a key ($key).
         *
         * Note: Boolean variables are defined as 0/1 in the database
         *
         * @param string $cat The category of the configuration value
         * @param string $key The configuration key to query
         *
-        * @return null|mixed Stored value or null if it does not exist
+        * @return array|string|null Stored value or null if it does not exist
+        *
+        * @throws \Exception In case DB calls are invalid
         */
        public function get(string $cat, string $key)
        {
@@ -77,6 +103,8 @@ class Config extends DbaConfig
         * @param mixed  $value The value to store
         *
         * @return bool Operation success
+        *
+        * @throws \Exception In case DB calls are invalid
         */
        public function set(string $cat, string $key, $value)
        {
@@ -102,13 +130,14 @@ class Config extends DbaConfig
        }
 
        /**
-        * Removes the configured value from the stored cache
-        * and removes it from the database.
+        * Removes the configured value from the database.
         *
         * @param string $cat The category of the configuration value
         * @param string $key The configuration key to delete
         *
         * @return bool Operation success
+        *
+        * @throws \Exception In case DB calls are invalid
         */
        public function delete(string $cat, string $key)
        {