nextcloud/lib/private/legacy/config.php

108 lines
2.6 KiB
PHP
Raw Normal View History

2013-03-03 15:06:00 +04:00
<?php
/**
* ownCloud
*
* @author Frank Karlitschek
* @author Jakob Sack
* @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/>.
*
*/
/*
*
* An example of config.php
*
* <?php
* $CONFIG = array(
* "database" => "mysql",
* "firstrun" => false,
* "pi" => 3.14
* );
* ?>
*
*/
/**
* This class is responsible for reading and writing config.php, the very basic
2013-06-04 02:05:38 +04:00
* configuration file of ownCloud.
2013-03-03 15:06:00 +04:00
*/
OC_Config::$object = new \OC\Config(OC::$SERVERROOT.'/config/');
2013-06-04 02:05:38 +04:00
class OC_Config {
/**
* @var \OC\Config
*/
2013-03-03 15:06:00 +04:00
public static $object;
2013-06-04 02:05:38 +04:00
public static function getObject() {
return self::$object;
}
2013-03-03 15:06:00 +04:00
/**
* @brief Lists all available config keys
* @return array with key names
*
* This function returns all keys saved in config.php. Please note that it
* does not return the values.
*/
public static function getKeys() {
return self::$object->getKeys();
}
/**
* @brief Gets a value from config.php
* @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.
*/
2013-06-04 02:05:38 +04:00
public static function getValue($key, $default = null) {
return self::$object->getValue($key, $default);
2013-03-03 15:06:00 +04:00
}
/**
* @brief Sets a value
* @param string $key key
* @param string $value value
*
2013-06-04 02:05:38 +04:00
* This function sets the value and writes the config.php.
*
2013-03-03 15:06:00 +04:00
*/
2013-06-04 02:05:38 +04:00
public static function setValue($key, $value) {
2013-03-03 15:06:00 +04:00
try {
2013-06-04 02:05:38 +04:00
self::$object->setValue($key, $value);
2013-03-03 15:06:00 +04:00
} catch (\OC\HintException $e) {
2013-06-04 02:05:38 +04:00
\OC_Template::printErrorPage($e->getMessage(), $e->getHint());
2013-03-03 15:06:00 +04:00
}
}
/**
* @brief Removes a key from the config
* @param string $key key
*
2013-06-04 02:05:38 +04:00
* This function removes a key from the config.php.
*
2013-03-03 15:06:00 +04:00
*/
2013-06-04 02:05:38 +04:00
public static function deleteKey($key) {
2013-03-03 15:06:00 +04:00
try {
2013-06-04 02:05:38 +04:00
self::$object->deleteKey($key);
2013-03-03 15:06:00 +04:00
} catch (\OC\HintException $e) {
2013-06-04 02:05:38 +04:00
\OC_Template::printErrorPage($e->getMessage(), $e->getHint());
2013-03-03 15:06:00 +04:00
}
}
}