appconfig.php 3.5 KB
Newer Older
1
2
<?php
/**
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
3
4
5
6
7
 * @author Bart Visscher <bartv@thisnet.nl>
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Robin Appelman <icewind@owncloud.com>
 * @author Robin McCorkell <rmccorkell@karoshi.org.uk>
 * @author Scrutinizer Auto-Fixer <auto-fixer@scrutinizer-ci.com>
8
 *
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
9
10
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
11
 *
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
12
13
14
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
15
 *
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
16
 * This program is distributed in the hope that it will be useful,
17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
18
19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
20
 *
Jenkins for ownCloud's avatar
Jenkins for ownCloud committed
21
22
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
23
24
 *
 */
25
26
27
28
29

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

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

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

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

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

	/**
88
	 * sets a value in the appconfig
89
90
91
92
93
94
	 * @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.
	 */
95
96
	public static function setValue($app, $key, $value) {
		self::getAppConfig()->setValue($app, $key, $value);
97
98
99
	}

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

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

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