Completed
Pull Request — master (#4617)
by Julius
14:00
created
lib/public/IHelper.php 1 patch
Indentation   +9 added lines, -9 removed lines patch added patch discarded remove patch
@@ -38,13 +38,13 @@
 block discarded – undo
38 38
  * @deprecated 8.1.0
39 39
  */
40 40
 interface IHelper {
41
-	/**
42
-	 * Gets the content of an URL by using CURL or a fallback if it is not
43
-	 * installed
44
-	 * @param string $url the url that should be fetched
45
-	 * @return string the content of the webpage
46
-	 * @since 6.0.0
47
-	 * @deprecated 8.1.0 Use \OCP\IServerContainer::getHTTPClientService
48
-	 */
49
-	public function getUrlContent($url);
41
+    /**
42
+     * Gets the content of an URL by using CURL or a fallback if it is not
43
+     * installed
44
+     * @param string $url the url that should be fetched
45
+     * @return string the content of the webpage
46
+     * @since 6.0.0
47
+     * @deprecated 8.1.0 Use \OCP\IServerContainer::getHTTPClientService
48
+     */
49
+    public function getUrlContent($url);
50 50
 }
Please login to merge, or discard this patch.
lib/public/ITagManager.php 1 patch
Indentation   +13 added lines, -13 removed lines patch added patch discarded remove patch
@@ -46,17 +46,17 @@
 block discarded – undo
46 46
  */
47 47
 interface ITagManager {
48 48
 
49
-	/**
50
-	 * Create a new \OCP\ITags instance and load tags from db for the current user.
51
-	 *
52
-	 * @see \OCP\ITags
53
-	 * @param string $type The type identifier e.g. 'contact' or 'event'.
54
-	 * @param array $defaultTags An array of default tags to be used if none are stored.
55
-	 * @param boolean $includeShared Whether to include tags for items shared with this user by others.
56
-	 * @param string $userId user for which to retrieve the tags, defaults to the currently
57
-	 * logged in user
58
-	 * @return \OCP\ITags
59
-	 * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0
60
-	*/
61
-	public function load($type, $defaultTags = array(), $includeShared = false, $userId = null);
49
+    /**
50
+     * Create a new \OCP\ITags instance and load tags from db for the current user.
51
+     *
52
+     * @see \OCP\ITags
53
+     * @param string $type The type identifier e.g. 'contact' or 'event'.
54
+     * @param array $defaultTags An array of default tags to be used if none are stored.
55
+     * @param boolean $includeShared Whether to include tags for items shared with this user by others.
56
+     * @param string $userId user for which to retrieve the tags, defaults to the currently
57
+     * logged in user
58
+     * @return \OCP\ITags
59
+     * @since 6.0.0 - parameter $includeShared and $userId were added in 8.0.0
60
+     */
61
+    public function load($type, $defaultTags = array(), $includeShared = false, $userId = null);
62 62
 }
Please login to merge, or discard this patch.
lib/public/Console/ConsoleEvent.php 1 patch
Indentation   +30 added lines, -30 removed lines patch added patch discarded remove patch
@@ -32,39 +32,39 @@
 block discarded – undo
32 32
  */
33 33
 class ConsoleEvent extends Event {
34 34
 
35
-	const EVENT_RUN = 'OC\Console\Application::run';
35
+    const EVENT_RUN = 'OC\Console\Application::run';
36 36
 
37
-	/** @var string */
38
-	protected $event;
37
+    /** @var string */
38
+    protected $event;
39 39
 
40
-	/** @var string[] */
41
-	protected $arguments;
40
+    /** @var string[] */
41
+    protected $arguments;
42 42
 
43
-	/**
44
-	 * DispatcherEvent constructor.
45
-	 *
46
-	 * @param string $event
47
-	 * @param string[] $arguments
48
-	 * @since 9.0.0
49
-	 */
50
-	public function __construct($event, array $arguments) {
51
-		$this->event = $event;
52
-		$this->arguments = $arguments;
53
-	}
43
+    /**
44
+     * DispatcherEvent constructor.
45
+     *
46
+     * @param string $event
47
+     * @param string[] $arguments
48
+     * @since 9.0.0
49
+     */
50
+    public function __construct($event, array $arguments) {
51
+        $this->event = $event;
52
+        $this->arguments = $arguments;
53
+    }
54 54
 
55
-	/**
56
-	 * @return string
57
-	 * @since 9.0.0
58
-	 */
59
-	public function getEvent() {
60
-		return $this->event;
61
-	}
55
+    /**
56
+     * @return string
57
+     * @since 9.0.0
58
+     */
59
+    public function getEvent() {
60
+        return $this->event;
61
+    }
62 62
 
63
-	/**
64
-	 * @return string[]
65
-	 * @since 9.0.0
66
-	 */
67
-	public function getArguments() {
68
-		return $this->arguments;
69
-	}
63
+    /**
64
+     * @return string[]
65
+     * @since 9.0.0
66
+     */
67
+    public function getArguments() {
68
+        return $this->arguments;
69
+    }
70 70
 }
Please login to merge, or discard this patch.
lib/public/IDBConnection.php 1 patch
Indentation   +193 added lines, -193 removed lines patch added patch discarded remove patch
@@ -43,220 +43,220 @@
 block discarded – undo
43 43
  * @since 6.0.0
44 44
  */
45 45
 interface IDBConnection {
46
-	/**
47
-	 * Gets the QueryBuilder for the connection.
48
-	 *
49
-	 * @return \OCP\DB\QueryBuilder\IQueryBuilder
50
-	 * @since 8.2.0
51
-	 */
52
-	public function getQueryBuilder();
46
+    /**
47
+     * Gets the QueryBuilder for the connection.
48
+     *
49
+     * @return \OCP\DB\QueryBuilder\IQueryBuilder
50
+     * @since 8.2.0
51
+     */
52
+    public function getQueryBuilder();
53 53
 
54
-	/**
55
-	 * Used to abstract the ownCloud database access away
56
-	 * @param string $sql the sql query with ? placeholder for params
57
-	 * @param int $limit the maximum number of rows
58
-	 * @param int $offset from which row we want to start
59
-	 * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
60
-	 * @since 6.0.0
61
-	 */
62
-	public function prepare($sql, $limit=null, $offset=null);
54
+    /**
55
+     * Used to abstract the ownCloud database access away
56
+     * @param string $sql the sql query with ? placeholder for params
57
+     * @param int $limit the maximum number of rows
58
+     * @param int $offset from which row we want to start
59
+     * @return \Doctrine\DBAL\Driver\Statement The prepared statement.
60
+     * @since 6.0.0
61
+     */
62
+    public function prepare($sql, $limit=null, $offset=null);
63 63
 
64
-	/**
65
-	 * Executes an, optionally parameterized, SQL query.
66
-	 *
67
-	 * If the query is parameterized, a prepared statement is used.
68
-	 * If an SQLLogger is configured, the execution is logged.
69
-	 *
70
-	 * @param string $query The SQL query to execute.
71
-	 * @param string[] $params The parameters to bind to the query, if any.
72
-	 * @param array $types The types the previous parameters are in.
73
-	 * @return \Doctrine\DBAL\Driver\Statement The executed statement.
74
-	 * @since 8.0.0
75
-	 */
76
-	public function executeQuery($query, array $params = array(), $types = array());
64
+    /**
65
+     * Executes an, optionally parameterized, SQL query.
66
+     *
67
+     * If the query is parameterized, a prepared statement is used.
68
+     * If an SQLLogger is configured, the execution is logged.
69
+     *
70
+     * @param string $query The SQL query to execute.
71
+     * @param string[] $params The parameters to bind to the query, if any.
72
+     * @param array $types The types the previous parameters are in.
73
+     * @return \Doctrine\DBAL\Driver\Statement The executed statement.
74
+     * @since 8.0.0
75
+     */
76
+    public function executeQuery($query, array $params = array(), $types = array());
77 77
 
78
-	/**
79
-	 * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
80
-	 * and returns the number of affected rows.
81
-	 *
82
-	 * This method supports PDO binding types as well as DBAL mapping types.
83
-	 *
84
-	 * @param string $query The SQL query.
85
-	 * @param array $params The query parameters.
86
-	 * @param array $types The parameter types.
87
-	 * @return integer The number of affected rows.
88
-	 * @since 8.0.0
89
-	 */
90
-	public function executeUpdate($query, array $params = array(), array $types = array());
78
+    /**
79
+     * Executes an SQL INSERT/UPDATE/DELETE query with the given parameters
80
+     * and returns the number of affected rows.
81
+     *
82
+     * This method supports PDO binding types as well as DBAL mapping types.
83
+     *
84
+     * @param string $query The SQL query.
85
+     * @param array $params The query parameters.
86
+     * @param array $types The parameter types.
87
+     * @return integer The number of affected rows.
88
+     * @since 8.0.0
89
+     */
90
+    public function executeUpdate($query, array $params = array(), array $types = array());
91 91
 
92
-	/**
93
-	 * Used to get the id of the just inserted element
94
-	 * @param string $table the name of the table where we inserted the item
95
-	 * @return int the id of the inserted element
96
-	 * @since 6.0.0
97
-	 */
98
-	public function lastInsertId($table = null);
92
+    /**
93
+     * Used to get the id of the just inserted element
94
+     * @param string $table the name of the table where we inserted the item
95
+     * @return int the id of the inserted element
96
+     * @since 6.0.0
97
+     */
98
+    public function lastInsertId($table = null);
99 99
 
100
-	/**
101
-	 * Insert a row if the matching row does not exists.
102
-	 *
103
-	 * @param string $table The table name (will replace *PREFIX* with the actual prefix)
104
-	 * @param array $input data that should be inserted into the table  (column name => value)
105
-	 * @param array|null $compare List of values that should be checked for "if not exists"
106
-	 *				If this is null or an empty array, all keys of $input will be compared
107
-	 *				Please note: text fields (clob) must not be used in the compare array
108
-	 * @return int number of inserted rows
109
-	 * @throws \Doctrine\DBAL\DBALException
110
-	 * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0
111
-	 */
112
-	public function insertIfNotExist($table, $input, array $compare = null);
100
+    /**
101
+     * Insert a row if the matching row does not exists.
102
+     *
103
+     * @param string $table The table name (will replace *PREFIX* with the actual prefix)
104
+     * @param array $input data that should be inserted into the table  (column name => value)
105
+     * @param array|null $compare List of values that should be checked for "if not exists"
106
+     *				If this is null or an empty array, all keys of $input will be compared
107
+     *				Please note: text fields (clob) must not be used in the compare array
108
+     * @return int number of inserted rows
109
+     * @throws \Doctrine\DBAL\DBALException
110
+     * @since 6.0.0 - parameter $compare was added in 8.1.0, return type changed from boolean in 8.1.0
111
+     */
112
+    public function insertIfNotExist($table, $input, array $compare = null);
113 113
 
114
-	/**
115
-	 * Insert or update a row value
116
-	 *
117
-	 * @param string $table
118
-	 * @param array $keys (column name => value)
119
-	 * @param array $values (column name => value)
120
-	 * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
121
-	 * @return int number of new rows
122
-	 * @throws \Doctrine\DBAL\DBALException
123
-	 * @throws PreconditionNotMetException
124
-	 * @since 9.0.0
125
-	 */
126
-	public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []);
114
+    /**
115
+     * Insert or update a row value
116
+     *
117
+     * @param string $table
118
+     * @param array $keys (column name => value)
119
+     * @param array $values (column name => value)
120
+     * @param array $updatePreconditionValues ensure values match preconditions (column name => value)
121
+     * @return int number of new rows
122
+     * @throws \Doctrine\DBAL\DBALException
123
+     * @throws PreconditionNotMetException
124
+     * @since 9.0.0
125
+     */
126
+    public function setValues($table, array $keys, array $values, array $updatePreconditionValues = []);
127 127
 
128
-	/**
129
-	 * Create an exclusive read+write lock on a table
130
-	 *
131
-	 * Important Note: Due to the nature how locks work on different DBs, it is
132
-	 * only possible to lock one table at a time. You should also NOT start a
133
-	 * transaction while holding a lock.
134
-	 *
135
-	 * @param string $tableName
136
-	 * @since 9.1.0
137
-	 */
138
-	public function lockTable($tableName);
128
+    /**
129
+     * Create an exclusive read+write lock on a table
130
+     *
131
+     * Important Note: Due to the nature how locks work on different DBs, it is
132
+     * only possible to lock one table at a time. You should also NOT start a
133
+     * transaction while holding a lock.
134
+     *
135
+     * @param string $tableName
136
+     * @since 9.1.0
137
+     */
138
+    public function lockTable($tableName);
139 139
 
140
-	/**
141
-	 * Release a previous acquired lock again
142
-	 *
143
-	 * @since 9.1.0
144
-	 */
145
-	public function unlockTable();
140
+    /**
141
+     * Release a previous acquired lock again
142
+     *
143
+     * @since 9.1.0
144
+     */
145
+    public function unlockTable();
146 146
 
147
-	/**
148
-	 * Start a transaction
149
-	 * @since 6.0.0
150
-	 */
151
-	public function beginTransaction();
147
+    /**
148
+     * Start a transaction
149
+     * @since 6.0.0
150
+     */
151
+    public function beginTransaction();
152 152
 
153
-	/**
154
-	 * Check if a transaction is active
155
-	 *
156
-	 * @return bool
157
-	 * @since 8.2.0
158
-	 */
159
-	public function inTransaction();
153
+    /**
154
+     * Check if a transaction is active
155
+     *
156
+     * @return bool
157
+     * @since 8.2.0
158
+     */
159
+    public function inTransaction();
160 160
 
161
-	/**
162
-	 * Commit the database changes done during a transaction that is in progress
163
-	 * @since 6.0.0
164
-	 */
165
-	public function commit();
161
+    /**
162
+     * Commit the database changes done during a transaction that is in progress
163
+     * @since 6.0.0
164
+     */
165
+    public function commit();
166 166
 
167
-	/**
168
-	 * Rollback the database changes done during a transaction that is in progress
169
-	 * @since 6.0.0
170
-	 */
171
-	public function rollBack();
167
+    /**
168
+     * Rollback the database changes done during a transaction that is in progress
169
+     * @since 6.0.0
170
+     */
171
+    public function rollBack();
172 172
 
173
-	/**
174
-	 * Gets the error code and message as a string for logging
175
-	 * @return string
176
-	 * @since 6.0.0
177
-	 */
178
-	public function getError();
173
+    /**
174
+     * Gets the error code and message as a string for logging
175
+     * @return string
176
+     * @since 6.0.0
177
+     */
178
+    public function getError();
179 179
 
180
-	/**
181
-	 * Fetch the SQLSTATE associated with the last database operation.
182
-	 *
183
-	 * @return integer The last error code.
184
-	 * @since 8.0.0
185
-	 */
186
-	public function errorCode();
180
+    /**
181
+     * Fetch the SQLSTATE associated with the last database operation.
182
+     *
183
+     * @return integer The last error code.
184
+     * @since 8.0.0
185
+     */
186
+    public function errorCode();
187 187
 
188
-	/**
189
-	 * Fetch extended error information associated with the last database operation.
190
-	 *
191
-	 * @return array The last error information.
192
-	 * @since 8.0.0
193
-	 */
194
-	public function errorInfo();
188
+    /**
189
+     * Fetch extended error information associated with the last database operation.
190
+     *
191
+     * @return array The last error information.
192
+     * @since 8.0.0
193
+     */
194
+    public function errorInfo();
195 195
 
196
-	/**
197
-	 * Establishes the connection with the database.
198
-	 *
199
-	 * @return bool
200
-	 * @since 8.0.0
201
-	 */
202
-	public function connect();
196
+    /**
197
+     * Establishes the connection with the database.
198
+     *
199
+     * @return bool
200
+     * @since 8.0.0
201
+     */
202
+    public function connect();
203 203
 
204
-	/**
205
-	 * Close the database connection
206
-	 * @since 8.0.0
207
-	 */
208
-	public function close();
204
+    /**
205
+     * Close the database connection
206
+     * @since 8.0.0
207
+     */
208
+    public function close();
209 209
 
210
-	/**
211
-	 * Quotes a given input parameter.
212
-	 *
213
-	 * @param mixed $input Parameter to be quoted.
214
-	 * @param int $type Type of the parameter.
215
-	 * @return string The quoted parameter.
216
-	 * @since 8.0.0
217
-	 */
218
-	public function quote($input, $type = IQueryBuilder::PARAM_STR);
210
+    /**
211
+     * Quotes a given input parameter.
212
+     *
213
+     * @param mixed $input Parameter to be quoted.
214
+     * @param int $type Type of the parameter.
215
+     * @return string The quoted parameter.
216
+     * @since 8.0.0
217
+     */
218
+    public function quote($input, $type = IQueryBuilder::PARAM_STR);
219 219
 
220
-	/**
221
-	 * Gets the DatabasePlatform instance that provides all the metadata about
222
-	 * the platform this driver connects to.
223
-	 *
224
-	 * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
225
-	 * @since 8.0.0
226
-	 */
227
-	public function getDatabasePlatform();
220
+    /**
221
+     * Gets the DatabasePlatform instance that provides all the metadata about
222
+     * the platform this driver connects to.
223
+     *
224
+     * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
225
+     * @since 8.0.0
226
+     */
227
+    public function getDatabasePlatform();
228 228
 
229
-	/**
230
-	 * Drop a table from the database if it exists
231
-	 *
232
-	 * @param string $table table name without the prefix
233
-	 * @since 8.0.0
234
-	 */
235
-	public function dropTable($table);
229
+    /**
230
+     * Drop a table from the database if it exists
231
+     *
232
+     * @param string $table table name without the prefix
233
+     * @since 8.0.0
234
+     */
235
+    public function dropTable($table);
236 236
 
237
-	/**
238
-	 * Check if a table exists
239
-	 *
240
-	 * @param string $table table name without the prefix
241
-	 * @return bool
242
-	 * @since 8.0.0
243
-	 */
244
-	public function tableExists($table);
237
+    /**
238
+     * Check if a table exists
239
+     *
240
+     * @param string $table table name without the prefix
241
+     * @return bool
242
+     * @since 8.0.0
243
+     */
244
+    public function tableExists($table);
245 245
 
246
-	/**
247
-	 * Escape a parameter to be used in a LIKE query
248
-	 *
249
-	 * @param string $param
250
-	 * @return string
251
-	 * @since 9.0.0
252
-	 */
253
-	public function escapeLikeParameter($param);
246
+    /**
247
+     * Escape a parameter to be used in a LIKE query
248
+     *
249
+     * @param string $param
250
+     * @return string
251
+     * @since 9.0.0
252
+     */
253
+    public function escapeLikeParameter($param);
254 254
 
255
-	/**
256
-	 * Check whether or not the current database support 4byte wide unicode
257
-	 *
258
-	 * @return bool
259
-	 * @since 11.0.0
260
-	 */
261
-	public function supports4ByteText();
255
+    /**
256
+     * Check whether or not the current database support 4byte wide unicode
257
+     *
258
+     * @return bool
259
+     * @since 11.0.0
260
+     */
261
+    public function supports4ByteText();
262 262
 }
Please login to merge, or discard this patch.
lib/public/Activity/IExtension.php 1 patch
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.
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/IManager.php 1 patch
Indentation   +219 added lines, -219 removed lines patch added patch discarded remove patch
@@ -39,250 +39,250 @@
 block discarded – undo
39 39
  * @since 6.0.0
40 40
  */
41 41
 interface IManager {
42
-	/**
43
-	 * Generates a new IEvent object
44
-	 *
45
-	 * Make sure to call at least the following methods before sending it to the
46
-	 * app with via the publish() method:
47
-	 *  - setApp()
48
-	 *  - setType()
49
-	 *  - setAffectedUser()
50
-	 *  - setSubject()
51
-	 *
52
-	 * @return IEvent
53
-	 * @since 8.2.0
54
-	 */
55
-	public function generateEvent();
42
+    /**
43
+     * Generates a new IEvent object
44
+     *
45
+     * Make sure to call at least the following methods before sending it to the
46
+     * app with via the publish() method:
47
+     *  - setApp()
48
+     *  - setType()
49
+     *  - setAffectedUser()
50
+     *  - setSubject()
51
+     *
52
+     * @return IEvent
53
+     * @since 8.2.0
54
+     */
55
+    public function generateEvent();
56 56
 
57
-	/**
58
-	 * Publish an event to the activity consumers
59
-	 *
60
-	 * Make sure to call at least the following methods before sending an Event:
61
-	 *  - setApp()
62
-	 *  - setType()
63
-	 *  - setAffectedUser()
64
-	 *  - setSubject()
65
-	 *
66
-	 * @param IEvent $event
67
-	 * @throws \BadMethodCallException if required values have not been set
68
-	 * @since 8.2.0
69
-	 */
70
-	public function publish(IEvent $event);
57
+    /**
58
+     * Publish an event to the activity consumers
59
+     *
60
+     * Make sure to call at least the following methods before sending an Event:
61
+     *  - setApp()
62
+     *  - setType()
63
+     *  - setAffectedUser()
64
+     *  - setSubject()
65
+     *
66
+     * @param IEvent $event
67
+     * @throws \BadMethodCallException if required values have not been set
68
+     * @since 8.2.0
69
+     */
70
+    public function publish(IEvent $event);
71 71
 
72
-	/**
73
-	 * @param string $app           The app where this event is associated with
74
-	 * @param string $subject       A short description of the event
75
-	 * @param array  $subjectParams Array with parameters that are filled in the subject
76
-	 * @param string $message       A longer description of the event
77
-	 * @param array  $messageParams Array with parameters that are filled in the message
78
-	 * @param string $file          The file including path where this event is associated with
79
-	 * @param string $link          A link where this event is associated with
80
-	 * @param string $affectedUser  Recipient of the activity
81
-	 * @param string $type          Type of the notification
82
-	 * @param int    $priority      Priority of the notification
83
-	 * @since 6.0.0
84
-	 * @deprecated 8.2.0 Grab an IEvent from generateEvent() instead and use the publish() method
85
-	 */
86
-	public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority);
72
+    /**
73
+     * @param string $app           The app where this event is associated with
74
+     * @param string $subject       A short description of the event
75
+     * @param array  $subjectParams Array with parameters that are filled in the subject
76
+     * @param string $message       A longer description of the event
77
+     * @param array  $messageParams Array with parameters that are filled in the message
78
+     * @param string $file          The file including path where this event is associated with
79
+     * @param string $link          A link where this event is associated with
80
+     * @param string $affectedUser  Recipient of the activity
81
+     * @param string $type          Type of the notification
82
+     * @param int    $priority      Priority of the notification
83
+     * @since 6.0.0
84
+     * @deprecated 8.2.0 Grab an IEvent from generateEvent() instead and use the publish() method
85
+     */
86
+    public function publishActivity($app, $subject, $subjectParams, $message, $messageParams, $file, $link, $affectedUser, $type, $priority);
87 87
 
88
-	/**
89
-	 * In order to improve lazy loading a closure can be registered which will be called in case
90
-	 * activity consumers are actually requested
91
-	 *
92
-	 * $callable has to return an instance of \OCP\Activity\IConsumer
93
-	 *
94
-	 * @param \Closure $callable
95
-	 * @return void
96
-	 * @since 6.0.0
97
-	 */
98
-	public function registerConsumer(\Closure $callable);
88
+    /**
89
+     * In order to improve lazy loading a closure can be registered which will be called in case
90
+     * activity consumers are actually requested
91
+     *
92
+     * $callable has to return an instance of \OCP\Activity\IConsumer
93
+     *
94
+     * @param \Closure $callable
95
+     * @return void
96
+     * @since 6.0.0
97
+     */
98
+    public function registerConsumer(\Closure $callable);
99 99
 
100
-	/**
101
-	 * In order to improve lazy loading a closure can be registered which will be called in case
102
-	 * activity consumers are actually requested
103
-	 *
104
-	 * $callable has to return an instance of \OCP\Activity\IExtension
105
-	 *
106
-	 * @param \Closure $callable
107
-	 * @return void
108
-	 * @since 8.0.0
109
-	 */
110
-	public function registerExtension(\Closure $callable);
100
+    /**
101
+     * In order to improve lazy loading a closure can be registered which will be called in case
102
+     * activity consumers are actually requested
103
+     *
104
+     * $callable has to return an instance of \OCP\Activity\IExtension
105
+     *
106
+     * @param \Closure $callable
107
+     * @return void
108
+     * @since 8.0.0
109
+     */
110
+    public function registerExtension(\Closure $callable);
111 111
 
112
-	/**
113
-	 * @param string $filter Class must implement OCA\Activity\IFilter
114
-	 * @return void
115
-	 * @since 11.0.0
116
-	 */
117
-	public function registerFilter($filter);
112
+    /**
113
+     * @param string $filter Class must implement OCA\Activity\IFilter
114
+     * @return void
115
+     * @since 11.0.0
116
+     */
117
+    public function registerFilter($filter);
118 118
 
119
-	/**
120
-	 * @return IFilter[]
121
-	 * @since 11.0.0
122
-	 */
123
-	public function getFilters();
119
+    /**
120
+     * @return IFilter[]
121
+     * @since 11.0.0
122
+     */
123
+    public function getFilters();
124 124
 
125
-	/**
126
-	 * @param string $id
127
-	 * @return IFilter
128
-	 * @throws \InvalidArgumentException when the filter was not found
129
-	 * @since 11.0.0
130
-	 */
131
-	public function getFilterById($id);
125
+    /**
126
+     * @param string $id
127
+     * @return IFilter
128
+     * @throws \InvalidArgumentException when the filter was not found
129
+     * @since 11.0.0
130
+     */
131
+    public function getFilterById($id);
132 132
 
133
-	/**
134
-	 * @param string $setting Class must implement OCA\Activity\ISetting
135
-	 * @return void
136
-	 * @since 11.0.0
137
-	 */
138
-	public function registerSetting($setting);
133
+    /**
134
+     * @param string $setting Class must implement OCA\Activity\ISetting
135
+     * @return void
136
+     * @since 11.0.0
137
+     */
138
+    public function registerSetting($setting);
139 139
 
140
-	/**
141
-	 * @return ISetting[]
142
-	 * @since 11.0.0
143
-	 */
144
-	public function getSettings();
140
+    /**
141
+     * @return ISetting[]
142
+     * @since 11.0.0
143
+     */
144
+    public function getSettings();
145 145
 
146
-	/**
147
-	 * @param string $provider Class must implement OCA\Activity\IProvider
148
-	 * @return void
149
-	 * @since 11.0.0
150
-	 */
151
-	public function registerProvider($provider);
146
+    /**
147
+     * @param string $provider Class must implement OCA\Activity\IProvider
148
+     * @return void
149
+     * @since 11.0.0
150
+     */
151
+    public function registerProvider($provider);
152 152
 
153
-	/**
154
-	 * @return IProvider[]
155
-	 * @since 11.0.0
156
-	 */
157
-	public function getProviders();
153
+    /**
154
+     * @return IProvider[]
155
+     * @since 11.0.0
156
+     */
157
+    public function getProviders();
158 158
 
159
-	/**
160
-	 * @param string $id
161
-	 * @return ISetting
162
-	 * @throws \InvalidArgumentException when the setting was not found
163
-	 * @since 11.0.0
164
-	 */
165
-	public function getSettingById($id);
159
+    /**
160
+     * @param string $id
161
+     * @return ISetting
162
+     * @throws \InvalidArgumentException when the setting was not found
163
+     * @since 11.0.0
164
+     */
165
+    public function getSettingById($id);
166 166
 
167
-	/**
168
-	 * Will return additional notification types as specified by other apps
169
-	 *
170
-	 * @param string $languageCode
171
-	 * @return array Array "stringID of the type" => "translated string description for the setting"
172
-	 * 				or Array "stringID of the type" => [
173
-	 * 					'desc' => "translated string description for the setting"
174
-	 * 					'methods' => [\OCP\Activity\IExtension::METHOD_*],
175
-	 * 				]
176
-	 * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
177
-	 * @deprecated 11.0.0 - Use getSettings() instead
178
-	 */
179
-	public function getNotificationTypes($languageCode);
167
+    /**
168
+     * Will return additional notification types as specified by other apps
169
+     *
170
+     * @param string $languageCode
171
+     * @return array Array "stringID of the type" => "translated string description for the setting"
172
+     * 				or Array "stringID of the type" => [
173
+     * 					'desc' => "translated string description for the setting"
174
+     * 					'methods' => [\OCP\Activity\IExtension::METHOD_*],
175
+     * 				]
176
+     * @since 8.0.0 - 8.2.0: Added support to allow limiting notifications to certain methods
177
+     * @deprecated 11.0.0 - Use getSettings() instead
178
+     */
179
+    public function getNotificationTypes($languageCode);
180 180
 
181
-	/**
182
-	 * @param string $method
183
-	 * @return array
184
-	 * @since 8.0.0
185
-	 * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
186
-	 */
187
-	public function getDefaultTypes($method);
181
+    /**
182
+     * @param string $method
183
+     * @return array
184
+     * @since 8.0.0
185
+     * @deprecated 11.0.0 - Use getSettings()->isDefaulEnabled<method>() instead
186
+     */
187
+    public function getDefaultTypes($method);
188 188
 
189
-	/**
190
-	 * @param string $type
191
-	 * @return string
192
-	 * @since 8.0.0
193
-	 */
194
-	public function getTypeIcon($type);
189
+    /**
190
+     * @param string $type
191
+     * @return string
192
+     * @since 8.0.0
193
+     */
194
+    public function getTypeIcon($type);
195 195
 
196
-	/**
197
-	 * @param string $type
198
-	 * @param int $id
199
-	 * @since 8.2.0
200
-	 */
201
-	public function setFormattingObject($type, $id);
196
+    /**
197
+     * @param string $type
198
+     * @param int $id
199
+     * @since 8.2.0
200
+     */
201
+    public function setFormattingObject($type, $id);
202 202
 
203
-	/**
204
-	 * @return bool
205
-	 * @since 8.2.0
206
-	 */
207
-	public function isFormattingFilteredObject();
203
+    /**
204
+     * @return bool
205
+     * @since 8.2.0
206
+     */
207
+    public function isFormattingFilteredObject();
208 208
 
209
-	/**
210
-	 * @param string $app
211
-	 * @param string $text
212
-	 * @param array $params
213
-	 * @param boolean $stripPath
214
-	 * @param boolean $highlightParams
215
-	 * @param string $languageCode
216
-	 * @return string|false
217
-	 * @since 8.0.0
218
-	 */
219
-	public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
209
+    /**
210
+     * @param string $app
211
+     * @param string $text
212
+     * @param array $params
213
+     * @param boolean $stripPath
214
+     * @param boolean $highlightParams
215
+     * @param string $languageCode
216
+     * @return string|false
217
+     * @since 8.0.0
218
+     */
219
+    public function translate($app, $text, $params, $stripPath, $highlightParams, $languageCode);
220 220
 
221
-	/**
222
-	 * @param string $app
223
-	 * @param string $text
224
-	 * @return array|false
225
-	 * @since 8.0.0
226
-	 */
227
-	public function getSpecialParameterList($app, $text);
221
+    /**
222
+     * @param string $app
223
+     * @param string $text
224
+     * @return array|false
225
+     * @since 8.0.0
226
+     */
227
+    public function getSpecialParameterList($app, $text);
228 228
 
229
-	/**
230
-	 * @param array $activity
231
-	 * @return integer|false
232
-	 * @since 8.0.0
233
-	 */
234
-	public function getGroupParameter($activity);
229
+    /**
230
+     * @param array $activity
231
+     * @return integer|false
232
+     * @since 8.0.0
233
+     */
234
+    public function getGroupParameter($activity);
235 235
 
236 236
 
237
-	/**
238
-	 * Set the user we need to use
239
-	 *
240
-	 * @param string|null $currentUserId
241
-	 * @throws \UnexpectedValueException If the user is invalid
242
-	 * @since 9.0.1
243
-	 */
244
-	public function setCurrentUserId($currentUserId);
237
+    /**
238
+     * Set the user we need to use
239
+     *
240
+     * @param string|null $currentUserId
241
+     * @throws \UnexpectedValueException If the user is invalid
242
+     * @since 9.0.1
243
+     */
244
+    public function setCurrentUserId($currentUserId);
245 245
 
246
-	/**
247
-	 * Get the user we need to use
248
-	 *
249
-	 * Either the user is logged in, or we try to get it from the token
250
-	 *
251
-	 * @return string
252
-	 * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
253
-	 * @since 8.1.0
254
-	 */
255
-	public function getCurrentUserId();
246
+    /**
247
+     * Get the user we need to use
248
+     *
249
+     * Either the user is logged in, or we try to get it from the token
250
+     *
251
+     * @return string
252
+     * @throws \UnexpectedValueException If the token is invalid, does not exist or is not unique
253
+     * @since 8.1.0
254
+     */
255
+    public function getCurrentUserId();
256 256
 
257
-	/**
258
-	 * @return array
259
-	 * @since 8.0.0
260
-	 * @deprecated 11.0.0 - Use getFilters() instead
261
-	 */
262
-	public function getNavigation();
257
+    /**
258
+     * @return array
259
+     * @since 8.0.0
260
+     * @deprecated 11.0.0 - Use getFilters() instead
261
+     */
262
+    public function getNavigation();
263 263
 
264
-	/**
265
-	 * @param string $filterValue
266
-	 * @return boolean
267
-	 * @since 8.0.0
268
-	 * @deprecated 11.0.0 - Use getFilterById() instead
269
-	 */
270
-	public function isFilterValid($filterValue);
264
+    /**
265
+     * @param string $filterValue
266
+     * @return boolean
267
+     * @since 8.0.0
268
+     * @deprecated 11.0.0 - Use getFilterById() instead
269
+     */
270
+    public function isFilterValid($filterValue);
271 271
 
272
-	/**
273
-	 * @param array $types
274
-	 * @param string $filter
275
-	 * @return array
276
-	 * @since 8.0.0
277
-	 * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
278
-	 */
279
-	public function filterNotificationTypes($types, $filter);
272
+    /**
273
+     * @param array $types
274
+     * @param string $filter
275
+     * @return array
276
+     * @since 8.0.0
277
+     * @deprecated 11.0.0 - Use getFilterById()->filterTypes() instead
278
+     */
279
+    public function filterNotificationTypes($types, $filter);
280 280
 
281
-	/**
282
-	 * @param string $filter
283
-	 * @return array
284
-	 * @since 8.0.0
285
-	 * @deprecated 11.0.0 - Use getFilterById() instead
286
-	 */
287
-	public function getQueryForFilter($filter);
281
+    /**
282
+     * @param string $filter
283
+     * @return array
284
+     * @since 8.0.0
285
+     * @deprecated 11.0.0 - Use getFilterById() instead
286
+     */
287
+    public function getQueryForFilter($filter);
288 288
 }
Please login to merge, or discard this patch.