Refactors lib/private/FullTextSearch.

Mainly using PHP8's constructor property promotion. Signed-off-by: Faraz Samapoor <[email protected]> Co-authored-by: Côme Chilliet <[email protected]>
nextcloud · Oct 10, 2023 · 217101a · 217101a
1 parent e6d0105
commit 217101a
Show file tree

Hide file tree

Showing 6 changed files with 80 additions and 499 deletions.
diff --git a/lib/private/FullTextSearch/FullTextSearchManager.php b/lib/private/FullTextSearch/FullTextSearchManager.php
@@ -39,47 +39,35 @@
  * @package OC\FullTextSearch
  */
 class FullTextSearchManager implements IFullTextSearchManager {
-	/** @var IProviderService */
-	private $providerService;
+	private ?IProviderService $providerService;
 
-	/** @var IIndexService */
-	private $indexService;
-
-	/** @var ISearchService */
-	private $searchService;
+	private ?IIndexService $indexService;
 
+	private ?ISearchService $searchService;
 
 	/**
 	 * @since 15.0.0
-	 *
-	 * @param IProviderService $providerService
 	 */
-	public function registerProviderService(IProviderService $providerService) {
+	public function registerProviderService(IProviderService $providerService): void {
 		$this->providerService = $providerService;
 	}
 
 	/**
 	 * @since 15.0.0
-	 *
-	 * @param IIndexService $indexService
 	 */
-	public function registerIndexService(IIndexService $indexService) {
+	public function registerIndexService(IIndexService $indexService): void {
 		$this->indexService = $indexService;
 	}
 
 	/**
 	 * @since 15.0.0
-	 *
-	 * @param ISearchService $searchService
 	 */
-	public function registerSearchService(ISearchService $searchService) {
+	public function registerSearchService(ISearchService $searchService): void {
 		$this->searchService = $searchService;
 	}
 
 	/**
 	 * @since 16.0.0
-	 *
-	 * @return bool
 	 */
 	public function isAvailable(): bool {
 		if ($this->indexService === null ||
@@ -93,7 +81,6 @@ public function isAvailable(): bool {
 
 
 	/**
-	 * @return IProviderService
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
 	private function getProviderService(): IProviderService {
@@ -106,7 +93,6 @@ private function getProviderService(): IProviderService {
 
 
 	/**
-	 * @return IIndexService
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
 	private function getIndexService(): IIndexService {
@@ -119,7 +105,6 @@ private function getIndexService(): IIndexService {
 
 
 	/**
-	 * @return ISearchService
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
 	private function getSearchService(): ISearchService {
@@ -134,15 +119,12 @@ private function getSearchService(): ISearchService {
 	/**
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
-	public function addJavascriptAPI() {
+	public function addJavascriptAPI(): void {
 		$this->getProviderService()->addJavascriptAPI();
 	}
 
 
 	/**
-	 * @param string $providerId
-	 *
-	 * @return bool
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
 	public function isProviderIndexed(string $providerId): bool {
@@ -151,56 +133,52 @@ public function isProviderIndexed(string $providerId): bool {
 
 
 	/**
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @return IIndex
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
 	public function getIndex(string $providerId, string $documentId): IIndex {
 		return $this->getIndexService()->getIndex($providerId, $documentId);
 	}
 
 	/**
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param string $userId
-	 * @param int $status
-	 *
 	 * @see IIndex for available value for $status.
 	 *
-	 * @return IIndex
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
-	public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex {
+	public function createIndex(
+		string $providerId,
+		string $documentId,
+		string $userId,
+		int $status = 0,
+	): IIndex {
 		return $this->getIndexService()->createIndex($providerId, $documentId, $userId, $status);
 	}
 
 
 	/**
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param int $status
-	 * @param bool $reset
-	 *
 	 * @see IIndex for available value for $status.
 	 *
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
-	public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false) {
+	public function updateIndexStatus(
+		string $providerId,
+		string $documentId,
+		int $status,
+		bool $reset = false,
+	): void {
 		$this->getIndexService()->updateIndexStatus($providerId, $documentId, $status, $reset);
 	}
 
 	/**
-	 * @param string $providerId
-	 * @param array $documentIds
-	 * @param int $status
-	 * @param bool $reset
-	 *
 	 * @see IIndex for available value for $status.
 	 *
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
-	public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false) {
+	public function updateIndexesStatus(
+		string $providerId,
+		array $documentIds,
+		int $status,
+		bool $reset = false,
+	): void {
 		$this->getIndexService()->updateIndexesStatus($providerId, $documentIds, $status, $reset);
 	}
 
@@ -210,15 +188,12 @@ public function updateIndexesStatus(string $providerId, array $documentIds, int
 	 *
 	 * @throws FullTextSearchAppNotAvailableException
 	 */
-	public function updateIndexes(array $indexes) {
+	public function updateIndexes(array $indexes): void {
 		$this->getIndexService()->updateIndexes($indexes);
 	}
 
 
 	/**
-	 * @param array $request
-	 * @param string $userId
-	 *
 	 * @return ISearchResult[]
 	 * @throws FullTextSearchAppNotAvailableException
 	 */