aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-02-06 10:02:21 +0100
committerMorris Jobke <hey@morrisjobke.de>2015-03-17 17:19:33 +0100
commit012016d3311a13c3c1e9d60778dc6fbd6be0204e (patch)
tree41161599ac2a823010b4b60faed612a981735198 /lib/public
parentebb834d879f10ea24b8cf032f6f0000076843195 (diff)
downloadnextcloud-server-012016d3311a13c3c1e9d60778dc6fbd6be0204e.tar.gz
nextcloud-server-012016d3311a13c3c1e9d60778dc6fbd6be0204e.zip
Deprecated \OCP\IAppConfig - add missing methods to IConfig
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/iappconfig.php7
-rw-r--r--lib/public/iconfig.php37
2 files changed, 44 insertions, 0 deletions
diff --git a/lib/public/iappconfig.php b/lib/public/iappconfig.php
index 3a976b4a263..27b9cb42486 100644
--- a/lib/public/iappconfig.php
+++ b/lib/public/iappconfig.php
@@ -10,6 +10,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 {
/**
@@ -17,6 +21,7 @@ interface IAppConfig {
* @param string $app
* @param string $key
* @return bool
+ * @deprecated use method hasAppKey of \OCP\IConfig
*/
public function hasKey($app, $key);
@@ -59,6 +64,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);
@@ -77,6 +83,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 868a4133d2e..ec2b0b4cbb9 100644
--- a/lib/public/iconfig.php
+++ b/lib/public/iconfig.php
@@ -85,6 +85,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
@@ -95,6 +105,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