Also add default to the \OCP\IConfig interface
This commit is contained in:
parent
59f02066b6
commit
e2efad6ae7
|
@ -15,6 +15,7 @@ namespace OC;
|
||||||
class AllConfig implements \OCP\IConfig {
|
class AllConfig implements \OCP\IConfig {
|
||||||
/**
|
/**
|
||||||
* Sets a new system wide value
|
* Sets a new system wide value
|
||||||
|
*
|
||||||
* @param string $key the key of the value, under which will be saved
|
* @param string $key the key of the value, under which will be saved
|
||||||
* @param string $value the value that should be stored
|
* @param string $value the value that should be stored
|
||||||
* @todo need a use case for this
|
* @todo need a use case for this
|
||||||
|
@ -37,6 +38,7 @@ class AllConfig implements \OCP\IConfig {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Writes a new app wide value
|
* Writes a new app wide value
|
||||||
|
*
|
||||||
* @param string $appName the appName 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 of the value, under which will be saved
|
* @param string $key the key of the value, under which will be saved
|
||||||
* @param string $value the value that should be stored
|
* @param string $value the value that should be stored
|
||||||
|
@ -60,6 +62,7 @@ class AllConfig implements \OCP\IConfig {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set a user defined value
|
* Set a user defined value
|
||||||
|
*
|
||||||
* @param string $userId the userId of the user that we want to store the value under
|
* @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 $appName the appName that we want to store the value under
|
||||||
* @param string $key the key under which the value is being stored
|
* @param string $key the key under which the value is being stored
|
||||||
|
@ -71,13 +74,14 @@ class AllConfig implements \OCP\IConfig {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Shortcut for getting a user defined value
|
* 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 $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 $appName the appName that we stored the value under
|
||||||
* @param string $key the key under which the value is being stored
|
* @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
|
* @param string $default the default value to be returned if the value isn't set
|
||||||
* @return string
|
* @return string
|
||||||
*/
|
*/
|
||||||
public function getUserValue($userId, $appName, $key, $default = null){
|
public function getUserValue($userId, $appName, $key, $default = '') {
|
||||||
return \OCP\Config::getUserValue($userId, $appName, $key, $default);
|
return \OCP\Config::getUserValue($userId, $appName, $key, $default);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -36,6 +36,7 @@ namespace OCP;
|
||||||
interface IConfig {
|
interface IConfig {
|
||||||
/**
|
/**
|
||||||
* Sets a new system wide value
|
* Sets a new system wide value
|
||||||
|
*
|
||||||
* @param string $key the key of the value, under which will be saved
|
* @param string $key the key of the value, under which will be saved
|
||||||
* @param string $value the value that should be stored
|
* @param string $value the value that should be stored
|
||||||
* @todo need a use case for this
|
* @todo need a use case for this
|
||||||
|
@ -44,14 +45,17 @@ interface IConfig {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Looks up a system wide defined value
|
* Looks up a system wide defined value
|
||||||
|
*
|
||||||
* @param string $key the key of the value, under which it was saved
|
* @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
|
* @return string the saved value
|
||||||
*/
|
*/
|
||||||
public function getSystemValue($key);
|
public function getSystemValue($key, $default = '');
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Writes a new app wide value
|
* Writes a new app wide value
|
||||||
|
*
|
||||||
* @param string $appName the appName 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 of the value, under which will be saved
|
* @param string $key the key of the value, under which will be saved
|
||||||
* @param string $value the value that should be stored
|
* @param string $value the value that should be stored
|
||||||
|
@ -60,15 +64,18 @@ interface IConfig {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Looks up an app wide defined value
|
* Looks up an app wide defined value
|
||||||
|
*
|
||||||
* @param string $appName the appName that we stored the value under
|
* @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 $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
|
* @return string the saved value
|
||||||
*/
|
*/
|
||||||
public function getAppValue($appName, $key);
|
public function getAppValue($appName, $key, $default = '');
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Set a user defined value
|
* Set a user defined value
|
||||||
|
*
|
||||||
* @param string $userId the userId of the user that we want to store the value under
|
* @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 $appName the appName that we want to store the value under
|
||||||
* @param string $key the key under which the value is being stored
|
* @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
|
* 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 $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 $appName the appName that we stored the value under
|
||||||
* @param string $key the key under which the value is being stored
|
* @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 = '');
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue