Merge pull request #13938 from owncloud/deprecate-iappconfig

Deprecated \OCP\IAppConfig - add missing methods to IConfig

2 files changed, 44 insertions, 0 deletions

diff --git a/lib/public/iappconfig.php b/lib/public/iappconfig.php
index 33fc3e4e362..8846445f94c 100644
--- a/lib/public/iappconfig.php
+++ b/lib/public/iappconfig.php
@@ -27,6 +27,10 @@ namespace OCP;
 /**
  * This class provides an easy way for apps to store config values in the
  * database.
+ *
+ * @deprecated This interface will be dropped with ownCloud 10.1 which will be
+ *             released in the first quarter of 2017. Use the methods of
+ *             \OCP\IConfig instead
  */
 interface IAppConfig {
 	/**
@@ -34,6 +38,7 @@ interface IAppConfig {
 	 * @param string $app
 	 * @param string $key
 	 * @return bool
+	 * @deprecated use method hasAppKey of \OCP\IConfig
 	 */
 	public function hasKey($app, $key);
 
@@ -76,6 +81,7 @@ interface IAppConfig {
 	 * @param string|false $key
 	 * @param string|false $app
 	 * @return array|false
+	 * @deprecated use method getAppValuesByApp or getAppValuesByKey of \OCP\IConfig
 	 */
 	public function getValues($app, $key);
 
@@ -94,6 +100,7 @@ interface IAppConfig {
 	/**
 	 * Get all apps using the config
 	 * @return array an array of app ids
+	 * @deprecated use method getApps of \OCP\IConfig
 	 *
 	 * This function returns a list of all apps that have at least one
 	 * entry in the appconfig table.
diff --git a/lib/public/iconfig.php b/lib/public/iconfig.php
index c63ba1a90a6..8321c4043cd 100644
--- a/lib/public/iconfig.php
+++ b/lib/public/iconfig.php
@@ -90,6 +90,16 @@ interface IConfig {
 	public function setAppValue($appName, $key, $value);
 
 	/**
+	 * Checks if a key is set in the apps config
+	 *
+	 * @param string $appName the appName tto look a key up
+	 * @param string $key the key to look up
+	 * @return bool
+	 * @since 8.1.0
+	 */
+	public function hasAppKey($appName, $key);
+
+	/**
 	 * Looks up an app wide defined value
 	 *
 	 * @param string $appName the appName that we stored the value under
@@ -100,6 +110,33 @@ interface IConfig {
 	public function getAppValue($appName, $key, $default = '');
 
 	/**
+	 * Get all app values that are stored
+	 *
+	 * @param string $appName the appName
+	 * @return array with key - value pair as they are saved previously
+	 * @since 8.1.0
+	 */
+	public function getAppValuesByApp($appName);
+
+	/**
+	 * Get all app values that use the same key
+	 *
+	 * @param string $key the appName
+	 * @return array with key - value pair as they are saved previously with the
+	 * 	             app name as key
+	 * @since 8.1.0
+	 */
+	public function getAppValuesByKey($key);
+
+	/**
+	 * Get all apps that have at least one value saved
+	 *
+	 * @return array containing app names
+	 * @since 8.1.0
+	 */
+	public function getApps();
+
+	/**
 	 * Delete an app wide defined value
 	 *
 	 * @param string $appName the appName that we stored the value under