Refactoring Core class structures ...

src/Core/Config/Capability/IManageConfigValues.php

@@ -0,0 +1,102 @@
+<?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @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\Core\Config\Capability;
+
+use Friendica\Core\Config\Exception\ConfigPersistenceException;
+use Friendica\Core\Config\ValueObject\Cache;
+
+/**
+ * Interface for accessing system-wide configurations
+ */
+interface IManageConfigValues
+{
+	/**
+	 * Loads all configuration values of family into a cached storage.
+	 *
+	 * All configuration values of the system are stored in the cache.
+	 *
+	 * @param string $cat The category of the configuration value
+	 *
+	 * @return void
+	 *
+	 * @throws ConfigPersistenceException In case the persistence layer throws errors
+	 */
+	public function load(string $cat = 'config');
+
+	/**
+	 * Get a particular user's config variable given the category name
+	 * ($cat) and a $key.
+	 *
+	 * Get a particular config value from the given category ($cat)
+	 * and the $key from a cached storage either from the database or from the cache.
+	 *
+	 * @param string  $cat        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
+	 *
+	 * @throws ConfigPersistenceException In case the persistence layer throws errors
+	 *
+	 */
+	public function get(string $cat, string $key, $default_value = null, bool $refresh = false);
+
+	/**
+	 * Sets a configuration value for system config
+	 *
+	 * Stores a config value ($value) in the category ($cat) under the key ($key)
+	 *
+	 * Note: Please do not store booleans - convert to 0/1 integer values!
+	 *
+	 * @param string $cat The category of the configuration value
+	 * @param string $key    The configuration key to set
+	 * @param mixed  $value  The value to store
+	 *
+	 * @return bool Operation success
+	 *
+	 * @throws ConfigPersistenceException In case the persistence layer throws errors
+	 */
+	public function set(string $cat, string $key, $value): bool;
+
+	/**
+	 * Deletes the given key from the system configuration.
+	 *
+	 * Removes the configured value from the stored cache in the cache and removes it from the database.
+	 *
+	 * @param string $cat The category of the configuration value
+	 * @param string $key    The configuration key to delete
+	 *
+	 * @return bool
+	 *
+	 * @throws ConfigPersistenceException In case the persistence layer throws errors
+	 *
+	 */
+	public function delete(string $cat, string $key): bool;
+
+	/**
+	 * Returns the Config Cache
+	 *
+	 * @return Cache
+	 */
+	public function getCache(): Cache;
+}