Browse Source

style fixes for public config api

tags/v4.5.0beta3
Georg Ehrke 12 years ago
parent
commit
221257d2fb
1 changed files with 45 additions and 58 deletions
  1. 45
    58
      lib/public/config.php

+ 45
- 58
lib/public/config.php View File

@@ -38,8 +38,6 @@ 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
@@ -53,7 +51,6 @@ class Config {
return(\OC_Config::getValue( $key, $default ));
}


/**
* @brief Sets a value
* @param $key key
@@ -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 $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 ) {
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 $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 ) {
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 $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 ) {
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 ) {
/**
* @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 ));
}






}

Loading…
Cancel
Save