nextcloud / server

lib/public/Search/IProvider.php

Indentation +62 added lines, -62 removed lines

@@ -39,69 +39,69 @@
  */
 interface IProvider {
 
-	/**
-	 * Get the unique ID of this search provider
-	 *
-	 * Ideally this should be the app name or an identifier identified with the
-	 * app name, especially if the app registers more than one provider.
-	 *
-	 * Example: 'mail', 'mail_recipients', 'files_sharing'
-	 *
-	 * @return string
-	 *
-	 * @since 20.0.0
-	 */
-	public function getId(): string;
+    /**
+     * Get the unique ID of this search provider
+     *
+     * Ideally this should be the app name or an identifier identified with the
+     * app name, especially if the app registers more than one provider.
+     *
+     * Example: 'mail', 'mail_recipients', 'files_sharing'
+     *
+     * @return string
+     *
+     * @since 20.0.0
+     */
+    public function getId(): string;
 
-	/**
-	 * Get the translated name of this search provider
-	 *
-	 * Example: 'Mail', 'Contacts'...
-	 *
-	 * @return string
-	 *
-	 * @since 20.0.0
-	 */
-	public function getName(): string;
+    /**
+     * Get the translated name of this search provider
+     *
+     * Example: 'Mail', 'Contacts'...
+     *
+     * @return string
+     *
+     * @since 20.0.0
+     */
+    public function getName(): string;
 
-	/**
-	 * Get the search provider order
-	 * The lower the int, the higher it will be sorted (0 will be before 10)
-	 *
-	 * @param string $route the route the user is currently at, e.g. files.view.index
-	 * @param array $routeParameters the parameters of the route the user is currently at, e.g. [fileId = 982, dir = "/"]
-	 *
-	 * @return int
-	 *
-	 * @since 20.0.0
-	 */
-	public function getOrder(string $route, array $routeParameters): int;
+    /**
+     * Get the search provider order
+     * The lower the int, the higher it will be sorted (0 will be before 10)
+     *
+     * @param string $route the route the user is currently at, e.g. files.view.index
+     * @param array $routeParameters the parameters of the route the user is currently at, e.g. [fileId = 982, dir = "/"]
+     *
+     * @return int
+     *
+     * @since 20.0.0
+     */
+    public function getOrder(string $route, array $routeParameters): int;
 
-	/**
-	 * Find matching search entries in an app
-	 *
-	 * Search results can either be a complete list of all the matches the app can
-	 * find, or ideally a paginated result set where more data can be fetched on
-	 * demand. To be able to tell where the next offset starts the search uses
-	 * "cursors" which are a property of the last result entry. E.g. search results
-	 * that show most recent entries first can look for entries older than the last
-	 * one of the first result set. This approach was chosen over a numeric limit/
-	 * offset approach as the offset moves as new data comes in. The cursor is
-	 * resistant to these changes and will still show results without overlaps or
-	 * gaps.
-	 *
-	 * See https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89
-	 * for the concept of cursors.
-	 *
-	 * Implementations that return result pages have to adhere to the limit
-	 * property of a search query.
-	 *
-	 * @param IUser $user
-	 * @param ISearchQuery $query
-	 *
-	 * @return SearchResult
-	 *
-	 * @since 20.0.0
-	 */
-	public function search(IUser $user, ISearchQuery $query): SearchResult;
+    /**
+     * Find matching search entries in an app
+     *
+     * Search results can either be a complete list of all the matches the app can
+     * find, or ideally a paginated result set where more data can be fetched on
+     * demand. To be able to tell where the next offset starts the search uses
+     * "cursors" which are a property of the last result entry. E.g. search results
+     * that show most recent entries first can look for entries older than the last
+     * one of the first result set. This approach was chosen over a numeric limit/
+     * offset approach as the offset moves as new data comes in. The cursor is
+     * resistant to these changes and will still show results without overlaps or
+     * gaps.
+     *
+     * See https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89
+     * for the concept of cursors.
+     *
+     * Implementations that return result pages have to adhere to the limit
+     * property of a search query.
+     *
+     * @param IUser $user
+     * @param ISearchQuery $query
+     *
+     * @return SearchResult
+     *
+     * @since 20.0.0
+     */
+    public function search(IUser $user, ISearchQuery $query): SearchResult;
 }

lib/public/Search/ISearchQuery.php

Indentation +44 added lines, -44 removed lines

@@ -38,54 +38,54 @@
  */
 interface ISearchQuery {
 
-	/**
-	 * @since 20.0.0
-	 */
-	public const SORT_DATE_DESC = 1;
+    /**
+     * @since 20.0.0
+     */
+    public const SORT_DATE_DESC = 1;
 
-	/**
-	 * Get the user-entered search term to find matches for
-	 *
-	 * @return string the search term
-	 * @since 20.0.0
-	 */
-	public function getTerm(): string;
+    /**
+     * Get the user-entered search term to find matches for
+     *
+     * @return string the search term
+     * @since 20.0.0
+     */
+    public function getTerm(): string;
 
-	/**
-	 * Get the sort order of results as defined as SORT_* constants on this interface
-	 *
-	 * @return int
-	 * @since 20.0.0
-	 */
-	public function getSortOrder(): int;
+    /**
+     * Get the sort order of results as defined as SORT_* constants on this interface
+     *
+     * @return int
+     * @since 20.0.0
+     */
+    public function getSortOrder(): int;
 
-	/**
-	 * Get the number of items to return for a paginated result
-	 *
-	 * @return int
-	 * @see \OCP\Search\IProvider for details
-	 * @since 20.0.0
-	 */
-	public function getLimit(): int;
+    /**
+     * Get the number of items to return for a paginated result
+     *
+     * @return int
+     * @see \OCP\Search\IProvider for details
+     * @since 20.0.0
+     */
+    public function getLimit(): int;
 
-	/**
-	 * Get the app-specific cursor of the tail of the previous result entries
-	 *
-	 * @return int|string|null
-	 * @see \OCP\Search\IProvider for details
-	 * @since 20.0.0
-	 */
-	public function getCursor();
+    /**
+     * Get the app-specific cursor of the tail of the previous result entries
+     *
+     * @return int|string|null
+     * @see \OCP\Search\IProvider for details
+     * @since 20.0.0
+     */
+    public function getCursor();
 
-	/**
-	 * @return string
-	 * @since 20.0.0
-	 */
-	public function getRoute(): string;
+    /**
+     * @return string
+     * @since 20.0.0
+     */
+    public function getRoute(): string;
 
-	/**
-	 * @return array
-	 * @since 20.0.0
-	 */
-	public function getRouteParameters(): array;
+    /**
+     * @return array
+     * @since 20.0.0
+     */
+    public function getRouteParameters(): array;
 }