@@ -28,15 +28,15 @@ |
||
28 | 28 | * @since 11.0.0 |
29 | 29 | */ |
30 | 30 | interface IProvider { |
31 | - /** |
|
32 | - * @param string $language The language which should be used for translating, e.g. "en" |
|
33 | - * @param IEvent $event The current event which should be parsed |
|
34 | - * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one. |
|
35 | - * To do so, simply use setChildEvent($previousEvent) after setting the |
|
36 | - * combined subject on the current event. |
|
37 | - * @return IEvent |
|
38 | - * @throws \InvalidArgumentException Should be thrown if your provider does not know this event |
|
39 | - * @since 11.0.0 |
|
40 | - */ |
|
41 | - public function parse($language, IEvent $event, IEvent $previousEvent = null); |
|
31 | + /** |
|
32 | + * @param string $language The language which should be used for translating, e.g. "en" |
|
33 | + * @param IEvent $event The current event which should be parsed |
|
34 | + * @param IEvent|null $previousEvent A potential previous event which you can combine with the current one. |
|
35 | + * To do so, simply use setChildEvent($previousEvent) after setting the |
|
36 | + * combined subject on the current event. |
|
37 | + * @return IEvent |
|
38 | + * @throws \InvalidArgumentException Should be thrown if your provider does not know this event |
|
39 | + * @since 11.0.0 |
|
40 | + */ |
|
41 | + public function parse($language, IEvent $event, IEvent $previousEvent = null); |
|
42 | 42 | } |
@@ -38,12 +38,12 @@ |
||
38 | 38 | * @since 6.0.0 |
39 | 39 | */ |
40 | 40 | interface IConsumer { |
41 | - /** |
|
42 | - * @param IEvent $event |
|
43 | - * @return null |
|
44 | - * @since 6.0.0 |
|
45 | - * @since 8.2.0 Replaced the parameters with an IEvent object |
|
46 | - */ |
|
47 | - public function receive(IEvent $event); |
|
41 | + /** |
|
42 | + * @param IEvent $event |
|
43 | + * @return null |
|
44 | + * @since 6.0.0 |
|
45 | + * @since 8.2.0 Replaced the parameters with an IEvent object |
|
46 | + */ |
|
47 | + public function receive(IEvent $event); |
|
48 | 48 | } |
49 | 49 |
@@ -29,12 +29,12 @@ |
||
29 | 29 | * @since 8.2.2 |
30 | 30 | */ |
31 | 31 | interface IMemcacheTTL extends IMemcache { |
32 | - /** |
|
33 | - * Set the ttl for an existing value |
|
34 | - * |
|
35 | - * @param string $key |
|
36 | - * @param int $ttl time to live in seconds |
|
37 | - * @since 8.2.2 |
|
38 | - */ |
|
39 | - public function setTTL($key, $ttl); |
|
32 | + /** |
|
33 | + * Set the ttl for an existing value |
|
34 | + * |
|
35 | + * @param string $key |
|
36 | + * @param int $ttl time to live in seconds |
|
37 | + * @since 8.2.2 |
|
38 | + */ |
|
39 | + public function setTTL($key, $ttl); |
|
40 | 40 | } |
@@ -40,44 +40,44 @@ |
||
40 | 40 | * @since 6.0.0 |
41 | 41 | */ |
42 | 42 | interface IUserSession { |
43 | - /** |
|
44 | - * Do a user login |
|
45 | - * @param string $user the username |
|
46 | - * @param string $password the password |
|
47 | - * @return bool true if successful |
|
48 | - * @since 6.0.0 |
|
49 | - */ |
|
50 | - public function login($user, $password); |
|
43 | + /** |
|
44 | + * Do a user login |
|
45 | + * @param string $user the username |
|
46 | + * @param string $password the password |
|
47 | + * @return bool true if successful |
|
48 | + * @since 6.0.0 |
|
49 | + */ |
|
50 | + public function login($user, $password); |
|
51 | 51 | |
52 | - /** |
|
53 | - * Logs the user out including all the session data |
|
54 | - * Logout, destroys session |
|
55 | - * @return void |
|
56 | - * @since 6.0.0 |
|
57 | - */ |
|
58 | - public function logout(); |
|
52 | + /** |
|
53 | + * Logs the user out including all the session data |
|
54 | + * Logout, destroys session |
|
55 | + * @return void |
|
56 | + * @since 6.0.0 |
|
57 | + */ |
|
58 | + public function logout(); |
|
59 | 59 | |
60 | - /** |
|
61 | - * set the currently active user |
|
62 | - * |
|
63 | - * @param \OCP\IUser|null $user |
|
64 | - * @since 8.0.0 |
|
65 | - */ |
|
66 | - public function setUser($user); |
|
60 | + /** |
|
61 | + * set the currently active user |
|
62 | + * |
|
63 | + * @param \OCP\IUser|null $user |
|
64 | + * @since 8.0.0 |
|
65 | + */ |
|
66 | + public function setUser($user); |
|
67 | 67 | |
68 | - /** |
|
69 | - * get the current active user |
|
70 | - * |
|
71 | - * @return \OCP\IUser|null Current user, otherwise null |
|
72 | - * @since 8.0.0 |
|
73 | - */ |
|
74 | - public function getUser(); |
|
68 | + /** |
|
69 | + * get the current active user |
|
70 | + * |
|
71 | + * @return \OCP\IUser|null Current user, otherwise null |
|
72 | + * @since 8.0.0 |
|
73 | + */ |
|
74 | + public function getUser(); |
|
75 | 75 | |
76 | - /** |
|
77 | - * Checks whether the user is logged in |
|
78 | - * |
|
79 | - * @return bool if logged in |
|
80 | - * @since 8.0.0 |
|
81 | - */ |
|
82 | - public function isLoggedIn(); |
|
76 | + /** |
|
77 | + * Checks whether the user is logged in |
|
78 | + * |
|
79 | + * @return bool if logged in |
|
80 | + * @since 8.0.0 |
|
81 | + */ |
|
82 | + public function isLoggedIn(); |
|
83 | 83 | } |
@@ -30,10 +30,10 @@ |
||
30 | 30 | * @since 8.0.0 |
31 | 31 | */ |
32 | 32 | interface IDateTimeZone { |
33 | - /** |
|
34 | - * @param bool|int $timestamp |
|
35 | - * @return \DateTimeZone |
|
36 | - * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
37 | - */ |
|
38 | - public function getTimeZone($timestamp = false); |
|
33 | + /** |
|
34 | + * @param bool|int $timestamp |
|
35 | + * @return \DateTimeZone |
|
36 | + * @since 8.0.0 - parameter $timestamp was added in 8.1.0 |
|
37 | + */ |
|
38 | + public function getTimeZone($timestamp = false); |
|
39 | 39 | } |
@@ -30,43 +30,43 @@ |
||
30 | 30 | */ |
31 | 31 | interface ICredentialsManager { |
32 | 32 | |
33 | - /** |
|
34 | - * Store a set of credentials |
|
35 | - * |
|
36 | - * @param string|null $userId Null for system-wide credentials |
|
37 | - * @param string $identifier |
|
38 | - * @param mixed $credentials |
|
39 | - * @since 8.2.0 |
|
40 | - */ |
|
41 | - public function store($userId, $identifier, $credentials); |
|
33 | + /** |
|
34 | + * Store a set of credentials |
|
35 | + * |
|
36 | + * @param string|null $userId Null for system-wide credentials |
|
37 | + * @param string $identifier |
|
38 | + * @param mixed $credentials |
|
39 | + * @since 8.2.0 |
|
40 | + */ |
|
41 | + public function store($userId, $identifier, $credentials); |
|
42 | 42 | |
43 | - /** |
|
44 | - * Retrieve a set of credentials |
|
45 | - * |
|
46 | - * @param string|null $userId Null for system-wide credentials |
|
47 | - * @param string $identifier |
|
48 | - * @return mixed |
|
49 | - * @since 8.2.0 |
|
50 | - */ |
|
51 | - public function retrieve($userId, $identifier); |
|
43 | + /** |
|
44 | + * Retrieve a set of credentials |
|
45 | + * |
|
46 | + * @param string|null $userId Null for system-wide credentials |
|
47 | + * @param string $identifier |
|
48 | + * @return mixed |
|
49 | + * @since 8.2.0 |
|
50 | + */ |
|
51 | + public function retrieve($userId, $identifier); |
|
52 | 52 | |
53 | - /** |
|
54 | - * Delete a set of credentials |
|
55 | - * |
|
56 | - * @param string|null $userId Null for system-wide credentials |
|
57 | - * @param string $identifier |
|
58 | - * @return int rows removed |
|
59 | - * @since 8.2.0 |
|
60 | - */ |
|
61 | - public function delete($userId, $identifier); |
|
53 | + /** |
|
54 | + * Delete a set of credentials |
|
55 | + * |
|
56 | + * @param string|null $userId Null for system-wide credentials |
|
57 | + * @param string $identifier |
|
58 | + * @return int rows removed |
|
59 | + * @since 8.2.0 |
|
60 | + */ |
|
61 | + public function delete($userId, $identifier); |
|
62 | 62 | |
63 | - /** |
|
64 | - * Erase all credentials stored for a user |
|
65 | - * |
|
66 | - * @param string $userId |
|
67 | - * @return int rows removed |
|
68 | - * @since 8.2.0 |
|
69 | - */ |
|
70 | - public function erase($userId); |
|
63 | + /** |
|
64 | + * Erase all credentials stored for a user |
|
65 | + * |
|
66 | + * @param string $userId |
|
67 | + * @return int rows removed |
|
68 | + * @since 8.2.0 |
|
69 | + */ |
|
70 | + public function erase($userId); |
|
71 | 71 | |
72 | 72 | } |
@@ -30,22 +30,22 @@ |
||
30 | 30 | * @since 9.0.0 |
31 | 31 | */ |
32 | 32 | interface IContentSecurityPolicyManager { |
33 | - /** |
|
34 | - * Allows to inject something into the default content policy. This is for |
|
35 | - * example useful when you're injecting Javascript code into a view belonging |
|
36 | - * to another controller and cannot modify its Content-Security-Policy itself. |
|
37 | - * Note that the adjustment is only applied to applications that use AppFramework |
|
38 | - * controllers. |
|
39 | - * |
|
40 | - * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`, |
|
41 | - * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`. |
|
42 | - * |
|
43 | - * WARNING: Using this API incorrectly may make the instance more insecure. |
|
44 | - * Do think twice before adding whitelisting resources. Please do also note |
|
45 | - * that it is not possible to use the `disallowXYZ` functions. |
|
46 | - * |
|
47 | - * @param EmptyContentSecurityPolicy $policy |
|
48 | - * @since 9.0.0 |
|
49 | - */ |
|
50 | - public function addDefaultPolicy(EmptyContentSecurityPolicy $policy); |
|
33 | + /** |
|
34 | + * Allows to inject something into the default content policy. This is for |
|
35 | + * example useful when you're injecting Javascript code into a view belonging |
|
36 | + * to another controller and cannot modify its Content-Security-Policy itself. |
|
37 | + * Note that the adjustment is only applied to applications that use AppFramework |
|
38 | + * controllers. |
|
39 | + * |
|
40 | + * To use this from your `app.php` use `\OC::$server->getContentSecurityPolicyManager()->addDefaultPolicy($policy)`, |
|
41 | + * $policy has to be of type `\OCP\AppFramework\Http\ContentSecurityPolicy`. |
|
42 | + * |
|
43 | + * WARNING: Using this API incorrectly may make the instance more insecure. |
|
44 | + * Do think twice before adding whitelisting resources. Please do also note |
|
45 | + * that it is not possible to use the `disallowXYZ` functions. |
|
46 | + * |
|
47 | + * @param EmptyContentSecurityPolicy $policy |
|
48 | + * @since 9.0.0 |
|
49 | + */ |
|
50 | + public function addDefaultPolicy(EmptyContentSecurityPolicy $policy); |
|
51 | 51 | } |
@@ -68,7 +68,7 @@ |
||
68 | 68 | * remove all user backends |
69 | 69 | * @since 8.0.0 |
70 | 70 | */ |
71 | - public function clearBackends() ; |
|
71 | + public function clearBackends(); |
|
72 | 72 | |
73 | 73 | /** |
74 | 74 | * get a user by user id |
@@ -48,145 +48,145 @@ |
||
48 | 48 | * @since 8.0.0 |
49 | 49 | */ |
50 | 50 | interface IUserManager { |
51 | - /** |
|
52 | - * register a user backend |
|
53 | - * |
|
54 | - * @param \OCP\UserInterface $backend |
|
55 | - * @since 8.0.0 |
|
56 | - */ |
|
57 | - public function registerBackend($backend); |
|
58 | - |
|
59 | - /** |
|
60 | - * Get the active backends |
|
61 | - * @return \OCP\UserInterface[] |
|
62 | - * @since 8.0.0 |
|
63 | - */ |
|
64 | - public function getBackends(); |
|
65 | - |
|
66 | - /** |
|
67 | - * remove a user backend |
|
68 | - * |
|
69 | - * @param \OCP\UserInterface $backend |
|
70 | - * @since 8.0.0 |
|
71 | - */ |
|
72 | - public function removeBackend($backend); |
|
73 | - |
|
74 | - /** |
|
75 | - * remove all user backends |
|
76 | - * @since 8.0.0 |
|
77 | - */ |
|
78 | - public function clearBackends() ; |
|
79 | - |
|
80 | - /** |
|
81 | - * get a user by user id |
|
82 | - * |
|
83 | - * @param string $uid |
|
84 | - * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
85 | - * @since 8.0.0 |
|
86 | - */ |
|
87 | - public function get($uid); |
|
88 | - |
|
89 | - /** |
|
90 | - * check if a user exists |
|
91 | - * |
|
92 | - * @param string $uid |
|
93 | - * @return bool |
|
94 | - * @since 8.0.0 |
|
95 | - */ |
|
96 | - public function userExists($uid); |
|
97 | - |
|
98 | - /** |
|
99 | - * Check if the password is valid for the user |
|
100 | - * |
|
101 | - * @param string $loginName |
|
102 | - * @param string $password |
|
103 | - * @return mixed the User object on success, false otherwise |
|
104 | - * @since 8.0.0 |
|
105 | - */ |
|
106 | - public function checkPassword($loginName, $password); |
|
107 | - |
|
108 | - /** |
|
109 | - * search by user id |
|
110 | - * |
|
111 | - * @param string $pattern |
|
112 | - * @param int $limit |
|
113 | - * @param int $offset |
|
114 | - * @return \OCP\IUser[] |
|
115 | - * @since 8.0.0 |
|
116 | - */ |
|
117 | - public function search($pattern, $limit = null, $offset = null); |
|
118 | - |
|
119 | - /** |
|
120 | - * search by displayName |
|
121 | - * |
|
122 | - * @param string $pattern |
|
123 | - * @param int $limit |
|
124 | - * @param int $offset |
|
125 | - * @return \OCP\IUser[] |
|
126 | - * @since 8.0.0 |
|
127 | - */ |
|
128 | - public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
129 | - |
|
130 | - /** |
|
131 | - * @param string $uid |
|
132 | - * @param string $password |
|
133 | - * @throws \InvalidArgumentException |
|
134 | - * @return bool|\OCP\IUser the created user or false |
|
135 | - * @since 8.0.0 |
|
136 | - */ |
|
137 | - public function createUser($uid, $password); |
|
138 | - |
|
139 | - /** |
|
140 | - * @param string $uid |
|
141 | - * @param string $password |
|
142 | - * @param UserInterface $backend |
|
143 | - * @return IUser|null |
|
144 | - * @throws \InvalidArgumentException |
|
145 | - * @since 12.0.0 |
|
146 | - */ |
|
147 | - public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
148 | - |
|
149 | - /** |
|
150 | - * returns how many users per backend exist (if supported by backend) |
|
151 | - * |
|
152 | - * @return array an array of backend class as key and count number as value |
|
153 | - * @since 8.0.0 |
|
154 | - */ |
|
155 | - public function countUsers(); |
|
156 | - |
|
157 | - /** |
|
158 | - * @param \Closure $callback |
|
159 | - * @param string $search |
|
160 | - * @since 9.0.0 |
|
161 | - */ |
|
162 | - public function callForAllUsers(\Closure $callback, $search = ''); |
|
163 | - |
|
164 | - /** |
|
165 | - * returns how many users have logged in once |
|
166 | - * |
|
167 | - * @return int |
|
168 | - * @since 11.0.0 |
|
169 | - */ |
|
170 | - public function countDisabledUsers(); |
|
171 | - |
|
172 | - /** |
|
173 | - * returns how many users have logged in once |
|
174 | - * |
|
175 | - * @return int |
|
176 | - * @since 11.0.0 |
|
177 | - */ |
|
178 | - public function countSeenUsers(); |
|
179 | - |
|
180 | - /** |
|
181 | - * @param \Closure $callback |
|
182 | - * @since 11.0.0 |
|
183 | - */ |
|
184 | - public function callForSeenUsers(\Closure $callback); |
|
185 | - |
|
186 | - /** |
|
187 | - * @param string $email |
|
188 | - * @return IUser[] |
|
189 | - * @since 9.1.0 |
|
190 | - */ |
|
191 | - public function getByEmail($email); |
|
51 | + /** |
|
52 | + * register a user backend |
|
53 | + * |
|
54 | + * @param \OCP\UserInterface $backend |
|
55 | + * @since 8.0.0 |
|
56 | + */ |
|
57 | + public function registerBackend($backend); |
|
58 | + |
|
59 | + /** |
|
60 | + * Get the active backends |
|
61 | + * @return \OCP\UserInterface[] |
|
62 | + * @since 8.0.0 |
|
63 | + */ |
|
64 | + public function getBackends(); |
|
65 | + |
|
66 | + /** |
|
67 | + * remove a user backend |
|
68 | + * |
|
69 | + * @param \OCP\UserInterface $backend |
|
70 | + * @since 8.0.0 |
|
71 | + */ |
|
72 | + public function removeBackend($backend); |
|
73 | + |
|
74 | + /** |
|
75 | + * remove all user backends |
|
76 | + * @since 8.0.0 |
|
77 | + */ |
|
78 | + public function clearBackends() ; |
|
79 | + |
|
80 | + /** |
|
81 | + * get a user by user id |
|
82 | + * |
|
83 | + * @param string $uid |
|
84 | + * @return \OCP\IUser|null Either the user or null if the specified user does not exist |
|
85 | + * @since 8.0.0 |
|
86 | + */ |
|
87 | + public function get($uid); |
|
88 | + |
|
89 | + /** |
|
90 | + * check if a user exists |
|
91 | + * |
|
92 | + * @param string $uid |
|
93 | + * @return bool |
|
94 | + * @since 8.0.0 |
|
95 | + */ |
|
96 | + public function userExists($uid); |
|
97 | + |
|
98 | + /** |
|
99 | + * Check if the password is valid for the user |
|
100 | + * |
|
101 | + * @param string $loginName |
|
102 | + * @param string $password |
|
103 | + * @return mixed the User object on success, false otherwise |
|
104 | + * @since 8.0.0 |
|
105 | + */ |
|
106 | + public function checkPassword($loginName, $password); |
|
107 | + |
|
108 | + /** |
|
109 | + * search by user id |
|
110 | + * |
|
111 | + * @param string $pattern |
|
112 | + * @param int $limit |
|
113 | + * @param int $offset |
|
114 | + * @return \OCP\IUser[] |
|
115 | + * @since 8.0.0 |
|
116 | + */ |
|
117 | + public function search($pattern, $limit = null, $offset = null); |
|
118 | + |
|
119 | + /** |
|
120 | + * search by displayName |
|
121 | + * |
|
122 | + * @param string $pattern |
|
123 | + * @param int $limit |
|
124 | + * @param int $offset |
|
125 | + * @return \OCP\IUser[] |
|
126 | + * @since 8.0.0 |
|
127 | + */ |
|
128 | + public function searchDisplayName($pattern, $limit = null, $offset = null); |
|
129 | + |
|
130 | + /** |
|
131 | + * @param string $uid |
|
132 | + * @param string $password |
|
133 | + * @throws \InvalidArgumentException |
|
134 | + * @return bool|\OCP\IUser the created user or false |
|
135 | + * @since 8.0.0 |
|
136 | + */ |
|
137 | + public function createUser($uid, $password); |
|
138 | + |
|
139 | + /** |
|
140 | + * @param string $uid |
|
141 | + * @param string $password |
|
142 | + * @param UserInterface $backend |
|
143 | + * @return IUser|null |
|
144 | + * @throws \InvalidArgumentException |
|
145 | + * @since 12.0.0 |
|
146 | + */ |
|
147 | + public function createUserFromBackend($uid, $password, UserInterface $backend); |
|
148 | + |
|
149 | + /** |
|
150 | + * returns how many users per backend exist (if supported by backend) |
|
151 | + * |
|
152 | + * @return array an array of backend class as key and count number as value |
|
153 | + * @since 8.0.0 |
|
154 | + */ |
|
155 | + public function countUsers(); |
|
156 | + |
|
157 | + /** |
|
158 | + * @param \Closure $callback |
|
159 | + * @param string $search |
|
160 | + * @since 9.0.0 |
|
161 | + */ |
|
162 | + public function callForAllUsers(\Closure $callback, $search = ''); |
|
163 | + |
|
164 | + /** |
|
165 | + * returns how many users have logged in once |
|
166 | + * |
|
167 | + * @return int |
|
168 | + * @since 11.0.0 |
|
169 | + */ |
|
170 | + public function countDisabledUsers(); |
|
171 | + |
|
172 | + /** |
|
173 | + * returns how many users have logged in once |
|
174 | + * |
|
175 | + * @return int |
|
176 | + * @since 11.0.0 |
|
177 | + */ |
|
178 | + public function countSeenUsers(); |
|
179 | + |
|
180 | + /** |
|
181 | + * @param \Closure $callback |
|
182 | + * @since 11.0.0 |
|
183 | + */ |
|
184 | + public function callForSeenUsers(\Closure $callback); |
|
185 | + |
|
186 | + /** |
|
187 | + * @param string $email |
|
188 | + * @return IUser[] |
|
189 | + * @since 9.1.0 |
|
190 | + */ |
|
191 | + public function getByEmail($email); |
|
192 | 192 | } |
@@ -41,187 +41,187 @@ |
||
41 | 41 | * @since 6.0.0 |
42 | 42 | */ |
43 | 43 | interface IConfig { |
44 | - /** |
|
45 | - * @since 8.2.0 |
|
46 | - */ |
|
47 | - const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***'; |
|
48 | - |
|
49 | - /** |
|
50 | - * Sets and deletes system wide values |
|
51 | - * |
|
52 | - * @param array $configs Associative array with `key => value` pairs |
|
53 | - * If value is null, the config key will be deleted |
|
54 | - * @since 8.0.0 |
|
55 | - */ |
|
56 | - public function setSystemValues(array $configs); |
|
57 | - |
|
58 | - /** |
|
59 | - * Sets a new system wide value |
|
60 | - * |
|
61 | - * @param string $key the key of the value, under which will be saved |
|
62 | - * @param mixed $value the value that should be stored |
|
63 | - * @since 8.0.0 |
|
64 | - */ |
|
65 | - public function setSystemValue($key, $value); |
|
66 | - |
|
67 | - /** |
|
68 | - * Looks up a system wide defined value |
|
69 | - * |
|
70 | - * @param string $key the key of the value, under which it was saved |
|
71 | - * @param mixed $default the default value to be returned if the value isn't set |
|
72 | - * @return mixed the value or $default |
|
73 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
74 | - */ |
|
75 | - public function getSystemValue($key, $default = ''); |
|
76 | - |
|
77 | - /** |
|
78 | - * Looks up a system wide defined value and filters out sensitive data |
|
79 | - * |
|
80 | - * @param string $key the key of the value, under which it was saved |
|
81 | - * @param mixed $default the default value to be returned if the value isn't set |
|
82 | - * @return mixed the value or $default |
|
83 | - * @since 8.2.0 |
|
84 | - */ |
|
85 | - public function getFilteredSystemValue($key, $default = ''); |
|
86 | - |
|
87 | - /** |
|
88 | - * Delete a system wide defined value |
|
89 | - * |
|
90 | - * @param string $key the key of the value, under which it was saved |
|
91 | - * @since 8.0.0 |
|
92 | - */ |
|
93 | - public function deleteSystemValue($key); |
|
94 | - |
|
95 | - /** |
|
96 | - * Get all keys stored for an app |
|
97 | - * |
|
98 | - * @param string $appName the appName that we stored the value under |
|
99 | - * @return string[] the keys stored for the app |
|
100 | - * @since 8.0.0 |
|
101 | - */ |
|
102 | - public function getAppKeys($appName); |
|
103 | - |
|
104 | - /** |
|
105 | - * Writes a new app wide value |
|
106 | - * |
|
107 | - * @param string $appName the appName that we want to store the value under |
|
108 | - * @param string|float|int $key the key of the value, under which will be saved |
|
109 | - * @param string $value the value that should be stored |
|
110 | - * @return void |
|
111 | - * @since 6.0.0 |
|
112 | - */ |
|
113 | - public function setAppValue($appName, $key, $value); |
|
114 | - |
|
115 | - /** |
|
116 | - * Looks up an app wide defined value |
|
117 | - * |
|
118 | - * @param string $appName the appName that we stored the value under |
|
119 | - * @param string $key the key of the value, under which it was saved |
|
120 | - * @param string $default the default value to be returned if the value isn't set |
|
121 | - * @return string the saved value |
|
122 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
123 | - */ |
|
124 | - public function getAppValue($appName, $key, $default = ''); |
|
125 | - |
|
126 | - /** |
|
127 | - * Delete an app wide defined value |
|
128 | - * |
|
129 | - * @param string $appName the appName that we stored the value under |
|
130 | - * @param string $key the key of the value, under which it was saved |
|
131 | - * @since 8.0.0 |
|
132 | - */ |
|
133 | - public function deleteAppValue($appName, $key); |
|
134 | - |
|
135 | - /** |
|
136 | - * Removes all keys in appconfig belonging to the app |
|
137 | - * |
|
138 | - * @param string $appName the appName the configs are stored under |
|
139 | - * @since 8.0.0 |
|
140 | - */ |
|
141 | - public function deleteAppValues($appName); |
|
142 | - |
|
143 | - |
|
144 | - /** |
|
145 | - * Set a user defined value |
|
146 | - * |
|
147 | - * @param string $userId the userId of the user that we want to store the value under |
|
148 | - * @param string $appName the appName that we want to store the value under |
|
149 | - * @param string $key the key under which the value is being stored |
|
150 | - * @param string $value the value that you want to store |
|
151 | - * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
152 | - * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
153 | - * @throws \UnexpectedValueException when trying to store an unexpected value |
|
154 | - * @since 6.0.0 - parameter $precondition was added in 8.0.0 |
|
155 | - */ |
|
156 | - public function setUserValue($userId, $appName, $key, $value, $preCondition = null); |
|
157 | - |
|
158 | - /** |
|
159 | - * Shortcut for getting a user defined value |
|
160 | - * |
|
161 | - * @param string $userId the userId of the user that we want to store the value under |
|
162 | - * @param string $appName the appName that we stored the value under |
|
163 | - * @param string $key the key under which the value is being stored |
|
164 | - * @param mixed $default the default value to be returned if the value isn't set |
|
165 | - * @return string |
|
166 | - * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
167 | - */ |
|
168 | - public function getUserValue($userId, $appName, $key, $default = ''); |
|
169 | - |
|
170 | - /** |
|
171 | - * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
172 | - * |
|
173 | - * @param string $appName app to get the value for |
|
174 | - * @param string $key the key to get the value for |
|
175 | - * @param array $userIds the user IDs to fetch the values for |
|
176 | - * @return array Mapped values: userId => value |
|
177 | - * @since 8.0.0 |
|
178 | - */ |
|
179 | - public function getUserValueForUsers($appName, $key, $userIds); |
|
180 | - |
|
181 | - /** |
|
182 | - * Get the keys of all stored by an app for the user |
|
183 | - * |
|
184 | - * @param string $userId the userId of the user that we want to store the value under |
|
185 | - * @param string $appName the appName that we stored the value under |
|
186 | - * @return string[] |
|
187 | - * @since 8.0.0 |
|
188 | - */ |
|
189 | - public function getUserKeys($userId, $appName); |
|
190 | - |
|
191 | - /** |
|
192 | - * Delete a user value |
|
193 | - * |
|
194 | - * @param string $userId the userId of the user that we want to store the value under |
|
195 | - * @param string $appName the appName that we stored the value under |
|
196 | - * @param string $key the key under which the value is being stored |
|
197 | - * @since 8.0.0 |
|
198 | - */ |
|
199 | - public function deleteUserValue($userId, $appName, $key); |
|
200 | - |
|
201 | - /** |
|
202 | - * Delete all user values |
|
203 | - * |
|
204 | - * @param string $userId the userId of the user that we want to remove all values from |
|
205 | - * @since 8.0.0 |
|
206 | - */ |
|
207 | - public function deleteAllUserValues($userId); |
|
208 | - |
|
209 | - /** |
|
210 | - * Delete all user related values of one app |
|
211 | - * |
|
212 | - * @param string $appName the appName of the app that we want to remove all values from |
|
213 | - * @since 8.0.0 |
|
214 | - */ |
|
215 | - public function deleteAppFromAllUsers($appName); |
|
216 | - |
|
217 | - /** |
|
218 | - * Determines the users that have the given value set for a specific app-key-pair |
|
219 | - * |
|
220 | - * @param string $appName the app to get the user for |
|
221 | - * @param string $key the key to get the user for |
|
222 | - * @param string $value the value to get the user for |
|
223 | - * @return array of user IDs |
|
224 | - * @since 8.0.0 |
|
225 | - */ |
|
226 | - public function getUsersForUserValue($appName, $key, $value); |
|
44 | + /** |
|
45 | + * @since 8.2.0 |
|
46 | + */ |
|
47 | + const SENSITIVE_VALUE = '***REMOVED SENSITIVE VALUE***'; |
|
48 | + |
|
49 | + /** |
|
50 | + * Sets and deletes system wide values |
|
51 | + * |
|
52 | + * @param array $configs Associative array with `key => value` pairs |
|
53 | + * If value is null, the config key will be deleted |
|
54 | + * @since 8.0.0 |
|
55 | + */ |
|
56 | + public function setSystemValues(array $configs); |
|
57 | + |
|
58 | + /** |
|
59 | + * Sets a new system wide value |
|
60 | + * |
|
61 | + * @param string $key the key of the value, under which will be saved |
|
62 | + * @param mixed $value the value that should be stored |
|
63 | + * @since 8.0.0 |
|
64 | + */ |
|
65 | + public function setSystemValue($key, $value); |
|
66 | + |
|
67 | + /** |
|
68 | + * Looks up a system wide defined value |
|
69 | + * |
|
70 | + * @param string $key the key of the value, under which it was saved |
|
71 | + * @param mixed $default the default value to be returned if the value isn't set |
|
72 | + * @return mixed the value or $default |
|
73 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
74 | + */ |
|
75 | + public function getSystemValue($key, $default = ''); |
|
76 | + |
|
77 | + /** |
|
78 | + * Looks up a system wide defined value and filters out sensitive data |
|
79 | + * |
|
80 | + * @param string $key the key of the value, under which it was saved |
|
81 | + * @param mixed $default the default value to be returned if the value isn't set |
|
82 | + * @return mixed the value or $default |
|
83 | + * @since 8.2.0 |
|
84 | + */ |
|
85 | + public function getFilteredSystemValue($key, $default = ''); |
|
86 | + |
|
87 | + /** |
|
88 | + * Delete a system wide defined value |
|
89 | + * |
|
90 | + * @param string $key the key of the value, under which it was saved |
|
91 | + * @since 8.0.0 |
|
92 | + */ |
|
93 | + public function deleteSystemValue($key); |
|
94 | + |
|
95 | + /** |
|
96 | + * Get all keys stored for an app |
|
97 | + * |
|
98 | + * @param string $appName the appName that we stored the value under |
|
99 | + * @return string[] the keys stored for the app |
|
100 | + * @since 8.0.0 |
|
101 | + */ |
|
102 | + public function getAppKeys($appName); |
|
103 | + |
|
104 | + /** |
|
105 | + * Writes a new app wide value |
|
106 | + * |
|
107 | + * @param string $appName the appName that we want to store the value under |
|
108 | + * @param string|float|int $key the key of the value, under which will be saved |
|
109 | + * @param string $value the value that should be stored |
|
110 | + * @return void |
|
111 | + * @since 6.0.0 |
|
112 | + */ |
|
113 | + public function setAppValue($appName, $key, $value); |
|
114 | + |
|
115 | + /** |
|
116 | + * Looks up an app wide defined value |
|
117 | + * |
|
118 | + * @param string $appName the appName that we stored the value under |
|
119 | + * @param string $key the key of the value, under which it was saved |
|
120 | + * @param string $default the default value to be returned if the value isn't set |
|
121 | + * @return string the saved value |
|
122 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
123 | + */ |
|
124 | + public function getAppValue($appName, $key, $default = ''); |
|
125 | + |
|
126 | + /** |
|
127 | + * Delete an app wide defined value |
|
128 | + * |
|
129 | + * @param string $appName the appName that we stored the value under |
|
130 | + * @param string $key the key of the value, under which it was saved |
|
131 | + * @since 8.0.0 |
|
132 | + */ |
|
133 | + public function deleteAppValue($appName, $key); |
|
134 | + |
|
135 | + /** |
|
136 | + * Removes all keys in appconfig belonging to the app |
|
137 | + * |
|
138 | + * @param string $appName the appName the configs are stored under |
|
139 | + * @since 8.0.0 |
|
140 | + */ |
|
141 | + public function deleteAppValues($appName); |
|
142 | + |
|
143 | + |
|
144 | + /** |
|
145 | + * Set a user defined value |
|
146 | + * |
|
147 | + * @param string $userId the userId of the user that we want to store the value under |
|
148 | + * @param string $appName the appName that we want to store the value under |
|
149 | + * @param string $key the key under which the value is being stored |
|
150 | + * @param string $value the value that you want to store |
|
151 | + * @param string $preCondition only update if the config value was previously the value passed as $preCondition |
|
152 | + * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met |
|
153 | + * @throws \UnexpectedValueException when trying to store an unexpected value |
|
154 | + * @since 6.0.0 - parameter $precondition was added in 8.0.0 |
|
155 | + */ |
|
156 | + public function setUserValue($userId, $appName, $key, $value, $preCondition = null); |
|
157 | + |
|
158 | + /** |
|
159 | + * Shortcut for getting a user defined value |
|
160 | + * |
|
161 | + * @param string $userId the userId of the user that we want to store the value under |
|
162 | + * @param string $appName the appName that we stored the value under |
|
163 | + * @param string $key the key under which the value is being stored |
|
164 | + * @param mixed $default the default value to be returned if the value isn't set |
|
165 | + * @return string |
|
166 | + * @since 6.0.0 - parameter $default was added in 7.0.0 |
|
167 | + */ |
|
168 | + public function getUserValue($userId, $appName, $key, $default = ''); |
|
169 | + |
|
170 | + /** |
|
171 | + * Fetches a mapped list of userId -> value, for a specified app and key and a list of user IDs. |
|
172 | + * |
|
173 | + * @param string $appName app to get the value for |
|
174 | + * @param string $key the key to get the value for |
|
175 | + * @param array $userIds the user IDs to fetch the values for |
|
176 | + * @return array Mapped values: userId => value |
|
177 | + * @since 8.0.0 |
|
178 | + */ |
|
179 | + public function getUserValueForUsers($appName, $key, $userIds); |
|
180 | + |
|
181 | + /** |
|
182 | + * Get the keys of all stored by an app for the user |
|
183 | + * |
|
184 | + * @param string $userId the userId of the user that we want to store the value under |
|
185 | + * @param string $appName the appName that we stored the value under |
|
186 | + * @return string[] |
|
187 | + * @since 8.0.0 |
|
188 | + */ |
|
189 | + public function getUserKeys($userId, $appName); |
|
190 | + |
|
191 | + /** |
|
192 | + * Delete a user value |
|
193 | + * |
|
194 | + * @param string $userId the userId of the user that we want to store the value under |
|
195 | + * @param string $appName the appName that we stored the value under |
|
196 | + * @param string $key the key under which the value is being stored |
|
197 | + * @since 8.0.0 |
|
198 | + */ |
|
199 | + public function deleteUserValue($userId, $appName, $key); |
|
200 | + |
|
201 | + /** |
|
202 | + * Delete all user values |
|
203 | + * |
|
204 | + * @param string $userId the userId of the user that we want to remove all values from |
|
205 | + * @since 8.0.0 |
|
206 | + */ |
|
207 | + public function deleteAllUserValues($userId); |
|
208 | + |
|
209 | + /** |
|
210 | + * Delete all user related values of one app |
|
211 | + * |
|
212 | + * @param string $appName the appName of the app that we want to remove all values from |
|
213 | + * @since 8.0.0 |
|
214 | + */ |
|
215 | + public function deleteAppFromAllUsers($appName); |
|
216 | + |
|
217 | + /** |
|
218 | + * Determines the users that have the given value set for a specific app-key-pair |
|
219 | + * |
|
220 | + * @param string $appName the app to get the user for |
|
221 | + * @param string $key the key to get the user for |
|
222 | + * @param string $value the value to get the user for |
|
223 | + * @return array of user IDs |
|
224 | + * @since 8.0.0 |
|
225 | + */ |
|
226 | + public function getUsersForUserValue($appName, $key, $value); |
|
227 | 227 | } |