summaryrefslogtreecommitdiffstats
path: root/lib/public/config.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/config.php')
-rw-r--r--lib/public/config.php117
1 files changed, 52 insertions, 65 deletions
diff --git a/lib/public/config.php b/lib/public/config.php
index fa9658e7288..1f163d52617 100644
--- a/lib/public/config.php
+++ b/lib/public/config.php
@@ -38,13 +38,11 @@ namespace OCP;
* This class provides functions to read and write configuration data. configuration can be on a system, application or user level
*/
class Config {
-
-
/**
* @brief Gets a value from config.php
- * @param $key key
- * @param $default = null default value
- * @returns the value or $default
+ * @param string $key key
+ * @param string $default = null default value
+ * @return string the value or $default
*
* This function gets the value from config.php. If it does not exist,
* $default will be returned.
@@ -53,12 +51,11 @@ class Config {
return(\OC_Config::getValue( $key, $default ));
}
-
/**
* @brief Sets a value
- * @param $key key
- * @param $value value
- * @returns true/false
+ * @param string $key key
+ * @param string $value value
+ * @return bool
*
* This function sets the value and writes the config.php. If the file can
* not be written, false will be returned.
@@ -67,70 +64,60 @@ class Config {
return(\OC_Config::setValue( $key, $value ));
}
-
- /**
- * @brief Gets the config value
- * @param $app app
- * @param $key key
- * @param $default = null, default value if the key does not exist
- * @returns the value or $default
- *
- * This function gets a value from the appconfig table. If the key does
- * not exist the default value will be returnes
- */
- public static function getAppValue( $app, $key, $default = null ) {
+ /**
+ * @brief Gets the config value
+ * @param string $app app
+ * @param string $key key
+ * @param string $default = null, default value if the key does not exist
+ * @return string the value or $default
+ *
+ * This function gets a value from the appconfig table. If the key does
+ * not exist the default value will be returned
+ */
+ public static function getAppValue( $app, $key, $default = null ) {
return(\OC_Appconfig::getValue( $app, $key, $default ));
}
-
- /**
- * @brief sets a value in the appconfig
- * @param $app app
- * @param $key key
- * @param $value value
- * @returns true/false
- *
- * Sets a value. If the key did not exist before it will be created.
- */
- public static function setAppValue( $app, $key, $value ) {
+ /**
+ * @brief sets a value in the appconfig
+ * @param string $app app
+ * @param string $key key
+ * @param string $value value
+ * @return string true/false
+ *
+ * Sets a value. If the key did not exist before it will be created.
+ */
+ public static function setAppValue( $app, $key, $value ) {
return(\OC_Appconfig::setValue( $app, $key, $value ));
}
-
- /**
- * @brief Gets the preference
- * @param $user user
- * @param $app app
- * @param $key key
- * @param $default = null, default value if the key does not exist
- * @returns the value or $default
- *
- * This function gets a value from the prefernces table. If the key does
- * not exist the default value will be returnes
- */
- public static function getUserValue( $user, $app, $key, $default = null ) {
+ /**
+ * @brief Gets the preference
+ * @param string $user user
+ * @param string $app app
+ * @param string $key key
+ * @param string $default = null, default value if the key does not exist
+ * @return string the value or $default
+ *
+ * This function gets a value from the preferences table. If the key does
+ * not exist the default value will be returned
+ */
+ public static function getUserValue( $user, $app, $key, $default = null ) {
return(\OC_Preferences::getValue( $user, $app, $key, $default ));
}
-
- /**
- * @brief sets a value in the preferences
- * @param $user user
- * @param $app app
- * @param $key key
- * @param $value value
- * @returns true/false
- *
- * Adds a value to the preferences. If the key did not exist before, it
- * will be added automagically.
- */
- public static function setUserValue( $user, $app, $key, $value ) {
- return(\OC_Preferences::setValue( $user, $app, $key, $value ));
+ /**
+ * @brief sets a value in the preferences
+ * @param string $user user
+ * @param string $app app
+ * @param string $key key
+ * @param string $value value
+ * @returns bool
+ *
+ * Adds a value to the preferences. If the key did not exist before, it
+ * will be added automagically.
+ */
+ public static function setUserValue( $user, $app, $key, $value ) {
+ return(\OC_Preferences::setValue( $user, $app, $key, $value ));
}
-
-
-
-
-
-
}