1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
<?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/>.
*
*/
/**
* Public interface of ownCloud for apps to use.
* Config Class
*
*/
/**
* @brief use OCP namespace for all classes that are considered public.
*
* Classes that use this namespace are for use by apps, and not for use by internal
* OC classes
*/
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
* @param $default = null default value
* @returns the value or $default
*
* This function gets the value from config.php. If it does not exist,
* $default will be returned.
*/
public static function getSystemValue( $key, $default = null ){
return(\OC_Config::getValue( $key, $default ));
}
/**
* @brief Sets a value
* @param $key key
* @param $value value
* @returns true/false
*
* This function sets the value and writes the config.php. If the file can
* not be written, false will be returned.
*/
public static function setSystemValue( $key, $value ){
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 ){
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 ){
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 ){
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 ){
return(\OC_Preferences::setValue( $user, $app, $key, $value ));
}
}
?>
|
