Completed
Pull Request — master (#9895)
by Björn
43:43 queued 13:05
created
lib/public/Security/ICredentialsManager.php 1 patch
Indentation   +35 added lines, -35 removed lines patch added patch discarded remove patch
@@ -30,43 +30,43 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
lib/public/Security/IContentSecurityPolicyManager.php 1 patch
Indentation   +18 added lines, -18 removed lines patch added patch discarded remove patch
@@ -30,22 +30,22 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
lib/public/IUserManager.php 2 patches
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -68,7 +68,7 @@
 block discarded – undo
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
Please login to merge, or discard this patch.
Indentation   +141 added lines, -141 removed lines patch added patch discarded remove patch
@@ -41,145 +41,145 @@
 block discarded – undo
41 41
  * @since 8.0.0
42 42
  */
43 43
 interface IUserManager {
44
-		/**
45
-	 * register a user backend
46
-	 *
47
-	 * @param \OCP\UserInterface $backend
48
-	 * @since 8.0.0
49
-	 */
50
-	public function registerBackend($backend);
51
-
52
-	/**
53
-	 * Get the active backends
54
-	 * @return \OCP\UserInterface[]
55
-	 * @since 8.0.0
56
-	 */
57
-	public function getBackends();
58
-
59
-	/**
60
-	 * remove a user backend
61
-	 *
62
-	 * @param \OCP\UserInterface $backend
63
-	 * @since 8.0.0
64
-	 */
65
-	public function removeBackend($backend);
66
-
67
-	/**
68
-	 * remove all user backends
69
-	 * @since 8.0.0
70
-	 */
71
-	public function clearBackends() ;
72
-
73
-	/**
74
-	 * get a user by user id
75
-	 *
76
-	 * @param string $uid
77
-	 * @return \OCP\IUser|null Either the user or null if the specified user does not exist
78
-	 * @since 8.0.0
79
-	 */
80
-	public function get($uid);
81
-
82
-	/**
83
-	 * check if a user exists
84
-	 *
85
-	 * @param string $uid
86
-	 * @return bool
87
-	 * @since 8.0.0
88
-	 */
89
-	public function userExists($uid);
90
-
91
-	/**
92
-	 * Check if the password is valid for the user
93
-	 *
94
-	 * @param string $loginName
95
-	 * @param string $password
96
-	 * @return mixed the User object on success, false otherwise
97
-	 * @since 8.0.0
98
-	 */
99
-	public function checkPassword($loginName, $password);
100
-
101
-	/**
102
-	 * search by user id
103
-	 *
104
-	 * @param string $pattern
105
-	 * @param int $limit
106
-	 * @param int $offset
107
-	 * @return \OCP\IUser[]
108
-	 * @since 8.0.0
109
-	 */
110
-	public function search($pattern, $limit = null, $offset = null);
111
-
112
-	/**
113
-	 * search by displayName
114
-	 *
115
-	 * @param string $pattern
116
-	 * @param int $limit
117
-	 * @param int $offset
118
-	 * @return \OCP\IUser[]
119
-	 * @since 8.0.0
120
-	 */
121
-	public function searchDisplayName($pattern, $limit = null, $offset = null);
122
-
123
-	/**
124
-	 * @param string $uid
125
-	 * @param string $password
126
-	 * @throws \InvalidArgumentException
127
-	 * @return bool|\OCP\IUser the created user of false
128
-	 * @since 8.0.0
129
-	 */
130
-	public function createUser($uid, $password);
131
-
132
-	/**
133
-	 * @param string $uid
134
-	 * @param string $password
135
-	 * @param UserInterface $backend
136
-	 * @return IUser|null
137
-	 * @throws \InvalidArgumentException
138
-	 * @since 12.0.0
139
-	 */
140
-	public function createUserFromBackend($uid, $password, UserInterface $backend);
141
-
142
-	/**
143
-	 * returns how many users per backend exist (if supported by backend)
144
-	 *
145
-	 * @return array an array of backend class as key and count number as value
146
-	 * @since 8.0.0
147
-	 */
148
-	public function countUsers();
149
-
150
-	/**
151
-	 * @param \Closure $callback
152
-	 * @param string $search
153
-	 * @since 9.0.0
154
-	 */
155
-	public function callForAllUsers(\Closure $callback, $search = '');
156
-
157
-	/**
158
-	 * returns how many users have logged in once
159
-	 *
160
-	 * @return int
161
-	 * @since 11.0.0
162
-	 */
163
-	public function countDisabledUsers();
164
-
165
-	/**
166
-	 * returns how many users have logged in once
167
-	 *
168
-	 * @return int
169
-	 * @since 11.0.0
170
-	 */
171
-	public function countSeenUsers();
172
-
173
-	/**
174
-	 * @param \Closure $callback
175
-	 * @since 11.0.0
176
-	 */
177
-	public function callForSeenUsers(\Closure $callback);
178
-
179
-	/**
180
-	 * @param string $email
181
-	 * @return IUser[]
182
-	 * @since 9.1.0
183
-	 */
184
-	public function getByEmail($email);
44
+        /**
45
+         * register a user backend
46
+         *
47
+         * @param \OCP\UserInterface $backend
48
+         * @since 8.0.0
49
+         */
50
+    public function registerBackend($backend);
51
+
52
+    /**
53
+     * Get the active backends
54
+     * @return \OCP\UserInterface[]
55
+     * @since 8.0.0
56
+     */
57
+    public function getBackends();
58
+
59
+    /**
60
+     * remove a user backend
61
+     *
62
+     * @param \OCP\UserInterface $backend
63
+     * @since 8.0.0
64
+     */
65
+    public function removeBackend($backend);
66
+
67
+    /**
68
+     * remove all user backends
69
+     * @since 8.0.0
70
+     */
71
+    public function clearBackends() ;
72
+
73
+    /**
74
+     * get a user by user id
75
+     *
76
+     * @param string $uid
77
+     * @return \OCP\IUser|null Either the user or null if the specified user does not exist
78
+     * @since 8.0.0
79
+     */
80
+    public function get($uid);
81
+
82
+    /**
83
+     * check if a user exists
84
+     *
85
+     * @param string $uid
86
+     * @return bool
87
+     * @since 8.0.0
88
+     */
89
+    public function userExists($uid);
90
+
91
+    /**
92
+     * Check if the password is valid for the user
93
+     *
94
+     * @param string $loginName
95
+     * @param string $password
96
+     * @return mixed the User object on success, false otherwise
97
+     * @since 8.0.0
98
+     */
99
+    public function checkPassword($loginName, $password);
100
+
101
+    /**
102
+     * search by user id
103
+     *
104
+     * @param string $pattern
105
+     * @param int $limit
106
+     * @param int $offset
107
+     * @return \OCP\IUser[]
108
+     * @since 8.0.0
109
+     */
110
+    public function search($pattern, $limit = null, $offset = null);
111
+
112
+    /**
113
+     * search by displayName
114
+     *
115
+     * @param string $pattern
116
+     * @param int $limit
117
+     * @param int $offset
118
+     * @return \OCP\IUser[]
119
+     * @since 8.0.0
120
+     */
121
+    public function searchDisplayName($pattern, $limit = null, $offset = null);
122
+
123
+    /**
124
+     * @param string $uid
125
+     * @param string $password
126
+     * @throws \InvalidArgumentException
127
+     * @return bool|\OCP\IUser the created user of false
128
+     * @since 8.0.0
129
+     */
130
+    public function createUser($uid, $password);
131
+
132
+    /**
133
+     * @param string $uid
134
+     * @param string $password
135
+     * @param UserInterface $backend
136
+     * @return IUser|null
137
+     * @throws \InvalidArgumentException
138
+     * @since 12.0.0
139
+     */
140
+    public function createUserFromBackend($uid, $password, UserInterface $backend);
141
+
142
+    /**
143
+     * returns how many users per backend exist (if supported by backend)
144
+     *
145
+     * @return array an array of backend class as key and count number as value
146
+     * @since 8.0.0
147
+     */
148
+    public function countUsers();
149
+
150
+    /**
151
+     * @param \Closure $callback
152
+     * @param string $search
153
+     * @since 9.0.0
154
+     */
155
+    public function callForAllUsers(\Closure $callback, $search = '');
156
+
157
+    /**
158
+     * returns how many users have logged in once
159
+     *
160
+     * @return int
161
+     * @since 11.0.0
162
+     */
163
+    public function countDisabledUsers();
164
+
165
+    /**
166
+     * returns how many users have logged in once
167
+     *
168
+     * @return int
169
+     * @since 11.0.0
170
+     */
171
+    public function countSeenUsers();
172
+
173
+    /**
174
+     * @param \Closure $callback
175
+     * @since 11.0.0
176
+     */
177
+    public function callForSeenUsers(\Closure $callback);
178
+
179
+    /**
180
+     * @param string $email
181
+     * @return IUser[]
182
+     * @since 9.1.0
183
+     */
184
+    public function getByEmail($email);
185 185
 }
Please login to merge, or discard this patch.
lib/public/IConfig.php 1 patch
Indentation   +183 added lines, -183 removed lines patch added patch discarded remove patch
@@ -41,187 +41,187 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
lib/public/Comments/CommentsEvent.php 1 patch
Indentation   +33 added lines, -33 removed lines patch added patch discarded remove patch
@@ -32,41 +32,41 @@
 block discarded – undo
32 32
  */
33 33
 class CommentsEvent extends Event {
34 34
 
35
-	const EVENT_ADD        = 'OCP\Comments\ICommentsManager::addComment';
36
-	const EVENT_PRE_UPDATE = 'OCP\Comments\ICommentsManager::preUpdateComment';
37
-	const EVENT_UPDATE     = 'OCP\Comments\ICommentsManager::updateComment';
38
-	const EVENT_DELETE     = 'OCP\Comments\ICommentsManager::deleteComment';
35
+    const EVENT_ADD        = 'OCP\Comments\ICommentsManager::addComment';
36
+    const EVENT_PRE_UPDATE = 'OCP\Comments\ICommentsManager::preUpdateComment';
37
+    const EVENT_UPDATE     = 'OCP\Comments\ICommentsManager::updateComment';
38
+    const EVENT_DELETE     = 'OCP\Comments\ICommentsManager::deleteComment';
39 39
 
40
-	/** @var string */
41
-	protected $event;
42
-	/** @var IComment */
43
-	protected $comment;
40
+    /** @var string */
41
+    protected $event;
42
+    /** @var IComment */
43
+    protected $comment;
44 44
 
45
-	/**
46
-	 * DispatcherEvent constructor.
47
-	 *
48
-	 * @param string $event
49
-	 * @param IComment $comment
50
-	 * @since 9.0.0
51
-	 */
52
-	public function __construct($event, IComment $comment) {
53
-		$this->event = $event;
54
-		$this->comment = $comment;
55
-	}
45
+    /**
46
+     * DispatcherEvent constructor.
47
+     *
48
+     * @param string $event
49
+     * @param IComment $comment
50
+     * @since 9.0.0
51
+     */
52
+    public function __construct($event, IComment $comment) {
53
+        $this->event = $event;
54
+        $this->comment = $comment;
55
+    }
56 56
 
57
-	/**
58
-	 * @return string
59
-	 * @since 9.0.0
60
-	 */
61
-	public function getEvent() {
62
-		return $this->event;
63
-	}
57
+    /**
58
+     * @return string
59
+     * @since 9.0.0
60
+     */
61
+    public function getEvent() {
62
+        return $this->event;
63
+    }
64 64
 
65
-	/**
66
-	 * @return IComment
67
-	 * @since 9.0.0
68
-	 */
69
-	public function getComment() {
70
-		return $this->comment;
71
-	}
65
+    /**
66
+     * @return IComment
67
+     * @since 9.0.0
68
+     */
69
+    public function getComment() {
70
+        return $this->comment;
71
+    }
72 72
 }
Please login to merge, or discard this patch.
lib/public/Comments/ICommentsEventHandler.php 1 patch
Indentation   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -31,9 +31,9 @@
 block discarded – undo
31 31
  */
32 32
 interface ICommentsEventHandler {
33 33
 
34
-	/**
35
-	 * @param CommentsEvent $event
36
-	 * @since 11.0.0
37
-	 */
38
-	public function handle(CommentsEvent $event);
34
+    /**
35
+     * @param CommentsEvent $event
36
+     * @since 11.0.0
37
+     */
38
+    public function handle(CommentsEvent $event);
39 39
 }
Please login to merge, or discard this patch.
lib/public/Comments/IComment.php 1 patch
Indentation   +203 added lines, -203 removed lines patch added patch discarded remove patch
@@ -31,233 +31,233 @@
 block discarded – undo
31 31
  * @since 9.0.0
32 32
  */
33 33
 interface IComment {
34
-	const MAX_MESSAGE_LENGTH = 1000;
34
+    const MAX_MESSAGE_LENGTH = 1000;
35 35
 
36
-	/**
37
-	 * returns the ID of the comment
38
-	 *
39
-	 * It may return an empty string, if the comment was not stored.
40
-	 * It is expected that the concrete Comment implementation gives an ID
41
-	 * by itself (e.g. after saving).
42
-	 *
43
-	 * @return string
44
-	 * @since 9.0.0
45
-	 */
46
-	public function getId();
36
+    /**
37
+     * returns the ID of the comment
38
+     *
39
+     * It may return an empty string, if the comment was not stored.
40
+     * It is expected that the concrete Comment implementation gives an ID
41
+     * by itself (e.g. after saving).
42
+     *
43
+     * @return string
44
+     * @since 9.0.0
45
+     */
46
+    public function getId();
47 47
 
48
-	/**
49
-	 * sets the ID of the comment and returns itself
50
-	 *
51
-	 * It is only allowed to set the ID only, if the current id is an empty
52
-	 * string (which means it is not stored in a database, storage or whatever
53
-	 * the concrete implementation does), or vice versa. Changing a given ID is
54
-	 * not permitted and must result in an IllegalIDChangeException.
55
-	 *
56
-	 * @param string $id
57
-	 * @return IComment
58
-	 * @throws IllegalIDChangeException
59
-	 * @since 9.0.0
60
-	 */
61
-	public function setId($id);
48
+    /**
49
+     * sets the ID of the comment and returns itself
50
+     *
51
+     * It is only allowed to set the ID only, if the current id is an empty
52
+     * string (which means it is not stored in a database, storage or whatever
53
+     * the concrete implementation does), or vice versa. Changing a given ID is
54
+     * not permitted and must result in an IllegalIDChangeException.
55
+     *
56
+     * @param string $id
57
+     * @return IComment
58
+     * @throws IllegalIDChangeException
59
+     * @since 9.0.0
60
+     */
61
+    public function setId($id);
62 62
 
63
-	/**
64
-	 * returns the parent ID of the comment
65
-	 *
66
-	 * @return string
67
-	 * @since 9.0.0
68
-	 */
69
-	public function getParentId();
63
+    /**
64
+     * returns the parent ID of the comment
65
+     *
66
+     * @return string
67
+     * @since 9.0.0
68
+     */
69
+    public function getParentId();
70 70
 
71
-	/**
72
-	 * sets the parent ID and returns itself
73
-	 * @param string $parentId
74
-	 * @return IComment
75
-	 * @since 9.0.0
76
-	 */
77
-	public function setParentId($parentId);
71
+    /**
72
+     * sets the parent ID and returns itself
73
+     * @param string $parentId
74
+     * @return IComment
75
+     * @since 9.0.0
76
+     */
77
+    public function setParentId($parentId);
78 78
 
79
-	/**
80
-	 * returns the topmost parent ID of the comment
81
-	 *
82
-	 * @return string
83
-	 * @since 9.0.0
84
-	 */
85
-	public function getTopmostParentId();
79
+    /**
80
+     * returns the topmost parent ID of the comment
81
+     *
82
+     * @return string
83
+     * @since 9.0.0
84
+     */
85
+    public function getTopmostParentId();
86 86
 
87 87
 
88
-	/**
89
-	 * sets the topmost parent ID and returns itself
90
-	 *
91
-	 * @param string $id
92
-	 * @return IComment
93
-	 * @since 9.0.0
94
-	 */
95
-	public function setTopmostParentId($id);
88
+    /**
89
+     * sets the topmost parent ID and returns itself
90
+     *
91
+     * @param string $id
92
+     * @return IComment
93
+     * @since 9.0.0
94
+     */
95
+    public function setTopmostParentId($id);
96 96
 
97
-	/**
98
-	 * returns the number of children
99
-	 *
100
-	 * @return int
101
-	 * @since 9.0.0
102
-	 */
103
-	public function getChildrenCount();
97
+    /**
98
+     * returns the number of children
99
+     *
100
+     * @return int
101
+     * @since 9.0.0
102
+     */
103
+    public function getChildrenCount();
104 104
 
105
-	/**
106
-	 * sets the number of children
107
-	 *
108
-	 * @param int $count
109
-	 * @return IComment
110
-	 * @since 9.0.0
111
-	 */
112
-	public function setChildrenCount($count);
105
+    /**
106
+     * sets the number of children
107
+     *
108
+     * @param int $count
109
+     * @return IComment
110
+     * @since 9.0.0
111
+     */
112
+    public function setChildrenCount($count);
113 113
 
114
-	/**
115
-	 * returns the message of the comment
116
-	 *
117
-	 * @return string
118
-	 * @since 9.0.0
119
-	 */
120
-	public function getMessage();
114
+    /**
115
+     * returns the message of the comment
116
+     *
117
+     * @return string
118
+     * @since 9.0.0
119
+     */
120
+    public function getMessage();
121 121
 
122
-	/**
123
-	 * sets the message of the comment and returns itself
124
-	 *
125
-	 * When the given message length exceeds MAX_MESSAGE_LENGTH an
126
-	 * MessageTooLongException shall be thrown.
127
-	 *
128
-	 * @param string $message
129
-	 * @return IComment
130
-	 * @throws MessageTooLongException
131
-	 * @since 9.0.0
132
-	 */
133
-	public function setMessage($message);
122
+    /**
123
+     * sets the message of the comment and returns itself
124
+     *
125
+     * When the given message length exceeds MAX_MESSAGE_LENGTH an
126
+     * MessageTooLongException shall be thrown.
127
+     *
128
+     * @param string $message
129
+     * @return IComment
130
+     * @throws MessageTooLongException
131
+     * @since 9.0.0
132
+     */
133
+    public function setMessage($message);
134 134
 
135
-	/**
136
-	 * returns an array containing mentions that are included in the comment
137
-	 *
138
-	 * @return array each mention provides a 'type' and an 'id', see example below
139
-	 * @since 11.0.0
140
-	 *
141
-	 * The return array looks like:
142
-	 * [
143
-	 *   [
144
-	 *     'type' => 'user',
145
-	 *     'id' => 'citizen4'
146
-	 *   ],
147
-	 *   [
148
-	 *     'type' => 'group',
149
-	 *     'id' => 'media'
150
-	 *   ],
151
-	 *   …
152
-	 * ]
153
-	 *
154
-	 */
155
-	public function getMentions();
135
+    /**
136
+     * returns an array containing mentions that are included in the comment
137
+     *
138
+     * @return array each mention provides a 'type' and an 'id', see example below
139
+     * @since 11.0.0
140
+     *
141
+     * The return array looks like:
142
+     * [
143
+     *   [
144
+     *     'type' => 'user',
145
+     *     'id' => 'citizen4'
146
+     *   ],
147
+     *   [
148
+     *     'type' => 'group',
149
+     *     'id' => 'media'
150
+     *   ],
151
+     *   …
152
+     * ]
153
+     *
154
+     */
155
+    public function getMentions();
156 156
 
157
-	/**
158
-	 * returns the verb of the comment
159
-	 *
160
-	 * @return string
161
-	 * @since 9.0.0
162
-	 */
163
-	public function getVerb();
157
+    /**
158
+     * returns the verb of the comment
159
+     *
160
+     * @return string
161
+     * @since 9.0.0
162
+     */
163
+    public function getVerb();
164 164
 
165
-	/**
166
-	 * sets the verb of the comment, e.g. 'comment' or 'like'
167
-	 *
168
-	 * @param string $verb
169
-	 * @return IComment
170
-	 * @since 9.0.0
171
-	 */
172
-	public function setVerb($verb);
165
+    /**
166
+     * sets the verb of the comment, e.g. 'comment' or 'like'
167
+     *
168
+     * @param string $verb
169
+     * @return IComment
170
+     * @since 9.0.0
171
+     */
172
+    public function setVerb($verb);
173 173
 
174
-	/**
175
-	 * returns the actor type
176
-	 *
177
-	 * @return string
178
-	 * @since 9.0.0
179
-	 */
180
-	public function getActorType();
174
+    /**
175
+     * returns the actor type
176
+     *
177
+     * @return string
178
+     * @since 9.0.0
179
+     */
180
+    public function getActorType();
181 181
 
182
-	/**
183
-	 * returns the actor ID
184
-	 *
185
-	 * @return string
186
-	 * @since 9.0.0
187
-	 */
188
-	public function getActorId();
182
+    /**
183
+     * returns the actor ID
184
+     *
185
+     * @return string
186
+     * @since 9.0.0
187
+     */
188
+    public function getActorId();
189 189
 
190
-	/**
191
-	 * sets (overwrites) the actor type and id
192
-	 *
193
-	 * @param string $actorType e.g. 'users'
194
-	 * @param string $actorId e.g. 'zombie234'
195
-	 * @return IComment
196
-	 * @since 9.0.0
197
-	 */
198
-	public function setActor($actorType, $actorId);
190
+    /**
191
+     * sets (overwrites) the actor type and id
192
+     *
193
+     * @param string $actorType e.g. 'users'
194
+     * @param string $actorId e.g. 'zombie234'
195
+     * @return IComment
196
+     * @since 9.0.0
197
+     */
198
+    public function setActor($actorType, $actorId);
199 199
 
200
-	/**
201
-	 * returns the creation date of the comment.
202
-	 *
203
-	 * If not explicitly set, it shall default to the time of initialization.
204
-	 *
205
-	 * @return \DateTime
206
-	 * @since 9.0.0
207
-	 */
208
-	public function getCreationDateTime();
200
+    /**
201
+     * returns the creation date of the comment.
202
+     *
203
+     * If not explicitly set, it shall default to the time of initialization.
204
+     *
205
+     * @return \DateTime
206
+     * @since 9.0.0
207
+     */
208
+    public function getCreationDateTime();
209 209
 
210
-	/**
211
-	 * sets the creation date of the comment and returns itself
212
-	 *
213
-	 * @param \DateTime $dateTime
214
-	 * @return IComment
215
-	 * @since 9.0.0
216
-	 */
217
-	public function setCreationDateTime(\DateTime $dateTime);
210
+    /**
211
+     * sets the creation date of the comment and returns itself
212
+     *
213
+     * @param \DateTime $dateTime
214
+     * @return IComment
215
+     * @since 9.0.0
216
+     */
217
+    public function setCreationDateTime(\DateTime $dateTime);
218 218
 
219
-	/**
220
-	 * returns the date of the most recent child
221
-	 *
222
-	 * @return \DateTime
223
-	 * @since 9.0.0
224
-	 */
225
-	public function getLatestChildDateTime();
219
+    /**
220
+     * returns the date of the most recent child
221
+     *
222
+     * @return \DateTime
223
+     * @since 9.0.0
224
+     */
225
+    public function getLatestChildDateTime();
226 226
 
227
-	/**
228
-	 * sets the date of the most recent child
229
-	 *
230
-	 * @param \DateTime $dateTime
231
-	 * @return IComment
232
-	 * @since 9.0.0
233
-	 */
234
-	public function setLatestChildDateTime(\DateTime $dateTime);
227
+    /**
228
+     * sets the date of the most recent child
229
+     *
230
+     * @param \DateTime $dateTime
231
+     * @return IComment
232
+     * @since 9.0.0
233
+     */
234
+    public function setLatestChildDateTime(\DateTime $dateTime);
235 235
 
236
-	/**
237
-	 * returns the object type the comment is attached to
238
-	 *
239
-	 * @return string
240
-	 * @since 9.0.0
241
-	 */
242
-	public function getObjectType();
236
+    /**
237
+     * returns the object type the comment is attached to
238
+     *
239
+     * @return string
240
+     * @since 9.0.0
241
+     */
242
+    public function getObjectType();
243 243
 
244
-	/**
245
-	 * returns the object id the comment is attached to
246
-	 *
247
-	 * @return string
248
-	 * @since 9.0.0
249
-	 */
250
-	public function getObjectId();
244
+    /**
245
+     * returns the object id the comment is attached to
246
+     *
247
+     * @return string
248
+     * @since 9.0.0
249
+     */
250
+    public function getObjectId();
251 251
 
252
-	/**
253
-	 * sets (overwrites) the object of the comment
254
-	 *
255
-	 * @param string $objectType e.g. 'files'
256
-	 * @param string $objectId e.g. '16435'
257
-	 * @return IComment
258
-	 * @since 9.0.0
259
-	 */
260
-	public function setObject($objectType, $objectId);
252
+    /**
253
+     * sets (overwrites) the object of the comment
254
+     *
255
+     * @param string $objectType e.g. 'files'
256
+     * @param string $objectId e.g. '16435'
257
+     * @return IComment
258
+     * @since 9.0.0
259
+     */
260
+    public function setObject($objectType, $objectId);
261 261
 
262 262
 }
263 263
 
Please login to merge, or discard this patch.
lib/public/Comments/CommentsEntityEvent.php 2 patches
Indentation   +37 added lines, -37 removed lines patch added patch discarded remove patch
@@ -32,46 +32,46 @@
 block discarded – undo
32 32
  */
33 33
 class CommentsEntityEvent extends Event {
34 34
 
35
-	const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity';
35
+    const EVENT_ENTITY = 'OCP\Comments\ICommentsManager::registerEntity';
36 36
 
37
-	/** @var string */
38
-	protected $event;
39
-	/** @var \Closure[] */
40
-	protected $collections;
37
+    /** @var string */
38
+    protected $event;
39
+    /** @var \Closure[] */
40
+    protected $collections;
41 41
 
42
-	/**
43
-	 * DispatcherEvent constructor.
44
-	 *
45
-	 * @param string $event
46
-	 * @since 9.1.0
47
-	 */
48
-	public function __construct($event) {
49
-		$this->event = $event;
50
-		$this->collections = [];
51
-	}
42
+    /**
43
+     * DispatcherEvent constructor.
44
+     *
45
+     * @param string $event
46
+     * @since 9.1.0
47
+     */
48
+    public function __construct($event) {
49
+        $this->event = $event;
50
+        $this->collections = [];
51
+    }
52 52
 
53
-	/**
54
-	 * @param string $name
55
-	 * @param \Closure $entityExistsFunction The closure should take one
56
-	 *                 argument, which is the id of the entity, that comments
57
-	 *                 should be handled for. The return should then be bool,
58
-	 *                 depending on whether comments are allowed (true) or not.
59
-	 * @throws \OutOfBoundsException when the entity name is already taken
60
-	 * @since 9.1.0
61
-	 */
62
-	public function addEntityCollection($name, \Closure $entityExistsFunction) {
63
-		if (isset($this->collections[$name])) {
64
-			throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"');
65
-		}
53
+    /**
54
+     * @param string $name
55
+     * @param \Closure $entityExistsFunction The closure should take one
56
+     *                 argument, which is the id of the entity, that comments
57
+     *                 should be handled for. The return should then be bool,
58
+     *                 depending on whether comments are allowed (true) or not.
59
+     * @throws \OutOfBoundsException when the entity name is already taken
60
+     * @since 9.1.0
61
+     */
62
+    public function addEntityCollection($name, \Closure $entityExistsFunction) {
63
+        if (isset($this->collections[$name])) {
64
+            throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"');
65
+        }
66 66
 
67
-		$this->collections[$name] = $entityExistsFunction;
68
-	}
67
+        $this->collections[$name] = $entityExistsFunction;
68
+    }
69 69
 
70
-	/**
71
-	 * @return \Closure[]
72
-	 * @since 9.1.0
73
-	 */
74
-	public function getEntityCollections() {
75
-		return $this->collections;
76
-	}
70
+    /**
71
+     * @return \Closure[]
72
+     * @since 9.1.0
73
+     */
74
+    public function getEntityCollections() {
75
+        return $this->collections;
76
+    }
77 77
 }
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -61,7 +61,7 @@
 block discarded – undo
61 61
 	 */
62 62
 	public function addEntityCollection($name, \Closure $entityExistsFunction) {
63 63
 		if (isset($this->collections[$name])) {
64
-			throw new \OutOfBoundsException('Duplicate entity name "' . $name . '"');
64
+			throw new \OutOfBoundsException('Duplicate entity name "'.$name.'"');
65 65
 		}
66 66
 
67 67
 		$this->collections[$name] = $entityExistsFunction;
Please login to merge, or discard this patch.
lib/public/Comments/ICommentsManagerFactory.php 1 patch
Indentation   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -36,19 +36,19 @@
 block discarded – undo
36 36
  */
37 37
 interface ICommentsManagerFactory {
38 38
 
39
-	/**
40
-	 * Constructor for the comments manager factory
41
-	 *
42
-	 * @param IServerContainer $serverContainer server container
43
-	 * @since 9.0.0
44
-	 */
45
-	public function __construct(IServerContainer $serverContainer);
39
+    /**
40
+     * Constructor for the comments manager factory
41
+     *
42
+     * @param IServerContainer $serverContainer server container
43
+     * @since 9.0.0
44
+     */
45
+    public function __construct(IServerContainer $serverContainer);
46 46
 
47
-	/**
48
-	 * creates and returns an instance of the ICommentsManager
49
-	 *
50
-	 * @return ICommentsManager
51
-	 * @since 9.0.0
52
-	 */
53
-	public function getManager();
47
+    /**
48
+     * creates and returns an instance of the ICommentsManager
49
+     *
50
+     * @return ICommentsManager
51
+     * @since 9.0.0
52
+     */
53
+    public function getManager();
54 54
 }
Please login to merge, or discard this patch.