summaryrefslogtreecommitdiffstats
path: root/lib/public/iconfig.php
diff options
context:
space:
mode:
authorRobin Appelman <icewind@owncloud.com>2013-12-16 14:33:03 +0100
committerRobin Appelman <icewind@owncloud.com>2013-12-16 14:33:03 +0100
commite2efad6ae7c77f9bd50e50e1ba5db27d1d52434f (patch)
tree302103b288a35b61cfe6e0c03e7582516ae393a9 /lib/public/iconfig.php
parent59f02066b6466e982a68b6e1f35578cc79d21285 (diff)
downloadnextcloud-server-e2efad6ae7c77f9bd50e50e1ba5db27d1d52434f.tar.gz
nextcloud-server-e2efad6ae7c77f9bd50e50e1ba5db27d1d52434f.zip
Also add default to the \OCP\IConfig interface
Diffstat (limited to 'lib/public/iconfig.php')
-rw-r--r--lib/public/iconfig.php15
1 files changed, 12 insertions, 3 deletions
diff --git a/lib/public/iconfig.php b/lib/public/iconfig.php
index da6b6c54843..1d0f8e0015c 100644
--- a/lib/public/iconfig.php
+++ b/lib/public/iconfig.php
@@ -36,6 +36,7 @@ namespace OCP;
interface IConfig {
/**
* Sets a new system wide value
+ *
* @param string $key the key of the value, under which will be saved
* @param string $value the value that should be stored
* @todo need a use case for this
@@ -44,14 +45,17 @@ interface IConfig {
/**
* Looks up a system wide defined value
+ *
* @param string $key the key of the value, under which it was saved
+ * @param string $default the default value to be returned if the value isn't set
* @return string the saved value
*/
- public function getSystemValue($key);
+ public function getSystemValue($key, $default = '');
/**
* Writes a new app wide value
+ *
* @param string $appName the appName that we want to store the value under
* @param string $key the key of the value, under which will be saved
* @param string $value the value that should be stored
@@ -60,15 +64,18 @@ interface IConfig {
/**
* Looks up an app wide defined value
+ *
* @param string $appName the appName that we stored the value under
* @param string $key the key of the value, under which it was saved
+ * @param string $default the default value to be returned if the value isn't set
* @return string the saved value
*/
- public function getAppValue($appName, $key);
+ public function getAppValue($appName, $key, $default = '');
/**
* Set a user defined value
+ *
* @param string $userId the userId of the user that we want to store the value under
* @param string $appName the appName that we want to store the value under
* @param string $key the key under which the value is being stored
@@ -78,9 +85,11 @@ interface IConfig {
/**
* Shortcut for getting a user defined value
+ *
* @param string $userId the userId of the user that we want to store the value under
* @param string $appName the appName that we stored the value under
* @param string $key the key under which the value is being stored
+ * @param string $default the default value to be returned if the value isn't set
*/
- public function getUserValue($userId, $appName, $key);
+ public function getUserValue($userId, $appName, $key, $default = '');
}