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
|
<?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/>.
*
*/
/**
* This class provides an easy way for storing user preferences.
* @deprecated use \OCP\IConfig methods instead
*/
class OC_Preferences{
/**
* Get the available keys for an app
* @param string $user user
* @param string $app the app we are looking for
* @return array an array of key names
* @deprecated use getUserKeys of \OCP\IConfig instead
*
* This function gets all keys of an app of an user. Please note that the
* values are not returned.
*/
public static function getKeys( $user, $app ) {
return \OC::$server->getConfig()->getUserKeys($user, $app);
}
/**
* Gets the preference
* @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
* @deprecated use getUserValue of \OCP\IConfig instead
*
* This function gets a value from the preferences table. If the key does
* not exist the default value will be returned
*/
public static function getValue( $user, $app, $key, $default = null ) {
return \OC::$server->getConfig()->getUserValue($user, $app, $key, $default);
}
/**
* sets a value in the preferences
* @param string $user user
* @param string $app app
* @param string $key key
* @param string $value value
* @param string $preCondition only set value if the key had a specific value before
* @return bool true if value was set, otherwise false
* @deprecated use setUserValue of \OCP\IConfig instead
*
* Adds a value to the preferences. If the key did not exist before, it
* will be added automagically.
*/
public static function setValue( $user, $app, $key, $value, $preCondition = null ) {
return \OC::$server->getConfig()->setUserValue($user, $app, $key, $value);
// TODO maybe catch exceptions and then return false
return true;
}
/**
* Deletes a key
* @param string $user user
* @param string $app app
* @param string $key key
* @return bool true
* @deprecated use deleteUserValue of \OCP\IConfig instead
*
* Deletes a key.
*/
public static function deleteKey( $user, $app, $key ) {
\OC::$server->getConfig()->deleteUserValue($user, $app, $key);
return true;
}
/**
* Remove user from preferences
* @param string $user user
* @return bool
* @deprecated use deleteUser of \OCP\IConfig instead
*
* Removes all keys in preferences belonging to the user.
*/
public static function deleteUser( $user ) {
\OC::$server->getConfig()->deleteAllUserValues($user);
return true;
}
/**
* Remove app from all users
* @param string $app app
* @return bool
* @deprecated use deleteAppFromAllUsers of \OCP\IConfig instead
*
* Removes all keys in preferences belonging to the app.
*/
public static function deleteAppFromAllUsers( $app ) {
\OC::$server->getConfig()->deleteAppFromAllUsers($app);
return true;
}
}
|
