nextcloud / server

lib/public/FullTextSearch/IFullTextSearchManager.php

Indentation +139 added lines, -139 removed lines

@@ -51,145 +51,145 @@
 interface IFullTextSearchManager {
 
 
-	/**
-	 * Register a IProviderService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IProviderService $providerService
-	 */
-	public function registerProviderService(IProviderService $providerService);
-
-	/**
-	 * Register a IIndexService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexService $indexService
-	 */
-	public function registerIndexService(IIndexService $indexService);
-
-	/**
-	 * Register a ISearchService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchService $searchService
-	 */
-	public function registerSearchService(ISearchService $searchService);
-
-	/**
-	 * returns true is Full Text Search is available (app is present and Service
-	 * are registered)
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	public function isAvailable(): bool;
-
-
-	/**
-	 * Add the Javascript API in the navigation page of an app.
-	 * Needed to replace the default search.
-	 *
-	 * @since 15.0.0
-	 */
-	public function addJavascriptAPI();
-
-
-	/**
-	 * Check if the provider $providerId is already indexed.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 *
-	 * @return bool
-	 */
-	public function isProviderIndexed(string $providerId): bool;
-
-
-	/**
-	 * Retrieve an Index from the database, based on the Id of the Provider
-	 * and the Id of the Document
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 *
-	 * @return IIndex
-	 */
-	public function getIndex(string $providerId, string $documentId): IIndex;
-
-
-	/**
-	 * Create a new Index.
-	 *
-	 * This method must be called when a new document is created.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param string $userId
-	 * @param int $status
-	 *
-	 * @return IIndex
-	 */
-	public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
-
-
-	/**
-	 * Update the status of an Index. status is a bitflag, setting $reset to
-	 * true will reset the status to the value defined in the parameter.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param int $status
-	 * @param bool $reset
-	 */
-	public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
-
-
-	/**
-	 * Update the status of an array of Index. status is a bit flag, setting $reset to
-	 * true will reset the status to the value defined in the parameter.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param array $documentIds
-	 * @param int $status
-	 * @param bool $reset
-	 */
-	public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
-
-	/**
-	 * Update an array of Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex[] $indexes
-	 */
-	public function updateIndexes(array $indexes);
-
-	/**
-	 * Search using an array as request. If $userId is empty, will use the
-	 * current session.
-	 *
-	 * @see ISearchService::generateSearchRequest
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $request
-	 * @param string $userId
-	 * @return ISearchResult[]
-	 */
-	public function search(array $request, string $userId = ''): array;
+    /**
+     * Register a IProviderService.
+     *
+     * @since 15.0.0
+     *
+     * @param IProviderService $providerService
+     */
+    public function registerProviderService(IProviderService $providerService);
+
+    /**
+     * Register a IIndexService.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexService $indexService
+     */
+    public function registerIndexService(IIndexService $indexService);
+
+    /**
+     * Register a ISearchService.
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchService $searchService
+     */
+    public function registerSearchService(ISearchService $searchService);
+
+    /**
+     * returns true is Full Text Search is available (app is present and Service
+     * are registered)
+     *
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    public function isAvailable(): bool;
+
+
+    /**
+     * Add the Javascript API in the navigation page of an app.
+     * Needed to replace the default search.
+     *
+     * @since 15.0.0
+     */
+    public function addJavascriptAPI();
+
+
+    /**
+     * Check if the provider $providerId is already indexed.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     *
+     * @return bool
+     */
+    public function isProviderIndexed(string $providerId): bool;
+
+
+    /**
+     * Retrieve an Index from the database, based on the Id of the Provider
+     * and the Id of the Document
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     *
+     * @return IIndex
+     */
+    public function getIndex(string $providerId, string $documentId): IIndex;
+
+
+    /**
+     * Create a new Index.
+     *
+     * This method must be called when a new document is created.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     * @param string $userId
+     * @param int $status
+     *
+     * @return IIndex
+     */
+    public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
+
+
+    /**
+     * Update the status of an Index. status is a bitflag, setting $reset to
+     * true will reset the status to the value defined in the parameter.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     * @param int $status
+     * @param bool $reset
+     */
+    public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
+
+
+    /**
+     * Update the status of an array of Index. status is a bit flag, setting $reset to
+     * true will reset the status to the value defined in the parameter.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param array $documentIds
+     * @param int $status
+     * @param bool $reset
+     */
+    public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
+
+    /**
+     * Update an array of Index.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex[] $indexes
+     */
+    public function updateIndexes(array $indexes);
+
+    /**
+     * Search using an array as request. If $userId is empty, will use the
+     * current session.
+     *
+     * @see ISearchService::generateSearchRequest
+     *
+     * @since 15.0.0
+     *
+     * @param array $request
+     * @param string $userId
+     * @return ISearchResult[]
+     */
+    public function search(array $request, string $userId = ''): array;
 
 
 }

lib/private/FullTextSearch/FullTextSearchManager.php

Indentation +188 added lines, -188 removed lines

@@ -48,194 +48,194 @@
 class FullTextSearchManager implements IFullTextSearchManager {
 
 
-	/** @var IProviderService */
-	private $providerService;
-
-	/** @var IIndexService */
-	private $indexService;
-
-	/** @var ISearchService */
-	private $searchService;
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @param IProviderService $providerService
-	 */
-	public function registerProviderService(IProviderService $providerService) {
-		$this->providerService = $providerService;
-	}
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @param IIndexService $indexService
-	 */
-	public function registerIndexService(IIndexService $indexService) {
-		$this->indexService = $indexService;
-	}
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @param ISearchService $searchService
-	 */
-	public function registerSearchService(ISearchService $searchService) {
-		$this->searchService = $searchService;
-	}
-
-	/**
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	public function isAvailable(): bool {
-		if ($this->indexService === null ||
-			$this->providerService === null ||
-			$this->searchService === null) {
-			return false;
-		}
-
-		return true;
-	}
-
-
-	/**
-	 * @return IProviderService
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	private function getProviderService(): IProviderService {
-		if ($this->providerService === null) {
-			throw new FullTextSearchAppNotAvailableException('No IProviderService registered');
-		}
-
-		return $this->providerService;
-	}
-
-
-	/**
-	 * @return IIndexService
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	private function getIndexService(): IIndexService {
-		if ($this->indexService === null) {
-			throw new FullTextSearchAppNotAvailableException('No IIndexService registered');
-		}
-
-		return $this->indexService;
-	}
-
-
-	/**
-	 * @return ISearchService
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	private function getSearchService(): ISearchService {
-		if ($this->searchService === null) {
-			throw new FullTextSearchAppNotAvailableException('No ISearchService registered');
-		}
-
-		return $this->searchService;
-	}
-
-
-	/**
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function addJavascriptAPI() {
-		$this->getProviderService()->addJavascriptAPI();
-	}
-
-
-	/**
-	 * @param string $providerId
-	 *
-	 * @return bool
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function isProviderIndexed(string $providerId): bool {
-		return $this->getProviderService()->isProviderIndexed($providerId);
-	}
-
-
-	/**
-	 * @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 {
-		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) {
-		$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) {
-		$this->getIndexService()->updateIndexesStatus($providerId, $documentIds, $status, $reset);
-	}
-
-
-	/**
-	 * @param IIndex[] $indexes
-	 *
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function updateIndexes(array $indexes) {
-		$this->getIndexService()->updateIndexes($indexes);
-	}
-
-
-	/**
-	 * @param array $request
-	 * @param string $userId
-	 *
-	 * @return ISearchResult[]
-	 * @throws FullTextSearchAppNotAvailableException
-	 */
-	public function search(array $request, string $userId = ''): array {
-		$searchRequest = $this->getSearchService()->generateSearchRequest($request);
-
-		return $this->getSearchService()->search($userId, $searchRequest);
-	}
+    /** @var IProviderService */
+    private $providerService;
+
+    /** @var IIndexService */
+    private $indexService;
+
+    /** @var ISearchService */
+    private $searchService;
+
+
+    /**
+     * @since 15.0.0
+     *
+     * @param IProviderService $providerService
+     */
+    public function registerProviderService(IProviderService $providerService) {
+        $this->providerService = $providerService;
+    }
+
+    /**
+     * @since 15.0.0
+     *
+     * @param IIndexService $indexService
+     */
+    public function registerIndexService(IIndexService $indexService) {
+        $this->indexService = $indexService;
+    }
+
+    /**
+     * @since 15.0.0
+     *
+     * @param ISearchService $searchService
+     */
+    public function registerSearchService(ISearchService $searchService) {
+        $this->searchService = $searchService;
+    }
+
+    /**
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    public function isAvailable(): bool {
+        if ($this->indexService === null ||
+            $this->providerService === null ||
+            $this->searchService === null) {
+            return false;
+        }
+
+        return true;
+    }
+
+
+    /**
+     * @return IProviderService
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    private function getProviderService(): IProviderService {
+        if ($this->providerService === null) {
+            throw new FullTextSearchAppNotAvailableException('No IProviderService registered');
+        }
+
+        return $this->providerService;
+    }
+
+
+    /**
+     * @return IIndexService
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    private function getIndexService(): IIndexService {
+        if ($this->indexService === null) {
+            throw new FullTextSearchAppNotAvailableException('No IIndexService registered');
+        }
+
+        return $this->indexService;
+    }
+
+
+    /**
+     * @return ISearchService
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    private function getSearchService(): ISearchService {
+        if ($this->searchService === null) {
+            throw new FullTextSearchAppNotAvailableException('No ISearchService registered');
+        }
+
+        return $this->searchService;
+    }
+
+
+    /**
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function addJavascriptAPI() {
+        $this->getProviderService()->addJavascriptAPI();
+    }
+
+
+    /**
+     * @param string $providerId
+     *
+     * @return bool
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function isProviderIndexed(string $providerId): bool {
+        return $this->getProviderService()->isProviderIndexed($providerId);
+    }
+
+
+    /**
+     * @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 {
+        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) {
+        $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) {
+        $this->getIndexService()->updateIndexesStatus($providerId, $documentIds, $status, $reset);
+    }
+
+
+    /**
+     * @param IIndex[] $indexes
+     *
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function updateIndexes(array $indexes) {
+        $this->getIndexService()->updateIndexes($indexes);
+    }
+
+
+    /**
+     * @param array $request
+     * @param string $userId
+     *
+     * @return ISearchResult[]
+     * @throws FullTextSearchAppNotAvailableException
+     */
+    public function search(array $request, string $userId = ''): array {
+        $searchRequest = $this->getSearchService()->generateSearchRequest($request);
+
+        return $this->getSearchService()->search($userId, $searchRequest);
+    }
 
 
 }