appconfig.php 3.34 KB
Newer Older
1
2
<?php
/**
3
 * ownCloud
4
 *
5
6
7
 * @author Frank Karlitschek
 * @author Jakob Sack
 * @copyright 2012 Frank Karlitschek frank@owncloud.org
8
 *
9
10
11
12
 * 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.
13
 *
14
 * This library is distributed in the hope that it will be useful,
15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
18
 *
19
20
 * 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/>.
21
22
 *
 */
23
24
25
26
27

/**
 * This class provides an easy way for apps to store config values in the
 * database.
 *
28
 * @deprecated use \OC::$server->getConfig() to get an \OCP\IConfig instance
29
 */
30
31
32
33
34
35
36
37
class OC_Appconfig {
	/**
	 * @return \OCP\IAppConfig
	 */
	private static function getAppConfig() {
		return \OC::$server->getAppConfig();
	}

38
	/**
39
	 * Get all apps using the config
40
	 * @return array an array of app ids
41
42
43
44
45
	 *
	 * This function returns a list of all apps that have at least one
	 * entry in the appconfig table.
	 */
	public static function getApps() {
46
		return self::getAppConfig()->getApps();
47
48
49
	}

	/**
50
	 * Get the available keys for an app
51
	 * @param string $app the app we are looking for
52
	 * @return array an array of key names
53
54
55
56
	 *
	 * This function gets all keys of an app. Please note that the values are
	 * not returned.
	 */
57
58
	public static function getKeys($app) {
		return self::getAppConfig()->getKeys($app);
59
60
61
	}

	/**
62
	 * Gets the config value
63
64
65
66
67
68
69
70
	 * @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
	 */
71
72
	public static function getValue($app, $key, $default = null) {
		return self::getAppConfig()->getValue($app, $key, $default);
73
74
75
	}

	/**
76
	 * check if a key is set in the appconfig
77
78
79
80
81
	 * @param string $app
	 * @param string $key
	 * @return bool
	 */
	public static function hasKey($app, $key) {
82
		return self::getAppConfig()->hasKey($app, $key);
83
84
85
	}

	/**
86
	 * sets a value in the appconfig
87
88
89
90
91
92
	 * @param string $app app
	 * @param string $key key
	 * @param string $value value
	 *
	 * Sets a value. If the key did not exist before it will be created.
	 */
93
94
	public static function setValue($app, $key, $value) {
		self::getAppConfig()->setValue($app, $key, $value);
95
96
97
	}

	/**
98
	 * Deletes a key
99
100
101
102
103
	 * @param string $app app
	 * @param string $key key
	 *
	 * Deletes a key.
	 */
104
105
	public static function deleteKey($app, $key) {
		self::getAppConfig()->deleteKey($app, $key);
106
107
108
	}

	/**
109
	 * Remove app from appconfig
110
111
112
113
	 * @param string $app app
	 *
	 * Removes all keys in appconfig belonging to the app.
	 */
114
115
	public static function deleteApp($app) {
		self::getAppConfig()->deleteApp($app);
116
117
118
119
	}

	/**
	 * get multiply values, either the app or key can be used as wildcard by setting it to false
120
	 *
121
122
	 * @param string|false $app
	 * @param string|false $key
123
124
125
	 * @return array
	 */
	public static function getValues($app, $key) {
126
		return self::getAppConfig()->getValues($app, $key);
127
128
	}
}