Passed
Push — master ( 514058...47cc5a )
by John
16:30 queued 03:00
created
lib/public/Collaboration/Resources/IProvider.php 1 patch
Indentation   +24 added lines, -24 removed lines patch added patch discarded remove patch
@@ -29,31 +29,31 @@
 block discarded – undo
29 29
  */
30 30
 interface IProvider {
31 31
 
32
-	/**
33
-	 * Get the resource type of the provider
34
-	 *
35
-	 * @return string
36
-	 * @since 16.0.0
37
-	 */
38
-	public function getType(): string;
32
+    /**
33
+     * Get the resource type of the provider
34
+     *
35
+     * @return string
36
+     * @since 16.0.0
37
+     */
38
+    public function getType(): string;
39 39
 
40
-	/**
41
-	 * Get the rich object data of a resource
42
-	 *
43
-	 * @param IResource $resource
44
-	 * @return array
45
-	 * @since 16.0.0
46
-	 */
47
-	public function getResourceRichObject(IResource $resource): array;
40
+    /**
41
+     * Get the rich object data of a resource
42
+     *
43
+     * @param IResource $resource
44
+     * @return array
45
+     * @since 16.0.0
46
+     */
47
+    public function getResourceRichObject(IResource $resource): array;
48 48
 
49
-	/**
50
-	 * Can a user/guest access the collection
51
-	 *
52
-	 * @param IResource $resource
53
-	 * @param IUser|null $user
54
-	 * @return bool
55
-	 * @since 16.0.0
56
-	 */
57
-	public function canAccessResource(IResource $resource, ?IUser $user): bool;
49
+    /**
50
+     * Can a user/guest access the collection
51
+     *
52
+     * @param IResource $resource
53
+     * @param IUser|null $user
54
+     * @return bool
55
+     * @since 16.0.0
56
+     */
57
+    public function canAccessResource(IResource $resource, ?IUser $user): bool;
58 58
 
59 59
 }
Please login to merge, or discard this patch.
core/Controller/CollaborationResourcesController.php 1 patch
Indentation   +252 added lines, -252 removed lines patch added patch discarded remove patch
@@ -37,256 +37,256 @@
 block discarded – undo
37 37
 
38 38
 class CollaborationResourcesController extends OCSController {
39 39
 
40
-	/** @var IManager */
41
-	private $manager;
42
-	/** @var IUserSession */
43
-	private $userSession;
44
-	/** @var ILogger */
45
-	private $logger;
46
-
47
-	public function __construct(
48
-		string $appName,
49
-		IRequest $request,
50
-		IManager $manager,
51
-		IUserSession $userSession,
52
-		ILogger $logger
53
-	) {
54
-		parent::__construct($appName, $request);
55
-
56
-		$this->manager = $manager;
57
-		$this->userSession = $userSession;
58
-		$this->logger = $logger;
59
-	}
60
-
61
-	/**
62
-	 * @param int $collectionId
63
-	 * @return ICollection
64
-	 * @throws CollectionException when the collection was not found for the user
65
-	 */
66
-	protected function getCollection(int $collectionId): ICollection {
67
-		$collection = $this->manager->getCollectionForUser($collectionId, $this->userSession->getUser());
68
-
69
-		if (!$collection->canAccess($this->userSession->getUser())) {
70
-			throw new CollectionException('Not found');
71
-		}
72
-
73
-		return $collection;
74
-	}
75
-
76
-	/**
77
-	 * @NoAdminRequired
78
-	 *
79
-	 * @param int $collectionId
80
-	 * @return DataResponse
81
-	 */
82
-	public function listCollection(int $collectionId): DataResponse {
83
-		try {
84
-			$collection = $this->getCollection($collectionId);
85
-		} catch (CollectionException $e) {
86
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
87
-		}
88
-
89
-		return $this->respondCollection($collection);
90
-	}
91
-
92
-	/**
93
-	 * @NoAdminRequired
94
-	 *
95
-	 * @param string $filter
96
-	 * @return DataResponse
97
-	 */
98
-	public function searchCollections(string $filter): DataResponse {
99
-		try {
100
-			$collections = $this->manager->searchCollections($this->userSession->getUser(), $filter);
101
-		} catch (CollectionException $e) {
102
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
103
-		}
104
-
105
-		return new DataResponse($this->prepareCollections($collections));
106
-	}
107
-
108
-	/**
109
-	 * @NoAdminRequired
110
-	 *
111
-	 * @param int $collectionId
112
-	 * @param string $resourceType
113
-	 * @param string $resourceId
114
-	 * @return DataResponse
115
-	 */
116
-	public function addResource(int $collectionId, string $resourceType, string $resourceId): DataResponse {
117
-		try {
118
-			$collection = $this->getCollection($collectionId);
119
-		} catch (CollectionException $e) {
120
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
121
-		}
122
-
123
-		$resource = $this->manager->createResource($resourceType, $resourceId);
124
-
125
-		if (!$resource->canAccess($this->userSession->getUser())) {
126
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
127
-		}
128
-
129
-		try {
130
-			$collection->addResource($resource);
131
-		} catch (ResourceException $e) {
132
-		}
133
-
134
-		return $this->respondCollection($collection);
135
-	}
136
-
137
-	/**
138
-	 * @NoAdminRequired
139
-	 *
140
-	 * @param int $collectionId
141
-	 * @param string $resourceType
142
-	 * @param string $resourceId
143
-	 * @return DataResponse
144
-	 */
145
-	public function removeResource(int $collectionId, string $resourceType, string $resourceId): DataResponse {
146
-		try {
147
-			$collection = $this->getCollection($collectionId);
148
-		} catch (CollectionException $e) {
149
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
150
-		}
151
-
152
-		try {
153
-			$resource = $this->manager->getResourceForUser($resourceType, $resourceId, $this->userSession->getUser());
154
-		} catch (CollectionException $e) {
155
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
156
-		}
157
-
158
-		$collection->removeResource($resource);
159
-
160
-		return $this->respondCollection($collection);
161
-	}
162
-
163
-	/**
164
-	 * @NoAdminRequired
165
-	 *
166
-	 * @param string $resourceType
167
-	 * @param string $resourceId
168
-	 * @return DataResponse
169
-	 */
170
-	public function getCollectionsByResource(string $resourceType, string $resourceId): DataResponse {
171
-		try {
172
-			$resource = $this->manager->getResourceForUser($resourceType, $resourceId, $this->userSession->getUser());
173
-		} catch (ResourceException $e) {
174
-			$resource = $this->manager->createResource($resourceType, $resourceId);
175
-		}
176
-
177
-		if (!$resource->canAccess($this->userSession->getUser())) {
178
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
179
-		}
180
-
181
-		return new DataResponse($this->prepareCollections($resource->getCollections()));
182
-	}
183
-
184
-	/**
185
-	 * @NoAdminRequired
186
-	 *
187
-	 * @param string $baseResourceType
188
-	 * @param string $baseResourceId
189
-	 * @param string $name
190
-	 * @return DataResponse
191
-	 */
192
-	public function createCollectionOnResource(string $baseResourceType, string $baseResourceId, string $name): DataResponse {
193
-		if (!isset($name[0]) || isset($name[64])) {
194
-			return new DataResponse([], Http::STATUS_BAD_REQUEST);
195
-		}
196
-
197
-		try {
198
-			$resource = $this->manager->createResource($baseResourceType, $baseResourceId);
199
-		} catch (CollectionException $e) {
200
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
201
-		}
202
-
203
-		if (!$resource->canAccess($this->userSession->getUser())) {
204
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
205
-		}
206
-
207
-		$collection = $this->manager->newCollection($name);
208
-		$collection->addResource($resource);
209
-
210
-		return $this->respondCollection($collection);
211
-	}
212
-
213
-	/**
214
-	 * @NoAdminRequired
215
-	 *
216
-	 * @param int $collectionId
217
-	 * @param string $collectionName
218
-	 * @return DataResponse
219
-	 */
220
-	public function renameCollection(int $collectionId, string $collectionName): DataResponse {
221
-		try {
222
-			$collection = $this->getCollection($collectionId);
223
-		} catch (CollectionException $exception) {
224
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
225
-		}
226
-
227
-		$collection->setName($collectionName);
228
-
229
-		return $this->respondCollection($collection);
230
-	}
231
-
232
-	protected function respondCollection(ICollection $collection): DataResponse {
233
-		try {
234
-			return new DataResponse($this->prepareCollection($collection));
235
-		} catch (CollectionException $e) {
236
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
237
-		} catch (Exception $e) {
238
-			$this->logger->logException($e);
239
-			return new DataResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
240
-		}
241
-	}
242
-
243
-	protected function prepareCollections(array $collections): array {
244
-		$result = [];
245
-
246
-		foreach ($collections as $collection) {
247
-			try {
248
-				$result[] = $this->prepareCollection($collection);
249
-			} catch (CollectionException $e) {
250
-			} catch (Exception $e) {
251
-				$this->logger->logException($e);
252
-			}
253
-		}
254
-
255
-		return $result;
256
-	}
257
-
258
-	protected function prepareCollection(ICollection $collection): array {
259
-		if (!$collection->canAccess($this->userSession->getUser())) {
260
-			throw new CollectionException('Can not access collection');
261
-		}
262
-
263
-		return [
264
-			'id' => $collection->getId(),
265
-			'name' => $collection->getName(),
266
-			'resources' => $this->prepareResources($collection->getResources()),
267
-		];
268
-	}
269
-
270
-	protected function prepareResources(array $resources): ?array {
271
-		$result = [];
272
-
273
-		foreach ($resources as $resource) {
274
-			try {
275
-				$result[] = $this->prepareResource($resource);
276
-			} catch (ResourceException $e) {
277
-			} catch (Exception $e) {
278
-				$this->logger->logException($e);
279
-			}
280
-		}
281
-
282
-		return $result;
283
-	}
284
-
285
-	protected function prepareResource(IResource $resource): array {
286
-		if (!$resource->canAccess($this->userSession->getUser())) {
287
-			throw new ResourceException('Can not access resource');
288
-		}
289
-
290
-		return $resource->getRichObject();
291
-	}
40
+    /** @var IManager */
41
+    private $manager;
42
+    /** @var IUserSession */
43
+    private $userSession;
44
+    /** @var ILogger */
45
+    private $logger;
46
+
47
+    public function __construct(
48
+        string $appName,
49
+        IRequest $request,
50
+        IManager $manager,
51
+        IUserSession $userSession,
52
+        ILogger $logger
53
+    ) {
54
+        parent::__construct($appName, $request);
55
+
56
+        $this->manager = $manager;
57
+        $this->userSession = $userSession;
58
+        $this->logger = $logger;
59
+    }
60
+
61
+    /**
62
+     * @param int $collectionId
63
+     * @return ICollection
64
+     * @throws CollectionException when the collection was not found for the user
65
+     */
66
+    protected function getCollection(int $collectionId): ICollection {
67
+        $collection = $this->manager->getCollectionForUser($collectionId, $this->userSession->getUser());
68
+
69
+        if (!$collection->canAccess($this->userSession->getUser())) {
70
+            throw new CollectionException('Not found');
71
+        }
72
+
73
+        return $collection;
74
+    }
75
+
76
+    /**
77
+     * @NoAdminRequired
78
+     *
79
+     * @param int $collectionId
80
+     * @return DataResponse
81
+     */
82
+    public function listCollection(int $collectionId): DataResponse {
83
+        try {
84
+            $collection = $this->getCollection($collectionId);
85
+        } catch (CollectionException $e) {
86
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
87
+        }
88
+
89
+        return $this->respondCollection($collection);
90
+    }
91
+
92
+    /**
93
+     * @NoAdminRequired
94
+     *
95
+     * @param string $filter
96
+     * @return DataResponse
97
+     */
98
+    public function searchCollections(string $filter): DataResponse {
99
+        try {
100
+            $collections = $this->manager->searchCollections($this->userSession->getUser(), $filter);
101
+        } catch (CollectionException $e) {
102
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
103
+        }
104
+
105
+        return new DataResponse($this->prepareCollections($collections));
106
+    }
107
+
108
+    /**
109
+     * @NoAdminRequired
110
+     *
111
+     * @param int $collectionId
112
+     * @param string $resourceType
113
+     * @param string $resourceId
114
+     * @return DataResponse
115
+     */
116
+    public function addResource(int $collectionId, string $resourceType, string $resourceId): DataResponse {
117
+        try {
118
+            $collection = $this->getCollection($collectionId);
119
+        } catch (CollectionException $e) {
120
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
121
+        }
122
+
123
+        $resource = $this->manager->createResource($resourceType, $resourceId);
124
+
125
+        if (!$resource->canAccess($this->userSession->getUser())) {
126
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
127
+        }
128
+
129
+        try {
130
+            $collection->addResource($resource);
131
+        } catch (ResourceException $e) {
132
+        }
133
+
134
+        return $this->respondCollection($collection);
135
+    }
136
+
137
+    /**
138
+     * @NoAdminRequired
139
+     *
140
+     * @param int $collectionId
141
+     * @param string $resourceType
142
+     * @param string $resourceId
143
+     * @return DataResponse
144
+     */
145
+    public function removeResource(int $collectionId, string $resourceType, string $resourceId): DataResponse {
146
+        try {
147
+            $collection = $this->getCollection($collectionId);
148
+        } catch (CollectionException $e) {
149
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
150
+        }
151
+
152
+        try {
153
+            $resource = $this->manager->getResourceForUser($resourceType, $resourceId, $this->userSession->getUser());
154
+        } catch (CollectionException $e) {
155
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
156
+        }
157
+
158
+        $collection->removeResource($resource);
159
+
160
+        return $this->respondCollection($collection);
161
+    }
162
+
163
+    /**
164
+     * @NoAdminRequired
165
+     *
166
+     * @param string $resourceType
167
+     * @param string $resourceId
168
+     * @return DataResponse
169
+     */
170
+    public function getCollectionsByResource(string $resourceType, string $resourceId): DataResponse {
171
+        try {
172
+            $resource = $this->manager->getResourceForUser($resourceType, $resourceId, $this->userSession->getUser());
173
+        } catch (ResourceException $e) {
174
+            $resource = $this->manager->createResource($resourceType, $resourceId);
175
+        }
176
+
177
+        if (!$resource->canAccess($this->userSession->getUser())) {
178
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
179
+        }
180
+
181
+        return new DataResponse($this->prepareCollections($resource->getCollections()));
182
+    }
183
+
184
+    /**
185
+     * @NoAdminRequired
186
+     *
187
+     * @param string $baseResourceType
188
+     * @param string $baseResourceId
189
+     * @param string $name
190
+     * @return DataResponse
191
+     */
192
+    public function createCollectionOnResource(string $baseResourceType, string $baseResourceId, string $name): DataResponse {
193
+        if (!isset($name[0]) || isset($name[64])) {
194
+            return new DataResponse([], Http::STATUS_BAD_REQUEST);
195
+        }
196
+
197
+        try {
198
+            $resource = $this->manager->createResource($baseResourceType, $baseResourceId);
199
+        } catch (CollectionException $e) {
200
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
201
+        }
202
+
203
+        if (!$resource->canAccess($this->userSession->getUser())) {
204
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
205
+        }
206
+
207
+        $collection = $this->manager->newCollection($name);
208
+        $collection->addResource($resource);
209
+
210
+        return $this->respondCollection($collection);
211
+    }
212
+
213
+    /**
214
+     * @NoAdminRequired
215
+     *
216
+     * @param int $collectionId
217
+     * @param string $collectionName
218
+     * @return DataResponse
219
+     */
220
+    public function renameCollection(int $collectionId, string $collectionName): DataResponse {
221
+        try {
222
+            $collection = $this->getCollection($collectionId);
223
+        } catch (CollectionException $exception) {
224
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
225
+        }
226
+
227
+        $collection->setName($collectionName);
228
+
229
+        return $this->respondCollection($collection);
230
+    }
231
+
232
+    protected function respondCollection(ICollection $collection): DataResponse {
233
+        try {
234
+            return new DataResponse($this->prepareCollection($collection));
235
+        } catch (CollectionException $e) {
236
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
237
+        } catch (Exception $e) {
238
+            $this->logger->logException($e);
239
+            return new DataResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
240
+        }
241
+    }
242
+
243
+    protected function prepareCollections(array $collections): array {
244
+        $result = [];
245
+
246
+        foreach ($collections as $collection) {
247
+            try {
248
+                $result[] = $this->prepareCollection($collection);
249
+            } catch (CollectionException $e) {
250
+            } catch (Exception $e) {
251
+                $this->logger->logException($e);
252
+            }
253
+        }
254
+
255
+        return $result;
256
+    }
257
+
258
+    protected function prepareCollection(ICollection $collection): array {
259
+        if (!$collection->canAccess($this->userSession->getUser())) {
260
+            throw new CollectionException('Can not access collection');
261
+        }
262
+
263
+        return [
264
+            'id' => $collection->getId(),
265
+            'name' => $collection->getName(),
266
+            'resources' => $this->prepareResources($collection->getResources()),
267
+        ];
268
+    }
269
+
270
+    protected function prepareResources(array $resources): ?array {
271
+        $result = [];
272
+
273
+        foreach ($resources as $resource) {
274
+            try {
275
+                $result[] = $this->prepareResource($resource);
276
+            } catch (ResourceException $e) {
277
+            } catch (Exception $e) {
278
+                $this->logger->logException($e);
279
+            }
280
+        }
281
+
282
+        return $result;
283
+    }
284
+
285
+    protected function prepareResource(IResource $resource): array {
286
+        if (!$resource->canAccess($this->userSession->getUser())) {
287
+            throw new ResourceException('Can not access resource');
288
+        }
289
+
290
+        return $resource->getRichObject();
291
+    }
292 292
 }
Please login to merge, or discard this patch.
lib/public/FullTextSearch/IFullTextSearchManager.php 1 patch
Indentation   +139 added lines, -139 removed lines patch added patch discarded remove patch
@@ -51,145 +51,145 @@
 block discarded – undo
51 51
 interface IFullTextSearchManager {
52 52
 
53 53
 
54
-	/**
55
-	 * Register a IProviderService.
56
-	 *
57
-	 * @since 15.0.0
58
-	 *
59
-	 * @param IProviderService $providerService
60
-	 */
61
-	public function registerProviderService(IProviderService $providerService);
62
-
63
-	/**
64
-	 * Register a IIndexService.
65
-	 *
66
-	 * @since 15.0.0
67
-	 *
68
-	 * @param IIndexService $indexService
69
-	 */
70
-	public function registerIndexService(IIndexService $indexService);
71
-
72
-	/**
73
-	 * Register a ISearchService.
74
-	 *
75
-	 * @since 15.0.0
76
-	 *
77
-	 * @param ISearchService $searchService
78
-	 */
79
-	public function registerSearchService(ISearchService $searchService);
80
-
81
-	/**
82
-	 * returns true is Full Text Search is available (app is present and Service
83
-	 * are registered)
84
-	 *
85
-	 * @since 16.0.0
86
-	 *
87
-	 * @return bool
88
-	 */
89
-	public function isAvailable(): bool;
90
-
91
-
92
-	/**
93
-	 * Add the Javascript API in the navigation page of an app.
94
-	 * Needed to replace the default search.
95
-	 *
96
-	 * @since 15.0.0
97
-	 */
98
-	public function addJavascriptAPI();
99
-
100
-
101
-	/**
102
-	 * Check if the provider $providerId is already indexed.
103
-	 *
104
-	 * @since 15.0.0
105
-	 *
106
-	 * @param string $providerId
107
-	 *
108
-	 * @return bool
109
-	 */
110
-	public function isProviderIndexed(string $providerId): bool;
111
-
112
-
113
-	/**
114
-	 * Retrieve an Index from the database, based on the Id of the Provider
115
-	 * and the Id of the Document
116
-	 *
117
-	 * @since 15.0.0
118
-	 *
119
-	 * @param string $providerId
120
-	 * @param string $documentId
121
-	 *
122
-	 * @return IIndex
123
-	 */
124
-	public function getIndex(string $providerId, string $documentId): IIndex;
125
-
126
-
127
-	/**
128
-	 * Create a new Index.
129
-	 *
130
-	 * This method must be called when a new document is created.
131
-	 *
132
-	 * @since 15.0.0
133
-	 *
134
-	 * @param string $providerId
135
-	 * @param string $documentId
136
-	 * @param string $userId
137
-	 * @param int $status
138
-	 *
139
-	 * @return IIndex
140
-	 */
141
-	public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
142
-
143
-
144
-	/**
145
-	 * Update the status of an Index. status is a bitflag, setting $reset to
146
-	 * true will reset the status to the value defined in the parameter.
147
-	 *
148
-	 * @since 15.0.0
149
-	 *
150
-	 * @param string $providerId
151
-	 * @param string $documentId
152
-	 * @param int $status
153
-	 * @param bool $reset
154
-	 */
155
-	public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
156
-
157
-
158
-	/**
159
-	 * Update the status of an array of Index. status is a bit flag, setting $reset to
160
-	 * true will reset the status to the value defined in the parameter.
161
-	 *
162
-	 * @since 15.0.0
163
-	 *
164
-	 * @param string $providerId
165
-	 * @param array $documentIds
166
-	 * @param int $status
167
-	 * @param bool $reset
168
-	 */
169
-	public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
170
-
171
-	/**
172
-	 * Update an array of Index.
173
-	 *
174
-	 * @since 15.0.0
175
-	 *
176
-	 * @param IIndex[] $indexes
177
-	 */
178
-	public function updateIndexes(array $indexes);
179
-
180
-	/**
181
-	 * Search using an array as request. If $userId is empty, will use the
182
-	 * current session.
183
-	 *
184
-	 * @see ISearchService::generateSearchRequest
185
-	 *
186
-	 * @since 15.0.0
187
-	 *
188
-	 * @param array $request
189
-	 * @param string $userId
190
-	 * @return ISearchResult[]
191
-	 */
192
-	public function search(array $request, string $userId = ''): array;
54
+    /**
55
+     * Register a IProviderService.
56
+     *
57
+     * @since 15.0.0
58
+     *
59
+     * @param IProviderService $providerService
60
+     */
61
+    public function registerProviderService(IProviderService $providerService);
62
+
63
+    /**
64
+     * Register a IIndexService.
65
+     *
66
+     * @since 15.0.0
67
+     *
68
+     * @param IIndexService $indexService
69
+     */
70
+    public function registerIndexService(IIndexService $indexService);
71
+
72
+    /**
73
+     * Register a ISearchService.
74
+     *
75
+     * @since 15.0.0
76
+     *
77
+     * @param ISearchService $searchService
78
+     */
79
+    public function registerSearchService(ISearchService $searchService);
80
+
81
+    /**
82
+     * returns true is Full Text Search is available (app is present and Service
83
+     * are registered)
84
+     *
85
+     * @since 16.0.0
86
+     *
87
+     * @return bool
88
+     */
89
+    public function isAvailable(): bool;
90
+
91
+
92
+    /**
93
+     * Add the Javascript API in the navigation page of an app.
94
+     * Needed to replace the default search.
95
+     *
96
+     * @since 15.0.0
97
+     */
98
+    public function addJavascriptAPI();
99
+
100
+
101
+    /**
102
+     * Check if the provider $providerId is already indexed.
103
+     *
104
+     * @since 15.0.0
105
+     *
106
+     * @param string $providerId
107
+     *
108
+     * @return bool
109
+     */
110
+    public function isProviderIndexed(string $providerId): bool;
111
+
112
+
113
+    /**
114
+     * Retrieve an Index from the database, based on the Id of the Provider
115
+     * and the Id of the Document
116
+     *
117
+     * @since 15.0.0
118
+     *
119
+     * @param string $providerId
120
+     * @param string $documentId
121
+     *
122
+     * @return IIndex
123
+     */
124
+    public function getIndex(string $providerId, string $documentId): IIndex;
125
+
126
+
127
+    /**
128
+     * Create a new Index.
129
+     *
130
+     * This method must be called when a new document is created.
131
+     *
132
+     * @since 15.0.0
133
+     *
134
+     * @param string $providerId
135
+     * @param string $documentId
136
+     * @param string $userId
137
+     * @param int $status
138
+     *
139
+     * @return IIndex
140
+     */
141
+    public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
142
+
143
+
144
+    /**
145
+     * Update the status of an Index. status is a bitflag, setting $reset to
146
+     * true will reset the status to the value defined in the parameter.
147
+     *
148
+     * @since 15.0.0
149
+     *
150
+     * @param string $providerId
151
+     * @param string $documentId
152
+     * @param int $status
153
+     * @param bool $reset
154
+     */
155
+    public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
156
+
157
+
158
+    /**
159
+     * Update the status of an array of Index. status is a bit flag, setting $reset to
160
+     * true will reset the status to the value defined in the parameter.
161
+     *
162
+     * @since 15.0.0
163
+     *
164
+     * @param string $providerId
165
+     * @param array $documentIds
166
+     * @param int $status
167
+     * @param bool $reset
168
+     */
169
+    public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
170
+
171
+    /**
172
+     * Update an array of Index.
173
+     *
174
+     * @since 15.0.0
175
+     *
176
+     * @param IIndex[] $indexes
177
+     */
178
+    public function updateIndexes(array $indexes);
179
+
180
+    /**
181
+     * Search using an array as request. If $userId is empty, will use the
182
+     * current session.
183
+     *
184
+     * @see ISearchService::generateSearchRequest
185
+     *
186
+     * @since 15.0.0
187
+     *
188
+     * @param array $request
189
+     * @param string $userId
190
+     * @return ISearchResult[]
191
+     */
192
+    public function search(array $request, string $userId = ''): array;
193 193
 
194 194
 
195 195
 }
Please login to merge, or discard this patch.
lib/private/FullTextSearch/FullTextSearchManager.php 1 patch
Indentation   +188 added lines, -188 removed lines patch added patch discarded remove patch
@@ -48,194 +48,194 @@
 block discarded – undo
48 48
 class FullTextSearchManager implements IFullTextSearchManager {
49 49
 
50 50
 
51
-	/** @var IProviderService */
52
-	private $providerService;
53
-
54
-	/** @var IIndexService */
55
-	private $indexService;
56
-
57
-	/** @var ISearchService */
58
-	private $searchService;
59
-
60
-
61
-	/**
62
-	 * @since 15.0.0
63
-	 *
64
-	 * @param IProviderService $providerService
65
-	 */
66
-	public function registerProviderService(IProviderService $providerService) {
67
-		$this->providerService = $providerService;
68
-	}
69
-
70
-	/**
71
-	 * @since 15.0.0
72
-	 *
73
-	 * @param IIndexService $indexService
74
-	 */
75
-	public function registerIndexService(IIndexService $indexService) {
76
-		$this->indexService = $indexService;
77
-	}
78
-
79
-	/**
80
-	 * @since 15.0.0
81
-	 *
82
-	 * @param ISearchService $searchService
83
-	 */
84
-	public function registerSearchService(ISearchService $searchService) {
85
-		$this->searchService = $searchService;
86
-	}
87
-
88
-	/**
89
-	 * @since 16.0.0
90
-	 *
91
-	 * @return bool
92
-	 */
93
-	public function isAvailable(): bool {
94
-		if ($this->indexService === null ||
95
-			$this->providerService === null ||
96
-			$this->searchService === null) {
97
-			return false;
98
-		}
99
-
100
-		return true;
101
-	}
102
-
103
-
104
-	/**
105
-	 * @return IProviderService
106
-	 * @throws FullTextSearchAppNotAvailableException
107
-	 */
108
-	private function getProviderService(): IProviderService {
109
-		if ($this->providerService === null) {
110
-			throw new FullTextSearchAppNotAvailableException('No IProviderService registered');
111
-		}
112
-
113
-		return $this->providerService;
114
-	}
115
-
116
-
117
-	/**
118
-	 * @return IIndexService
119
-	 * @throws FullTextSearchAppNotAvailableException
120
-	 */
121
-	private function getIndexService(): IIndexService {
122
-		if ($this->indexService === null) {
123
-			throw new FullTextSearchAppNotAvailableException('No IIndexService registered');
124
-		}
125
-
126
-		return $this->indexService;
127
-	}
128
-
129
-
130
-	/**
131
-	 * @return ISearchService
132
-	 * @throws FullTextSearchAppNotAvailableException
133
-	 */
134
-	private function getSearchService(): ISearchService {
135
-		if ($this->searchService === null) {
136
-			throw new FullTextSearchAppNotAvailableException('No ISearchService registered');
137
-		}
138
-
139
-		return $this->searchService;
140
-	}
141
-
142
-
143
-	/**
144
-	 * @throws FullTextSearchAppNotAvailableException
145
-	 */
146
-	public function addJavascriptAPI() {
147
-		$this->getProviderService()->addJavascriptAPI();
148
-	}
149
-
150
-
151
-	/**
152
-	 * @param string $providerId
153
-	 *
154
-	 * @return bool
155
-	 * @throws FullTextSearchAppNotAvailableException
156
-	 */
157
-	public function isProviderIndexed(string $providerId): bool {
158
-		return $this->getProviderService()->isProviderIndexed($providerId);
159
-	}
160
-
161
-
162
-	/**
163
-	 * @param string $providerId
164
-	 * @param string $documentId
165
-	 * @return IIndex
166
-	 * @throws FullTextSearchAppNotAvailableException
167
-	 */
168
-	public function getIndex(string $providerId, string $documentId): IIndex {
169
-		return $this->getIndexService()->getIndex($providerId, $documentId);
170
-	}
171
-
172
-	/**
173
-	 * @param string $providerId
174
-	 * @param string $documentId
175
-	 * @param string $userId
176
-	 * @param int $status
177
-	 *
178
-	 * @see IIndex for available value for $status.
179
-	 *
180
-	 * @return IIndex
181
-	 * @throws FullTextSearchAppNotAvailableException
182
-	 */
183
-	public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex {
184
-		return $this->getIndexService()->createIndex($providerId, $documentId, $userId, $status);
185
-	}
186
-
187
-
188
-	/**
189
-	 * @param string $providerId
190
-	 * @param string $documentId
191
-	 * @param int $status
192
-	 * @param bool $reset
193
-	 *
194
-	 * @see IIndex for available value for $status.
195
-	 *
196
-	 * @throws FullTextSearchAppNotAvailableException
197
-	 */
198
-	public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false) {
199
-		$this->getIndexService()->updateIndexStatus($providerId, $documentId, $status, $reset);
200
-	}
201
-
202
-	/**
203
-	 * @param string $providerId
204
-	 * @param array $documentIds
205
-	 * @param int $status
206
-	 * @param bool $reset
207
-	 *
208
-	 * @see IIndex for available value for $status.
209
-	 *
210
-	 * @throws FullTextSearchAppNotAvailableException
211
-	 */
212
-	public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false) {
213
-		$this->getIndexService()->updateIndexesStatus($providerId, $documentIds, $status, $reset);
214
-	}
215
-
216
-
217
-	/**
218
-	 * @param IIndex[] $indexes
219
-	 *
220
-	 * @throws FullTextSearchAppNotAvailableException
221
-	 */
222
-	public function updateIndexes(array $indexes) {
223
-		$this->getIndexService()->updateIndexes($indexes);
224
-	}
225
-
226
-
227
-	/**
228
-	 * @param array $request
229
-	 * @param string $userId
230
-	 *
231
-	 * @return ISearchResult[]
232
-	 * @throws FullTextSearchAppNotAvailableException
233
-	 */
234
-	public function search(array $request, string $userId = ''): array {
235
-		$searchRequest = $this->getSearchService()->generateSearchRequest($request);
236
-
237
-		return $this->getSearchService()->search($userId, $searchRequest);
238
-	}
51
+    /** @var IProviderService */
52
+    private $providerService;
53
+
54
+    /** @var IIndexService */
55
+    private $indexService;
56
+
57
+    /** @var ISearchService */
58
+    private $searchService;
59
+
60
+
61
+    /**
62
+     * @since 15.0.0
63
+     *
64
+     * @param IProviderService $providerService
65
+     */
66
+    public function registerProviderService(IProviderService $providerService) {
67
+        $this->providerService = $providerService;
68
+    }
69
+
70
+    /**
71
+     * @since 15.0.0
72
+     *
73
+     * @param IIndexService $indexService
74
+     */
75
+    public function registerIndexService(IIndexService $indexService) {
76
+        $this->indexService = $indexService;
77
+    }
78
+
79
+    /**
80
+     * @since 15.0.0
81
+     *
82
+     * @param ISearchService $searchService
83
+     */
84
+    public function registerSearchService(ISearchService $searchService) {
85
+        $this->searchService = $searchService;
86
+    }
87
+
88
+    /**
89
+     * @since 16.0.0
90
+     *
91
+     * @return bool
92
+     */
93
+    public function isAvailable(): bool {
94
+        if ($this->indexService === null ||
95
+            $this->providerService === null ||
96
+            $this->searchService === null) {
97
+            return false;
98
+        }
99
+
100
+        return true;
101
+    }
102
+
103
+
104
+    /**
105
+     * @return IProviderService
106
+     * @throws FullTextSearchAppNotAvailableException
107
+     */
108
+    private function getProviderService(): IProviderService {
109
+        if ($this->providerService === null) {
110
+            throw new FullTextSearchAppNotAvailableException('No IProviderService registered');
111
+        }
112
+
113
+        return $this->providerService;
114
+    }
115
+
116
+
117
+    /**
118
+     * @return IIndexService
119
+     * @throws FullTextSearchAppNotAvailableException
120
+     */
121
+    private function getIndexService(): IIndexService {
122
+        if ($this->indexService === null) {
123
+            throw new FullTextSearchAppNotAvailableException('No IIndexService registered');
124
+        }
125
+
126
+        return $this->indexService;
127
+    }
128
+
129
+
130
+    /**
131
+     * @return ISearchService
132
+     * @throws FullTextSearchAppNotAvailableException
133
+     */
134
+    private function getSearchService(): ISearchService {
135
+        if ($this->searchService === null) {
136
+            throw new FullTextSearchAppNotAvailableException('No ISearchService registered');
137
+        }
138
+
139
+        return $this->searchService;
140
+    }
141
+
142
+
143
+    /**
144
+     * @throws FullTextSearchAppNotAvailableException
145
+     */
146
+    public function addJavascriptAPI() {
147
+        $this->getProviderService()->addJavascriptAPI();
148
+    }
149
+
150
+
151
+    /**
152
+     * @param string $providerId
153
+     *
154
+     * @return bool
155
+     * @throws FullTextSearchAppNotAvailableException
156
+     */
157
+    public function isProviderIndexed(string $providerId): bool {
158
+        return $this->getProviderService()->isProviderIndexed($providerId);
159
+    }
160
+
161
+
162
+    /**
163
+     * @param string $providerId
164
+     * @param string $documentId
165
+     * @return IIndex
166
+     * @throws FullTextSearchAppNotAvailableException
167
+     */
168
+    public function getIndex(string $providerId, string $documentId): IIndex {
169
+        return $this->getIndexService()->getIndex($providerId, $documentId);
170
+    }
171
+
172
+    /**
173
+     * @param string $providerId
174
+     * @param string $documentId
175
+     * @param string $userId
176
+     * @param int $status
177
+     *
178
+     * @see IIndex for available value for $status.
179
+     *
180
+     * @return IIndex
181
+     * @throws FullTextSearchAppNotAvailableException
182
+     */
183
+    public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex {
184
+        return $this->getIndexService()->createIndex($providerId, $documentId, $userId, $status);
185
+    }
186
+
187
+
188
+    /**
189
+     * @param string $providerId
190
+     * @param string $documentId
191
+     * @param int $status
192
+     * @param bool $reset
193
+     *
194
+     * @see IIndex for available value for $status.
195
+     *
196
+     * @throws FullTextSearchAppNotAvailableException
197
+     */
198
+    public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false) {
199
+        $this->getIndexService()->updateIndexStatus($providerId, $documentId, $status, $reset);
200
+    }
201
+
202
+    /**
203
+     * @param string $providerId
204
+     * @param array $documentIds
205
+     * @param int $status
206
+     * @param bool $reset
207
+     *
208
+     * @see IIndex for available value for $status.
209
+     *
210
+     * @throws FullTextSearchAppNotAvailableException
211
+     */
212
+    public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false) {
213
+        $this->getIndexService()->updateIndexesStatus($providerId, $documentIds, $status, $reset);
214
+    }
215
+
216
+
217
+    /**
218
+     * @param IIndex[] $indexes
219
+     *
220
+     * @throws FullTextSearchAppNotAvailableException
221
+     */
222
+    public function updateIndexes(array $indexes) {
223
+        $this->getIndexService()->updateIndexes($indexes);
224
+    }
225
+
226
+
227
+    /**
228
+     * @param array $request
229
+     * @param string $userId
230
+     *
231
+     * @return ISearchResult[]
232
+     * @throws FullTextSearchAppNotAvailableException
233
+     */
234
+    public function search(array $request, string $userId = ''): array {
235
+        $searchRequest = $this->getSearchService()->generateSearchRequest($request);
236
+
237
+        return $this->getSearchService()->search($userId, $searchRequest);
238
+    }
239 239
 
240 240
 
241 241
 }
Please login to merge, or discard this patch.
apps/oauth2/lib/Db/AccessToken.php 1 patch
Indentation   +15 added lines, -15 removed lines patch added patch discarded remove patch
@@ -34,20 +34,20 @@
 block discarded – undo
34 34
  * @method void setHashedCode(string $token)
35 35
  */
36 36
 class AccessToken extends Entity {
37
-	/** @var int */
38
-	protected $tokenId;
39
-	/** @var int */
40
-	protected $clientId;
41
-	/** @var string */
42
-	protected $hashedCode;
43
-	/** @var string */
44
-	protected $encryptedToken;
37
+    /** @var int */
38
+    protected $tokenId;
39
+    /** @var int */
40
+    protected $clientId;
41
+    /** @var string */
42
+    protected $hashedCode;
43
+    /** @var string */
44
+    protected $encryptedToken;
45 45
 
46
-	public function __construct() {
47
-		$this->addType('id', 'int');
48
-		$this->addType('tokenId', 'int');
49
-		$this->addType('clientId', 'int');
50
-		$this->addType('hashedCode', 'string');
51
-		$this->addType('encryptedToken', 'string');
52
-	}
46
+    public function __construct() {
47
+        $this->addType('id', 'int');
48
+        $this->addType('tokenId', 'int');
49
+        $this->addType('clientId', 'int');
50
+        $this->addType('hashedCode', 'string');
51
+        $this->addType('encryptedToken', 'string');
52
+    }
53 53
 }
Please login to merge, or discard this patch.
lib/private/Authentication/Login/ClearLostPasswordTokensCommand.php 1 patch
Indentation   +19 added lines, -19 removed lines patch added patch discarded remove patch
@@ -29,24 +29,24 @@
 block discarded – undo
29 29
 
30 30
 class ClearLostPasswordTokensCommand extends ALoginCommand {
31 31
 
32
-	/** @var IConfig */
33
-	private $config;
34
-
35
-	public function __construct(IConfig $config) {
36
-		$this->config = $config;
37
-	}
38
-
39
-	/**
40
-	 * User has successfully logged in, now remove the password reset link, when it is available
41
-	 */
42
-	public function process(LoginData $loginData): LoginResult {
43
-		$this->config->deleteUserValue(
44
-			$loginData->getUser()->getUID(),
45
-			'core',
46
-			'lostpassword'
47
-		);
48
-
49
-		return $this->processNextOrFinishSuccessfully($loginData);
50
-	}
32
+    /** @var IConfig */
33
+    private $config;
34
+
35
+    public function __construct(IConfig $config) {
36
+        $this->config = $config;
37
+    }
38
+
39
+    /**
40
+     * User has successfully logged in, now remove the password reset link, when it is available
41
+     */
42
+    public function process(LoginData $loginData): LoginResult {
43
+        $this->config->deleteUserValue(
44
+            $loginData->getUser()->getUID(),
45
+            'core',
46
+            'lostpassword'
47
+        );
48
+
49
+        return $this->processNextOrFinishSuccessfully($loginData);
50
+    }
51 51
 
52 52
 }
Please login to merge, or discard this patch.
lib/private/Authentication/Login/UidLoginCommand.php 1 patch
Indentation   +23 added lines, -23 removed lines patch added patch discarded remove patch
@@ -30,28 +30,28 @@
 block discarded – undo
30 30
 
31 31
 class UidLoginCommand extends ALoginCommand {
32 32
 
33
-	/** @var Manager */
34
-	private $userManager;
35
-
36
-	public function __construct(Manager $userManager) {
37
-		$this->userManager = $userManager;
38
-	}
39
-
40
-	/**
41
-	 * @param LoginData $loginData
42
-	 *
43
-	 * @return LoginResult
44
-	 */
45
-	public function process(LoginData $loginData): LoginResult {
46
-		/* @var $loginResult IUser */
47
-		$user = $this->userManager->checkPasswordNoLogging(
48
-			$loginData->getUsername(),
49
-			$loginData->getPassword()
50
-		);
51
-
52
-		$loginData->setUser($user);
53
-
54
-		return $this->processNextOrFinishSuccessfully($loginData);
55
-	}
33
+    /** @var Manager */
34
+    private $userManager;
35
+
36
+    public function __construct(Manager $userManager) {
37
+        $this->userManager = $userManager;
38
+    }
39
+
40
+    /**
41
+     * @param LoginData $loginData
42
+     *
43
+     * @return LoginResult
44
+     */
45
+    public function process(LoginData $loginData): LoginResult {
46
+        /* @var $loginResult IUser */
47
+        $user = $this->userManager->checkPasswordNoLogging(
48
+            $loginData->getUsername(),
49
+            $loginData->getPassword()
50
+        );
51
+
52
+        $loginData->setUser($user);
53
+
54
+        return $this->processNextOrFinishSuccessfully($loginData);
55
+    }
56 56
 
57 57
 }
Please login to merge, or discard this patch.
lib/private/Authentication/Login/UpdateLastPasswordConfirmCommand.php 1 patch
Indentation   +12 added lines, -12 removed lines patch added patch discarded remove patch
@@ -29,20 +29,20 @@
 block discarded – undo
29 29
 
30 30
 class UpdateLastPasswordConfirmCommand extends ALoginCommand {
31 31
 
32
-	/** @var ISession */
33
-	private $session;
32
+    /** @var ISession */
33
+    private $session;
34 34
 
35
-	public function __construct(ISession $session) {
36
-		$this->session = $session;
37
-	}
35
+    public function __construct(ISession $session) {
36
+        $this->session = $session;
37
+    }
38 38
 
39
-	public function process(LoginData $loginData): LoginResult {
40
-		$this->session->set(
41
-			'last-password-confirm',
42
-			$loginData->getUser()->getLastLogin()
43
-		);
39
+    public function process(LoginData $loginData): LoginResult {
40
+        $this->session->set(
41
+            'last-password-confirm',
42
+            $loginData->getUser()->getLastLogin()
43
+        );
44 44
 
45
-		return $this->processNextOrFinishSuccessfully($loginData);
46
-	}
45
+        return $this->processNextOrFinishSuccessfully($loginData);
46
+    }
47 47
 
48 48
 }
Please login to merge, or discard this patch.
lib/private/Authentication/Login/CompleteLoginCommand.php 1 patch
Indentation   +18 added lines, -18 removed lines patch added patch discarded remove patch
@@ -28,23 +28,23 @@
 block discarded – undo
28 28
 
29 29
 class CompleteLoginCommand extends ALoginCommand {
30 30
 
31
-	/** @var Session */
32
-	private $userSession;
33
-
34
-	public function __construct(Session $userSession) {
35
-		$this->userSession = $userSession;
36
-	}
37
-
38
-	public function process(LoginData $loginData): LoginResult {
39
-		$this->userSession->completeLogin(
40
-			$loginData->getUser(),
41
-			[
42
-				'loginName' => $loginData->getUsername(),
43
-				'password' => $loginData->getPassword(),
44
-			]
45
-		);
46
-
47
-		return $this->processNextOrFinishSuccessfully($loginData);
48
-	}
31
+    /** @var Session */
32
+    private $userSession;
33
+
34
+    public function __construct(Session $userSession) {
35
+        $this->userSession = $userSession;
36
+    }
37
+
38
+    public function process(LoginData $loginData): LoginResult {
39
+        $this->userSession->completeLogin(
40
+            $loginData->getUser(),
41
+            [
42
+                'loginName' => $loginData->getUsername(),
43
+                'password' => $loginData->getPassword(),
44
+            ]
45
+        );
46
+
47
+        return $this->processNextOrFinishSuccessfully($loginData);
48
+    }
49 49
 
50 50
 }
Please login to merge, or discard this patch.