nextcloud/lib/public/config.php

150 lines
4.0 KiB
PHP
Raw Normal View History

2012-05-02 15:28:56 +04:00
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @copyright 2012 Frank Karlitschek frank@owncloud.org
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
2012-05-02 15:28:56 +04:00
/**
* Public interface of ownCloud for apps to use.
* Config Class
*
*/
2012-05-10 17:19:17 +04:00
/**
2013-10-31 22:00:53 +04:00
* Use OCP namespace for all classes that are considered public.
2012-05-10 17:19:17 +04:00
*
* Classes that use this namespace are for use by apps, and not for use by internal
* OC classes
*/
2012-05-02 15:28:56 +04:00
namespace OCP;
2012-05-19 12:36:57 +04:00
/**
2013-02-11 20:44:02 +04:00
* This class provides functions to read and write configuration data.
* configuration can be on a system, application or user level
2012-05-19 12:36:57 +04:00
*/
2012-05-02 15:28:56 +04:00
class Config {
/**
* Gets a value from config.php
2012-09-23 04:39:11 +04:00
* @param string $key key
* @param mixed $default = null default value
* @return mixed the value or $default
2012-05-02 15:28:56 +04:00
*
* This function gets the value from config.php. If it does not exist,
* $default will be returned.
*/
2012-09-07 17:22:01 +04:00
public static function getSystemValue( $key, $default = null ) {
2013-03-19 11:47:29 +04:00
return \OC_Config::getValue( $key, $default );
2012-05-02 15:28:56 +04:00
}
/**
* Sets a value
2012-09-23 04:39:11 +04:00
* @param string $key key
* @param mixed $value value
2012-09-23 04:39:11 +04:00
* @return bool
2012-05-02 15:28:56 +04:00
*
* This function sets the value and writes the config.php. If the file can
* not be written, false will be returned.
*/
2012-09-07 17:22:01 +04:00
public static function setSystemValue( $key, $value ) {
2013-03-19 11:47:29 +04:00
try {
\OC_Config::setValue( $key, $value );
2014-04-07 22:57:08 +04:00
} catch (\Exception $e) {
2013-03-19 11:47:29 +04:00
return false;
}
return true;
2012-05-02 15:28:56 +04:00
}
2014-06-02 20:31:43 +04:00
/**
* Deletes a value from config.php
* @param string $key key
*
* This function deletes the value from config.php.
*/
public static function deleteSystemValue( $key ) {
return \OC_Config::deleteKey( $key );
}
2012-09-08 17:58:28 +04:00
/**
* Gets the config value
2012-09-23 04:39:11 +04:00
* @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
2012-09-08 17:58:28 +04:00
*
* This function gets a value from the appconfig table. If the key does
2012-09-23 04:39:11 +04:00
* not exist the default value will be returned
2012-09-08 17:58:28 +04:00
*/
public static function getAppValue( $app, $key, $default = null ) {
2013-03-19 11:47:29 +04:00
return \OC_Appconfig::getValue( $app, $key, $default );
2012-05-02 16:11:29 +04:00
}
2012-09-08 17:58:28 +04:00
/**
* Sets a value in the appconfig
2012-09-23 04:39:11 +04:00
* @param string $app app
* @param string $key key
* @param string $value value
* @return boolean true/false
2012-09-08 17:58:28 +04:00
*
* Sets a value. If the key did not exist before it will be created.
*/
public static function setAppValue( $app, $key, $value ) {
2013-03-19 11:47:29 +04:00
try {
\OC_Appconfig::setValue( $app, $key, $value );
2014-04-07 22:57:08 +04:00
} catch (\Exception $e) {
2013-03-19 11:47:29 +04:00
return false;
}
return true;
2012-05-02 16:11:29 +04:00
}
2012-09-08 17:58:28 +04:00
/**
* Gets the preference
2012-09-23 04:39:11 +04:00
* @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
2012-09-08 17:58:28 +04:00
*
2012-09-23 04:39:11 +04:00
* This function gets a value from the preferences table. If the key does
* not exist the default value will be returned
2012-09-08 17:58:28 +04:00
*/
public static function getUserValue( $user, $app, $key, $default = null ) {
2013-03-19 11:47:29 +04:00
return \OC_Preferences::getValue( $user, $app, $key, $default );
2012-05-02 17:54:34 +04:00
}
2012-09-08 17:58:28 +04:00
/**
* Sets a value in the preferences
2012-09-23 04:39:11 +04:00
* @param string $user user
* @param string $app app
* @param string $key key
* @param string $value value
* @return bool
2012-09-08 17:58:28 +04:00
*
* 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 ) {
2013-03-19 11:47:29 +04:00
try {
\OC_Preferences::setValue( $user, $app, $key, $value );
2014-04-07 22:57:08 +04:00
} catch (\Exception $e) {
2013-03-19 11:47:29 +04:00
return false;
}
return true;
2012-05-02 17:54:34 +04:00
}
2012-05-02 15:28:56 +04:00
}