Completed
Pull Request — master (#9895)
by Björn
43:43 queued 13:05
created
lib/public/Activity/IExtension.php 2 patches
Indentation   +117 added lines, -117 removed lines patch added patch discarded remove patch
@@ -39,132 +39,132 @@
 block discarded – undo
39 39
  * @since 8.0.0
40 40
  */
41 41
 interface IExtension {
42
-	const METHOD_STREAM = 'stream';
43
-	const METHOD_MAIL = 'email';
42
+    const METHOD_STREAM = 'stream';
43
+    const METHOD_MAIL = 'email';
44 44
 
45
-	const PRIORITY_VERYLOW 	= 10;
46
-	const PRIORITY_LOW	= 20;
47
-	const PRIORITY_MEDIUM	= 30;
48
-	const PRIORITY_HIGH	= 40;
49
-	const PRIORITY_VERYHIGH	= 50;
45
+    const PRIORITY_VERYLOW 	= 10;
46
+    const PRIORITY_LOW	= 20;
47
+    const PRIORITY_MEDIUM	= 30;
48
+    const PRIORITY_HIGH	= 40;
49
+    const PRIORITY_VERYHIGH	= 50;
50 50
 
51
-	/**
52
-	 * The extension can return an array of additional notification types.
53
-	 * If no additional types are to be added false is to be returned
54
-	 *
55
-	 * @param string $languageCode
56
-	 * @return array|false Array "stringID of the type" => "translated string description for the setting"
57
-	 * 				or Array "stringID of the type" => [
58
-	 * 					'desc' => "translated string description for the setting"
59
-	 * 					'methods' => [self::METHOD_*],
60
-	 * 				]
61
-	 * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
62
-	 */
63
-	public function getNotificationTypes($languageCode);
51
+    /**
52
+     * The extension can return an array of additional notification types.
53
+     * If no additional types are to be added false is to be returned
54
+     *
55
+     * @param string $languageCode
56
+     * @return array|false Array "stringID of the type" => "translated string description for the setting"
57
+     * 				or Array "stringID of the type" => [
58
+     * 					'desc' => "translated string description for the setting"
59
+     * 					'methods' => [self::METHOD_*],
60
+     * 				]
61
+     * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
62
+     */
63
+    public function getNotificationTypes($languageCode);
64 64
 
65
-	/**
66
-	 * For a given method additional types to be displayed in the settings can be returned.
67
-	 * In case no additional types are to be added false is to be returned.
68
-	 *
69
-	 * @param string $method
70
-	 * @return array|false
71
-	 * @since 8.0.0
72
-	 */
73
-	public function getDefaultTypes($method);
65
+    /**
66
+     * For a given method additional types to be displayed in the settings can be returned.
67
+     * In case no additional types are to be added false is to be returned.
68
+     *
69
+     * @param string $method
70
+     * @return array|false
71
+     * @since 8.0.0
72
+     */
73
+    public function getDefaultTypes($method);
74 74
 
75
-	/**
76
-	 * A string naming the css class for the icon to be used can be returned.
77
-	 * If no icon is known for the given type false is to be returned.
78
-	 *
79
-	 * @param string $type
80
-	 * @return string|false
81
-	 * @since 8.0.0
82
-	 */
83
-	public function getTypeIcon($type);
75
+    /**
76
+     * A string naming the css class for the icon to be used can be returned.
77
+     * If no icon is known for the given type false is to be returned.
78
+     *
79
+     * @param string $type
80
+     * @return string|false
81
+     * @since 8.0.0
82
+     */
83
+    public function getTypeIcon($type);
84 84
 
85
-	/**
86
-	 * The extension can translate a given message to the requested languages.
87
-	 * If no translation is available false is to be returned.
88
-	 *
89
-	 * @param string $app
90
-	 * @param string $text
91
-	 * @param array $params
92
-	 * @param boolean $stripPath
93
-	 * @param boolean $highlightParams
94
-	 * @param string $languageCode
95
-	 * @return string|false
96
-	 * @since 8.0.0
97
-	 */
98
-	public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
85
+    /**
86
+     * The extension can translate a given message to the requested languages.
87
+     * If no translation is available false is to be returned.
88
+     *
89
+     * @param string $app
90
+     * @param string $text
91
+     * @param array $params
92
+     * @param boolean $stripPath
93
+     * @param boolean $highlightParams
94
+     * @param string $languageCode
95
+     * @return string|false
96
+     * @since 8.0.0
97
+     */
98
+    public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
99 99
 
100
-	/**
101
-	 * The extension can define the type of parameters for translation
102
-	 *
103
-	 * Currently known types are:
104
-	 * * file		=> will strip away the path of the file and add a tooltip with it
105
-	 * * username	=> will add the avatar of the user
106
-	 * * email 	    => will add a mailto link
107
-	 *
108
-	 * @param string $app
109
-	 * @param string $text
110
-	 * @return array|false
111
-	 * @since 8.0.0
112
-	 */
113
-	public function getSpecialParameterList($app, $text);
100
+    /**
101
+     * The extension can define the type of parameters for translation
102
+     *
103
+     * Currently known types are:
104
+     * * file		=> will strip away the path of the file and add a tooltip with it
105
+     * * username	=> will add the avatar of the user
106
+     * * email 	    => will add a mailto link
107
+     *
108
+     * @param string $app
109
+     * @param string $text
110
+     * @return array|false
111
+     * @since 8.0.0
112
+     */
113
+    public function getSpecialParameterList($app, $text);
114 114
 
115
-	/**
116
-	 * The extension can define the parameter grouping by returning the index as integer.
117
-	 * In case no grouping is required false is to be returned.
118
-	 *
119
-	 * @param array $activity
120
-	 * @return integer|false
121
-	 * @since 8.0.0
122
-	 */
123
-	public function getGroupParameter($activity);
115
+    /**
116
+     * The extension can define the parameter grouping by returning the index as integer.
117
+     * In case no grouping is required false is to be returned.
118
+     *
119
+     * @param array $activity
120
+     * @return integer|false
121
+     * @since 8.0.0
122
+     */
123
+    public function getGroupParameter($activity);
124 124
 
125
-	/**
126
-	 * The extension can define additional navigation entries. The array returned has to contain two keys 'top'
127
-	 * and 'apps' which hold arrays with the relevant entries.
128
-	 * If no further entries are to be added false is no be returned.
129
-	 *
130
-	 * @return array|false
131
-	 * @since 8.0.0
132
-	 * @deprecated 11.0.0 - Register an IFilter instead
133
-	 */
134
-	public function getNavigation();
125
+    /**
126
+     * The extension can define additional navigation entries. The array returned has to contain two keys 'top'
127
+     * and 'apps' which hold arrays with the relevant entries.
128
+     * If no further entries are to be added false is no be returned.
129
+     *
130
+     * @return array|false
131
+     * @since 8.0.0
132
+     * @deprecated 11.0.0 - Register an IFilter instead
133
+     */
134
+    public function getNavigation();
135 135
 
136
-	/**
137
-	 * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not.
138
-	 *
139
-	 * @param string $filterValue
140
-	 * @return boolean
141
-	 * @since 8.0.0
142
-	 * @deprecated 11.0.0 - Register an IFilter instead
143
-	 */
144
-	public function isFilterValid($filterValue);
136
+    /**
137
+     * The extension can check if a customer filter (given by a query string like filter=abc) is valid or not.
138
+     *
139
+     * @param string $filterValue
140
+     * @return boolean
141
+     * @since 8.0.0
142
+     * @deprecated 11.0.0 - Register an IFilter instead
143
+     */
144
+    public function isFilterValid($filterValue);
145 145
 
146
-	/**
147
-	 * The extension can filter the types based on the filter if required.
148
-	 * In case no filter is to be applied false is to be returned unchanged.
149
-	 *
150
-	 * @param array $types
151
-	 * @param string $filter
152
-	 * @return array|false
153
-	 * @since 8.0.0
154
-	 * @deprecated 11.0.0 - Register an IFilter instead
155
-	 */
156
-	public function filterNotificationTypes($types, $filter);
146
+    /**
147
+     * The extension can filter the types based on the filter if required.
148
+     * In case no filter is to be applied false is to be returned unchanged.
149
+     *
150
+     * @param array $types
151
+     * @param string $filter
152
+     * @return array|false
153
+     * @since 8.0.0
154
+     * @deprecated 11.0.0 - Register an IFilter instead
155
+     */
156
+    public function filterNotificationTypes($types, $filter);
157 157
 
158
-	/**
159
-	 * For a given filter the extension can specify the sql query conditions including parameters for that query.
160
-	 * In case the extension does not know the filter false is to be returned.
161
-	 * The query condition and the parameters are to be returned as array with two elements.
162
-	 * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%'));
163
-	 *
164
-	 * @param string $filter
165
-	 * @return array|false
166
-	 * @since 8.0.0
167
-	 * @deprecated 11.0.0 - Register an IFilter instead
168
-	 */
169
-	public function getQueryForFilter($filter);
158
+    /**
159
+     * For a given filter the extension can specify the sql query conditions including parameters for that query.
160
+     * In case the extension does not know the filter false is to be returned.
161
+     * The query condition and the parameters are to be returned as array with two elements.
162
+     * E.g. return array('`app` = ? and `message` like ?', array('mail', 'ownCloud%'));
163
+     *
164
+     * @param string $filter
165
+     * @return array|false
166
+     * @since 8.0.0
167
+     * @deprecated 11.0.0 - Register an IFilter instead
168
+     */
169
+    public function getQueryForFilter($filter);
170 170
 }
Please login to merge, or discard this patch.
Spacing   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -42,11 +42,11 @@
 block discarded – undo
42 42
 	const METHOD_STREAM = 'stream';
43 43
 	const METHOD_MAIL = 'email';
44 44
 
45
-	const PRIORITY_VERYLOW 	= 10;
46
-	const PRIORITY_LOW	= 20;
47
-	const PRIORITY_MEDIUM	= 30;
48
-	const PRIORITY_HIGH	= 40;
49
-	const PRIORITY_VERYHIGH	= 50;
45
+	const PRIORITY_VERYLOW = 10;
46
+	const PRIORITY_LOW = 20;
47
+	const PRIORITY_MEDIUM = 30;
48
+	const PRIORITY_HIGH = 40;
49
+	const PRIORITY_VERYHIGH = 50;
50 50
 
51 51
 	/**
52 52
 	 * The extension can return an array of additional notification types.
Please login to merge, or discard this patch.
lib/public/Activity/IFilter.php 1 patch
Indentation   +33 added lines, -33 removed lines patch added patch discarded remove patch
@@ -29,43 +29,43 @@
 block discarded – undo
29 29
  */
30 30
 interface IFilter {
31 31
 
32
-	/**
33
-	 * @return string Lowercase a-z and underscore only identifier
34
-	 * @since 11.0.0
35
-	 */
36
-	public function getIdentifier();
32
+    /**
33
+     * @return string Lowercase a-z and underscore only identifier
34
+     * @since 11.0.0
35
+     */
36
+    public function getIdentifier();
37 37
 
38
-	/**
39
-	 * @return string A translated string
40
-	 * @since 11.0.0
41
-	 */
42
-	public function getName();
38
+    /**
39
+     * @return string A translated string
40
+     * @since 11.0.0
41
+     */
42
+    public function getName();
43 43
 
44
-	/**
45
-	 * @return int whether the filter should be rather on the top or bottom of
46
-	 * the admin section. The filters are arranged in ascending order of the
47
-	 * priority values. It is required to return a value between 0 and 100.
48
-	 * @since 11.0.0
49
-	 */
50
-	public function getPriority();
44
+    /**
45
+     * @return int whether the filter should be rather on the top or bottom of
46
+     * the admin section. The filters are arranged in ascending order of the
47
+     * priority values. It is required to return a value between 0 and 100.
48
+     * @since 11.0.0
49
+     */
50
+    public function getPriority();
51 51
 
52
-	/**
53
-	 * @return string Full URL to an icon, empty string when none is given
54
-	 * @since 11.0.0
55
-	 */
56
-	public function getIcon();
52
+    /**
53
+     * @return string Full URL to an icon, empty string when none is given
54
+     * @since 11.0.0
55
+     */
56
+    public function getIcon();
57 57
 
58
-	/**
59
-	 * @param string[] $types
60
-	 * @return string[] An array of allowed apps from which activities should be displayed
61
-	 * @since 11.0.0
62
-	 */
63
-	public function filterTypes(array $types);
58
+    /**
59
+     * @param string[] $types
60
+     * @return string[] An array of allowed apps from which activities should be displayed
61
+     * @since 11.0.0
62
+     */
63
+    public function filterTypes(array $types);
64 64
 
65
-	/**
66
-	 * @return string[] An array of allowed apps from which activities should be displayed
67
-	 * @since 11.0.0
68
-	 */
69
-	public function allowedApps();
65
+    /**
66
+     * @return string[] An array of allowed apps from which activities should be displayed
67
+     * @since 11.0.0
68
+     */
69
+    public function allowedApps();
70 70
 }
71 71
 
Please login to merge, or discard this patch.
lib/public/Activity/IEvent.php 1 patch
Indentation   +279 added lines, -279 removed lines patch added patch discarded remove patch
@@ -37,283 +37,283 @@
 block discarded – undo
37 37
  * @since 8.2.0
38 38
  */
39 39
 interface IEvent {
40
-	/**
41
-	 * Set the app of the activity
42
-	 *
43
-	 * @param string $app
44
-	 * @return IEvent
45
-	 * @throws \InvalidArgumentException if the app id is invalid
46
-	 * @since 8.2.0
47
-	 */
48
-	public function setApp($app);
49
-
50
-	/**
51
-	 * Set the type of the activity
52
-	 *
53
-	 * @param string $type
54
-	 * @return IEvent
55
-	 * @throws \InvalidArgumentException if the type is invalid
56
-	 * @since 8.2.0
57
-	 */
58
-	public function setType($type);
59
-
60
-	/**
61
-	 * Set the affected user of the activity
62
-	 *
63
-	 * @param string $user
64
-	 * @return IEvent
65
-	 * @throws \InvalidArgumentException if the affected user is invalid
66
-	 * @since 8.2.0
67
-	 */
68
-	public function setAffectedUser($user);
69
-
70
-	/**
71
-	 * Set the author of the activity
72
-	 *
73
-	 * @param string $author
74
-	 * @return IEvent
75
-	 * @throws \InvalidArgumentException if the author is invalid
76
-	 * @since 8.2.0
77
-	 */
78
-	public function setAuthor($author);
79
-
80
-	/**
81
-	 * Set the author of the activity
82
-	 *
83
-	 * @param int $timestamp
84
-	 * @return IEvent
85
-	 * @throws \InvalidArgumentException if the timestamp is invalid
86
-	 * @since 8.2.0
87
-	 */
88
-	public function setTimestamp($timestamp);
89
-
90
-	/**
91
-	 * Set the subject of the activity
92
-	 *
93
-	 * @param string $subject
94
-	 * @param array $parameters
95
-	 * @return IEvent
96
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
97
-	 * @since 8.2.0
98
-	 */
99
-	public function setSubject($subject, array $parameters = []);
100
-
101
-	/**
102
-	 * @param string $subject
103
-	 * @return $this
104
-	 * @throws \InvalidArgumentException if the subject is invalid
105
-	 * @since 11.0.0
106
-	 */
107
-	public function setParsedSubject($subject);
108
-
109
-	/**
110
-	 * @return string
111
-	 * @since 11.0.0
112
-	 */
113
-	public function getParsedSubject();
114
-
115
-	/**
116
-	 * @param string $subject
117
-	 * @param array $parameters
118
-	 * @return $this
119
-	 * @throws \InvalidArgumentException if the subject or parameters are invalid
120
-	 * @since 11.0.0
121
-	 */
122
-	public function setRichSubject($subject, array $parameters = []);
123
-
124
-	/**
125
-	 * @return string
126
-	 * @since 11.0.0
127
-	 */
128
-	public function getRichSubject();
129
-
130
-	/**
131
-	 * @return array[]
132
-	 * @since 11.0.0
133
-	 */
134
-	public function getRichSubjectParameters();
135
-
136
-	/**
137
-	 * Set the message of the activity
138
-	 *
139
-	 * @param string $message
140
-	 * @param array $parameters
141
-	 * @return IEvent
142
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
143
-	 * @since 8.2.0
144
-	 */
145
-	public function setMessage($message, array $parameters = []);
146
-
147
-	/**
148
-	 * @param string $message
149
-	 * @return $this
150
-	 * @throws \InvalidArgumentException if the message is invalid
151
-	 * @since 11.0.0
152
-	 */
153
-	public function setParsedMessage($message);
154
-
155
-	/**
156
-	 * @return string
157
-	 * @since 11.0.0
158
-	 */
159
-	public function getParsedMessage();
160
-
161
-	/**
162
-	 * @param string $message
163
-	 * @param array $parameters
164
-	 * @return $this
165
-	 * @throws \InvalidArgumentException if the message or parameters are invalid
166
-	 * @since 11.0.0
167
-	 */
168
-	public function setRichMessage($message, array $parameters = []);
169
-
170
-	/**
171
-	 * @return string
172
-	 * @since 11.0.0
173
-	 */
174
-	public function getRichMessage();
175
-
176
-	/**
177
-	 * @return array[]
178
-	 * @since 11.0.0
179
-	 */
180
-	public function getRichMessageParameters();
181
-
182
-	/**
183
-	 * Set the object of the activity
184
-	 *
185
-	 * @param string $objectType
186
-	 * @param int $objectId
187
-	 * @param string $objectName
188
-	 * @return IEvent
189
-	 * @throws \InvalidArgumentException if the object is invalid
190
-	 * @since 8.2.0
191
-	 */
192
-	public function setObject($objectType, $objectId, $objectName = '');
193
-
194
-	/**
195
-	 * Set the link of the activity
196
-	 *
197
-	 * @param string $link
198
-	 * @return IEvent
199
-	 * @throws \InvalidArgumentException if the link is invalid
200
-	 * @since 8.2.0
201
-	 */
202
-	public function setLink($link);
203
-
204
-	/**
205
-	 * @return string
206
-	 * @since 8.2.0
207
-	 */
208
-	public function getApp();
209
-
210
-	/**
211
-	 * @return string
212
-	 * @since 8.2.0
213
-	 */
214
-	public function getType();
215
-
216
-	/**
217
-	 * @return string
218
-	 * @since 8.2.0
219
-	 */
220
-	public function getAffectedUser();
221
-
222
-	/**
223
-	 * @return string
224
-	 * @since 8.2.0
225
-	 */
226
-	public function getAuthor();
227
-
228
-	/**
229
-	 * @return int
230
-	 * @since 8.2.0
231
-	 */
232
-	public function getTimestamp();
233
-
234
-	/**
235
-	 * @return string
236
-	 * @since 8.2.0
237
-	 */
238
-	public function getSubject();
239
-
240
-	/**
241
-	 * @return array
242
-	 * @since 8.2.0
243
-	 */
244
-	public function getSubjectParameters();
245
-
246
-	/**
247
-	 * @return string
248
-	 * @since 8.2.0
249
-	 */
250
-	public function getMessage();
251
-
252
-	/**
253
-	 * @return array
254
-	 * @since 8.2.0
255
-	 */
256
-	public function getMessageParameters();
257
-
258
-	/**
259
-	 * @return string
260
-	 * @since 8.2.0
261
-	 */
262
-	public function getObjectType();
263
-
264
-	/**
265
-	 * @return string
266
-	 * @since 8.2.0
267
-	 */
268
-	public function getObjectId();
269
-
270
-	/**
271
-	 * @return string
272
-	 * @since 8.2.0
273
-	 */
274
-	public function getObjectName();
275
-
276
-	/**
277
-	 * @return string
278
-	 * @since 8.2.0
279
-	 */
280
-	public function getLink();
281
-
282
-	/**
283
-	 * @param string $icon
284
-	 * @return $this
285
-	 * @throws \InvalidArgumentException if the icon is invalid
286
-	 * @since 11.0.0
287
-	 */
288
-	public function setIcon($icon);
289
-
290
-	/**
291
-	 * @return string
292
-	 * @since 11.0.0
293
-	 */
294
-	public function getIcon();
295
-
296
-	/**
297
-	 * @param IEvent $child
298
-	 * @since 11.0.0
299
-	 */
300
-	public function setChildEvent(IEvent $child);
301
-
302
-	/**
303
-	 * @return IEvent|null
304
-	 * @since 11.0.0
305
-	 */
306
-	public function getChildEvent();
307
-
308
-	/**
309
-	 * @return bool
310
-	 * @since 11.0.0
311
-	 */
312
-	public function isValid();
313
-
314
-	/**
315
-	 * @return bool
316
-	 * @since 11.0.0
317
-	 */
318
-	public function isValidParsed();
40
+    /**
41
+     * Set the app of the activity
42
+     *
43
+     * @param string $app
44
+     * @return IEvent
45
+     * @throws \InvalidArgumentException if the app id is invalid
46
+     * @since 8.2.0
47
+     */
48
+    public function setApp($app);
49
+
50
+    /**
51
+     * Set the type of the activity
52
+     *
53
+     * @param string $type
54
+     * @return IEvent
55
+     * @throws \InvalidArgumentException if the type is invalid
56
+     * @since 8.2.0
57
+     */
58
+    public function setType($type);
59
+
60
+    /**
61
+     * Set the affected user of the activity
62
+     *
63
+     * @param string $user
64
+     * @return IEvent
65
+     * @throws \InvalidArgumentException if the affected user is invalid
66
+     * @since 8.2.0
67
+     */
68
+    public function setAffectedUser($user);
69
+
70
+    /**
71
+     * Set the author of the activity
72
+     *
73
+     * @param string $author
74
+     * @return IEvent
75
+     * @throws \InvalidArgumentException if the author is invalid
76
+     * @since 8.2.0
77
+     */
78
+    public function setAuthor($author);
79
+
80
+    /**
81
+     * Set the author of the activity
82
+     *
83
+     * @param int $timestamp
84
+     * @return IEvent
85
+     * @throws \InvalidArgumentException if the timestamp is invalid
86
+     * @since 8.2.0
87
+     */
88
+    public function setTimestamp($timestamp);
89
+
90
+    /**
91
+     * Set the subject of the activity
92
+     *
93
+     * @param string $subject
94
+     * @param array $parameters
95
+     * @return IEvent
96
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
97
+     * @since 8.2.0
98
+     */
99
+    public function setSubject($subject, array $parameters = []);
100
+
101
+    /**
102
+     * @param string $subject
103
+     * @return $this
104
+     * @throws \InvalidArgumentException if the subject is invalid
105
+     * @since 11.0.0
106
+     */
107
+    public function setParsedSubject($subject);
108
+
109
+    /**
110
+     * @return string
111
+     * @since 11.0.0
112
+     */
113
+    public function getParsedSubject();
114
+
115
+    /**
116
+     * @param string $subject
117
+     * @param array $parameters
118
+     * @return $this
119
+     * @throws \InvalidArgumentException if the subject or parameters are invalid
120
+     * @since 11.0.0
121
+     */
122
+    public function setRichSubject($subject, array $parameters = []);
123
+
124
+    /**
125
+     * @return string
126
+     * @since 11.0.0
127
+     */
128
+    public function getRichSubject();
129
+
130
+    /**
131
+     * @return array[]
132
+     * @since 11.0.0
133
+     */
134
+    public function getRichSubjectParameters();
135
+
136
+    /**
137
+     * Set the message of the activity
138
+     *
139
+     * @param string $message
140
+     * @param array $parameters
141
+     * @return IEvent
142
+     * @throws \InvalidArgumentException if the message or parameters are invalid
143
+     * @since 8.2.0
144
+     */
145
+    public function setMessage($message, array $parameters = []);
146
+
147
+    /**
148
+     * @param string $message
149
+     * @return $this
150
+     * @throws \InvalidArgumentException if the message is invalid
151
+     * @since 11.0.0
152
+     */
153
+    public function setParsedMessage($message);
154
+
155
+    /**
156
+     * @return string
157
+     * @since 11.0.0
158
+     */
159
+    public function getParsedMessage();
160
+
161
+    /**
162
+     * @param string $message
163
+     * @param array $parameters
164
+     * @return $this
165
+     * @throws \InvalidArgumentException if the message or parameters are invalid
166
+     * @since 11.0.0
167
+     */
168
+    public function setRichMessage($message, array $parameters = []);
169
+
170
+    /**
171
+     * @return string
172
+     * @since 11.0.0
173
+     */
174
+    public function getRichMessage();
175
+
176
+    /**
177
+     * @return array[]
178
+     * @since 11.0.0
179
+     */
180
+    public function getRichMessageParameters();
181
+
182
+    /**
183
+     * Set the object of the activity
184
+     *
185
+     * @param string $objectType
186
+     * @param int $objectId
187
+     * @param string $objectName
188
+     * @return IEvent
189
+     * @throws \InvalidArgumentException if the object is invalid
190
+     * @since 8.2.0
191
+     */
192
+    public function setObject($objectType, $objectId, $objectName = '');
193
+
194
+    /**
195
+     * Set the link of the activity
196
+     *
197
+     * @param string $link
198
+     * @return IEvent
199
+     * @throws \InvalidArgumentException if the link is invalid
200
+     * @since 8.2.0
201
+     */
202
+    public function setLink($link);
203
+
204
+    /**
205
+     * @return string
206
+     * @since 8.2.0
207
+     */
208
+    public function getApp();
209
+
210
+    /**
211
+     * @return string
212
+     * @since 8.2.0
213
+     */
214
+    public function getType();
215
+
216
+    /**
217
+     * @return string
218
+     * @since 8.2.0
219
+     */
220
+    public function getAffectedUser();
221
+
222
+    /**
223
+     * @return string
224
+     * @since 8.2.0
225
+     */
226
+    public function getAuthor();
227
+
228
+    /**
229
+     * @return int
230
+     * @since 8.2.0
231
+     */
232
+    public function getTimestamp();
233
+
234
+    /**
235
+     * @return string
236
+     * @since 8.2.0
237
+     */
238
+    public function getSubject();
239
+
240
+    /**
241
+     * @return array
242
+     * @since 8.2.0
243
+     */
244
+    public function getSubjectParameters();
245
+
246
+    /**
247
+     * @return string
248
+     * @since 8.2.0
249
+     */
250
+    public function getMessage();
251
+
252
+    /**
253
+     * @return array
254
+     * @since 8.2.0
255
+     */
256
+    public function getMessageParameters();
257
+
258
+    /**
259
+     * @return string
260
+     * @since 8.2.0
261
+     */
262
+    public function getObjectType();
263
+
264
+    /**
265
+     * @return string
266
+     * @since 8.2.0
267
+     */
268
+    public function getObjectId();
269
+
270
+    /**
271
+     * @return string
272
+     * @since 8.2.0
273
+     */
274
+    public function getObjectName();
275
+
276
+    /**
277
+     * @return string
278
+     * @since 8.2.0
279
+     */
280
+    public function getLink();
281
+
282
+    /**
283
+     * @param string $icon
284
+     * @return $this
285
+     * @throws \InvalidArgumentException if the icon is invalid
286
+     * @since 11.0.0
287
+     */
288
+    public function setIcon($icon);
289
+
290
+    /**
291
+     * @return string
292
+     * @since 11.0.0
293
+     */
294
+    public function getIcon();
295
+
296
+    /**
297
+     * @param IEvent $child
298
+     * @since 11.0.0
299
+     */
300
+    public function setChildEvent(IEvent $child);
301
+
302
+    /**
303
+     * @return IEvent|null
304
+     * @since 11.0.0
305
+     */
306
+    public function getChildEvent();
307
+
308
+    /**
309
+     * @return bool
310
+     * @since 11.0.0
311
+     */
312
+    public function isValid();
313
+
314
+    /**
315
+     * @return bool
316
+     * @since 11.0.0
317
+     */
318
+    public function isValidParsed();
319 319
 }
Please login to merge, or discard this patch.
lib/public/Activity/IEventMerger.php 1 patch
Indentation   +30 added lines, -30 removed lines patch added patch discarded remove patch
@@ -30,35 +30,35 @@
 block discarded – undo
30 30
  */
31 31
 interface IEventMerger {
32 32
 
33
-	/**
34
-	 * Combines two events when possible to have grouping:
35
-	 *
36
-	 * Example1: Two events with subject '{user} created {file}' and
37
-	 * $mergeParameter file with different file and same user will be merged
38
-	 * to '{user} created {file1} and {file2}' and the childEvent on the return
39
-	 * will be set, if the events have been merged.
40
-	 *
41
-	 * Example2: Two events with subject '{user} created {file}' and
42
-	 * $mergeParameter file with same file and same user will be merged to
43
-	 * '{user} created {file1}' and the childEvent on the return will be set, if
44
-	 * the events have been merged.
45
-	 *
46
-	 * The following requirements have to be met, in order to be merged:
47
-	 * - Both events need to have the same `getApp()`
48
-	 * - Both events must not have a message `getMessage()`
49
-	 * - Both events need to have the same subject `getSubject()`
50
-	 * - Both events need to have the same object type `getObjectType()`
51
-	 * - The time difference between both events must not be bigger then 3 hours
52
-	 * - Only up to 5 events can be merged.
53
-	 * - All parameters apart from such starting with $mergeParameter must be
54
-	 *   the same for both events.
55
-	 *
56
-	 * @param string $mergeParameter
57
-	 * @param IEvent $event
58
-	 * @param IEvent|null $previousEvent
59
-	 * @return IEvent
60
-	 * @since 11.0
61
-	 */
62
-	public function mergeEvents($mergeParameter, IEvent $event, IEvent $previousEvent = null);
33
+    /**
34
+     * Combines two events when possible to have grouping:
35
+     *
36
+     * Example1: Two events with subject '{user} created {file}' and
37
+     * $mergeParameter file with different file and same user will be merged
38
+     * to '{user} created {file1} and {file2}' and the childEvent on the return
39
+     * will be set, if the events have been merged.
40
+     *
41
+     * Example2: Two events with subject '{user} created {file}' and
42
+     * $mergeParameter file with same file and same user will be merged to
43
+     * '{user} created {file1}' and the childEvent on the return will be set, if
44
+     * the events have been merged.
45
+     *
46
+     * The following requirements have to be met, in order to be merged:
47
+     * - Both events need to have the same `getApp()`
48
+     * - Both events must not have a message `getMessage()`
49
+     * - Both events need to have the same subject `getSubject()`
50
+     * - Both events need to have the same object type `getObjectType()`
51
+     * - The time difference between both events must not be bigger then 3 hours
52
+     * - Only up to 5 events can be merged.
53
+     * - All parameters apart from such starting with $mergeParameter must be
54
+     *   the same for both events.
55
+     *
56
+     * @param string $mergeParameter
57
+     * @param IEvent $event
58
+     * @param IEvent|null $previousEvent
59
+     * @return IEvent
60
+     * @since 11.0
61
+     */
62
+    public function mergeEvents($mergeParameter, IEvent $event, IEvent $previousEvent = null);
63 63
 
64 64
 }
Please login to merge, or discard this patch.
lib/public/Activity/ISetting.php 1 patch
Indentation   +37 added lines, -37 removed lines patch added patch discarded remove patch
@@ -29,48 +29,48 @@
 block discarded – undo
29 29
  */
30 30
 interface ISetting {
31 31
 
32
-	/**
33
-	 * @return string Lowercase a-z and underscore only identifier
34
-	 * @since 11.0.0
35
-	 */
36
-	public function getIdentifier();
32
+    /**
33
+     * @return string Lowercase a-z and underscore only identifier
34
+     * @since 11.0.0
35
+     */
36
+    public function getIdentifier();
37 37
 
38
-	/**
39
-	 * @return string A translated string
40
-	 * @since 11.0.0
41
-	 */
42
-	public function getName();
38
+    /**
39
+     * @return string A translated string
40
+     * @since 11.0.0
41
+     */
42
+    public function getName();
43 43
 
44
-	/**
45
-	 * @return int whether the filter should be rather on the top or bottom of
46
-	 * the admin section. The filters are arranged in ascending order of the
47
-	 * priority values. It is required to return a value between 0 and 100.
48
-	 * @since 11.0.0
49
-	 */
50
-	public function getPriority();
44
+    /**
45
+     * @return int whether the filter should be rather on the top or bottom of
46
+     * the admin section. The filters are arranged in ascending order of the
47
+     * priority values. It is required to return a value between 0 and 100.
48
+     * @since 11.0.0
49
+     */
50
+    public function getPriority();
51 51
 
52
-	/**
53
-	 * @return bool True when the option can be changed for the stream
54
-	 * @since 11.0.0
55
-	 */
56
-	public function canChangeStream();
52
+    /**
53
+     * @return bool True when the option can be changed for the stream
54
+     * @since 11.0.0
55
+     */
56
+    public function canChangeStream();
57 57
 
58
-	/**
59
-	 * @return bool True when the option can be changed for the stream
60
-	 * @since 11.0.0
61
-	 */
62
-	public function isDefaultEnabledStream();
58
+    /**
59
+     * @return bool True when the option can be changed for the stream
60
+     * @since 11.0.0
61
+     */
62
+    public function isDefaultEnabledStream();
63 63
 
64
-	/**
65
-	 * @return bool True when the option can be changed for the mail
66
-	 * @since 11.0.0
67
-	 */
68
-	public function canChangeMail();
64
+    /**
65
+     * @return bool True when the option can be changed for the mail
66
+     * @since 11.0.0
67
+     */
68
+    public function canChangeMail();
69 69
 
70
-	/**
71
-	 * @return bool True when the option can be changed for the stream
72
-	 * @since 11.0.0
73
-	 */
74
-	public function isDefaultEnabledMail();
70
+    /**
71
+     * @return bool True when the option can be changed for the stream
72
+     * @since 11.0.0
73
+     */
74
+    public function isDefaultEnabledMail();
75 75
 }
76 76
 
Please login to merge, or discard this patch.
lib/public/Activity/IProvider.php 1 patch
Indentation   +11 added lines, -11 removed lines patch added patch discarded remove patch
@@ -28,15 +28,15 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
lib/public/Activity/IConsumer.php 1 patch
Indentation   +7 added lines, -7 removed lines patch added patch discarded remove patch
@@ -38,12 +38,12 @@
 block discarded – undo
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
 
Please login to merge, or discard this patch.
lib/public/IMemcacheTTL.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -29,12 +29,12 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.
lib/public/IUserSession.php 1 patch
Indentation   +36 added lines, -36 removed lines patch added patch discarded remove patch
@@ -40,44 +40,44 @@
 block discarded – undo
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
 }
Please login to merge, or discard this patch.