nextcloud / server

lib/public/FullTextSearch/Model/ISearchOption.php

Indentation +126 added lines, -126 removed lines

@@ -33,130 +33,130 @@
  *
  */
 interface ISearchOption {
-	/**
-	 * @since 16.0.0
-	 */
-	public const CHECKBOX = 'checkbox';
-
-	/**
-	 * @since 16.0.0
-	 */
-	public const INPUT = 'input';
-
-	/**
-	 * @since 16.0.0
-	 */
-	public const INPUT_SMALL = 'small';
-
-
-	/**
-	 * Set the name/key of the option.
-	 * The string should only contains alphanumerical chars and underscore.
-	 * The key can be retrieve when using ISearchRequest::getOption
-	 *
-	 * @see ISearchRequest::getOption
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $name
-	 *
-	 * @return ISearchOption
-	 */
-	public function setName(string $name): ISearchOption;
-
-	/**
-	 * Get the name/key of the option.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getName(): string;
-
-
-	/**
-	 * Set the title/display name of the option.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $title
-	 *
-	 * @return ISearchOption
-	 */
-	public function setTitle(string $title): ISearchOption;
-
-	/**
-	 * Get the title of the option.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getTitle(): string;
-
-
-	/**
-	 * Set the type of the option.
-	 * $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $type
-	 *
-	 * @return ISearchOption
-	 */
-	public function setType(string $type): ISearchOption;
-
-	/**
-	 * Get the type of the option.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getType(): string;
-
-
-	/**
-	 * In case of Type is INPUT, set the size of the input field.
-	 * Value can be ISearchOption::INPUT_SMALL or not defined.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $size
-	 *
-	 * @return ISearchOption
-	 */
-	public function setSize(string $size): ISearchOption;
-
-	/**
-	 * Get the size of the INPUT.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getSize(): string;
-
-
-	/**
-	 * In case of Type is , set the placeholder to be displayed in the input
-	 * field.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $placeholder
-	 *
-	 * @return ISearchOption
-	 */
-	public function setPlaceholder(string $placeholder): ISearchOption;
-
-	/**
-	 * Get the placeholder.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getPlaceholder(): string;
+    /**
+     * @since 16.0.0
+     */
+    public const CHECKBOX = 'checkbox';
+
+    /**
+     * @since 16.0.0
+     */
+    public const INPUT = 'input';
+
+    /**
+     * @since 16.0.0
+     */
+    public const INPUT_SMALL = 'small';
+
+
+    /**
+     * Set the name/key of the option.
+     * The string should only contains alphanumerical chars and underscore.
+     * The key can be retrieve when using ISearchRequest::getOption
+     *
+     * @see ISearchRequest::getOption
+     *
+     * @since 16.0.0
+     *
+     * @param string $name
+     *
+     * @return ISearchOption
+     */
+    public function setName(string $name): ISearchOption;
+
+    /**
+     * Get the name/key of the option.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getName(): string;
+
+
+    /**
+     * Set the title/display name of the option.
+     *
+     * @since 16.0.0
+     *
+     * @param string $title
+     *
+     * @return ISearchOption
+     */
+    public function setTitle(string $title): ISearchOption;
+
+    /**
+     * Get the title of the option.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getTitle(): string;
+
+
+    /**
+     * Set the type of the option.
+     * $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
+     *
+     * @since 16.0.0
+     *
+     * @param string $type
+     *
+     * @return ISearchOption
+     */
+    public function setType(string $type): ISearchOption;
+
+    /**
+     * Get the type of the option.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getType(): string;
+
+
+    /**
+     * In case of Type is INPUT, set the size of the input field.
+     * Value can be ISearchOption::INPUT_SMALL or not defined.
+     *
+     * @since 16.0.0
+     *
+     * @param string $size
+     *
+     * @return ISearchOption
+     */
+    public function setSize(string $size): ISearchOption;
+
+    /**
+     * Get the size of the INPUT.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getSize(): string;
+
+
+    /**
+     * In case of Type is , set the placeholder to be displayed in the input
+     * field.
+     *
+     * @since 16.0.0
+     *
+     * @param string $placeholder
+     *
+     * @return ISearchOption
+     */
+    public function setPlaceholder(string $placeholder): ISearchOption;
+
+    /**
+     * Get the placeholder.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getPlaceholder(): string;
 }

lib/public/FullTextSearch/Model/ISearchRequest.php

Indentation +311 added lines, -311 removed lines

@@ -43,315 +43,315 @@
  *
  */
 interface ISearchRequest {
-	/**
-	 * Get the maximum number of results to be returns by the Search Platform.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getSize(): int;
-
-
-	/**
-	 * Get the current page.
-	 * Used by pagination.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	public function getPage(): int;
-
-
-	/**
-	 * Get the author of the request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getAuthor(): string;
-
-	/**
-	 * Get the searched string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getSearch(): string;
-
-	/**
-	 * Set the searched string.
-	 *
-	 * @param string $search
-	 *
-	 * @since 17.0.0
-	 *
-	 * @return ISearchRequest
-	 */
-	public function setSearch(string $search): ISearchRequest;
-
-	/**
-	 * Extends the searched string.
-	 *
-	 * @since 17.0.0
-	 *
-	 * @param string $search
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addSearch(string $search): ISearchRequest;
-
-
-	/**
-	 * Get the value of an option (as string).
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param string $default
-	 *
-	 * @return string
-	 */
-	public function getOption(string $option, string $default = ''): string;
-
-	/**
-	 * Get the value of an option (as array).
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param array $default
-	 *
-	 * @return array
-	 */
-	public function getOptionArray(string $option, array $default = []): array;
-
-
-	/**
-	 * Limit the search to a part of the document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $part
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addPart(string $part): ISearchRequest;
-
-	/**
-	 * Limit the search to an array of parts of the document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $parts
-	 *
-	 * @return ISearchRequest
-	 */
-	public function setParts(array $parts): ISearchRequest;
-
-	/**
-	 * Get the parts the search is limited to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getParts(): array;
-
-
-	/**
-	 * Limit the search to a specific meta tag.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addMetaTag(string $tag): ISearchRequest;
-
-	/**
-	 * Get the meta tags the search is limited to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getMetaTags(): array;
-
-	/**
-	 * Limit the search to an array of meta tags.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return ISearchRequest
-	 */
-	public function setMetaTags(array $tags): ISearchRequest;
-
-
-	/**
-	 * Limit the search to a specific sub tag.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $source
-	 * @param string $tag
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addSubTag(string $source, string $tag): ISearchRequest;
-
-	/**
-	 * Get the sub tags the search is limited to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param bool $formatted
-	 *
-	 * @return array
-	 */
-	public function getSubTags(bool $formatted): array;
-
-	/**
-	 * Limit the search to an array of sub tags.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return ISearchRequest
-	 */
-	public function setSubTags(array $tags): ISearchRequest;
-
-
-	/**
-	 * Limit the search to a specific field of the mapping, using a full string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addLimitField(string $field): ISearchRequest;
-
-	/**
-	 * Get the fields the search is limited to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getLimitFields(): array;
-
-
-	/**
-	 * Limit the search to a specific field of the mapping, using a wildcard on
-	 * the search string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addWildcardField(string $field): ISearchRequest;
-
-	/**
-	 * Get the limit to field of the mapping.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getWildcardFields(): array;
-
-
-	/**
-	 * Filter the results, based on a group of field, using regex
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $filters
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addRegexFilters(array $filters): ISearchRequest;
-
-	/**
-	 * Get the regex filters the search is limit to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getRegexFilters(): array;
-
-
-	/**
-	 * Filter the results, based on a group of field, using wildcard
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $filter
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addWildcardFilter(array $filter): ISearchRequest;
-
-	/**
-	 * Get the wildcard filters the search is limit to.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getWildcardFilters(): array;
-
-
-	/**
-	 * Add an extra field to the search.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $field
-	 *
-	 * @return ISearchRequest
-	 */
-	public function addField(string $field): ISearchRequest;
-
-	/**
-	 * Get the list of extra field to search into.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getFields(): array;
-
-
-
-	/**
-	 * Add a MUST search on an extra field
-	 *
-	 * @param ISearchRequestSimpleQuery $query
-	 *
-	 * @return ISearchRequest
-	 * @since 17.0.0
-	 */
-	public function addSimpleQuery(ISearchRequestSimpleQuery $query): ISearchRequest;
-
-
-	/**
-	 * Get the list of queries on extra field.
-	 *
-	 * @return ISearchRequestSimpleQuery[]
-	 * @since 17.0.0
-	 */
-	public function getSimpleQueries(): array;
+    /**
+     * Get the maximum number of results to be returns by the Search Platform.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getSize(): int;
+
+
+    /**
+     * Get the current page.
+     * Used by pagination.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    public function getPage(): int;
+
+
+    /**
+     * Get the author of the request.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getAuthor(): string;
+
+    /**
+     * Get the searched string.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getSearch(): string;
+
+    /**
+     * Set the searched string.
+     *
+     * @param string $search
+     *
+     * @since 17.0.0
+     *
+     * @return ISearchRequest
+     */
+    public function setSearch(string $search): ISearchRequest;
+
+    /**
+     * Extends the searched string.
+     *
+     * @since 17.0.0
+     *
+     * @param string $search
+     *
+     * @return ISearchRequest
+     */
+    public function addSearch(string $search): ISearchRequest;
+
+
+    /**
+     * Get the value of an option (as string).
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param string $default
+     *
+     * @return string
+     */
+    public function getOption(string $option, string $default = ''): string;
+
+    /**
+     * Get the value of an option (as array).
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param array $default
+     *
+     * @return array
+     */
+    public function getOptionArray(string $option, array $default = []): array;
+
+
+    /**
+     * Limit the search to a part of the document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $part
+     *
+     * @return ISearchRequest
+     */
+    public function addPart(string $part): ISearchRequest;
+
+    /**
+     * Limit the search to an array of parts of the document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $parts
+     *
+     * @return ISearchRequest
+     */
+    public function setParts(array $parts): ISearchRequest;
+
+    /**
+     * Get the parts the search is limited to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getParts(): array;
+
+
+    /**
+     * Limit the search to a specific meta tag.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return ISearchRequest
+     */
+    public function addMetaTag(string $tag): ISearchRequest;
+
+    /**
+     * Get the meta tags the search is limited to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getMetaTags(): array;
+
+    /**
+     * Limit the search to an array of meta tags.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return ISearchRequest
+     */
+    public function setMetaTags(array $tags): ISearchRequest;
+
+
+    /**
+     * Limit the search to a specific sub tag.
+     *
+     * @since 15.0.0
+     *
+     * @param string $source
+     * @param string $tag
+     *
+     * @return ISearchRequest
+     */
+    public function addSubTag(string $source, string $tag): ISearchRequest;
+
+    /**
+     * Get the sub tags the search is limited to.
+     *
+     * @since 15.0.0
+     *
+     * @param bool $formatted
+     *
+     * @return array
+     */
+    public function getSubTags(bool $formatted): array;
+
+    /**
+     * Limit the search to an array of sub tags.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return ISearchRequest
+     */
+    public function setSubTags(array $tags): ISearchRequest;
+
+
+    /**
+     * Limit the search to a specific field of the mapping, using a full string.
+     *
+     * @since 15.0.0
+     *
+     * @param string $field
+     *
+     * @return ISearchRequest
+     */
+    public function addLimitField(string $field): ISearchRequest;
+
+    /**
+     * Get the fields the search is limited to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getLimitFields(): array;
+
+
+    /**
+     * Limit the search to a specific field of the mapping, using a wildcard on
+     * the search string.
+     *
+     * @since 15.0.0
+     *
+     * @param string $field
+     *
+     * @return ISearchRequest
+     */
+    public function addWildcardField(string $field): ISearchRequest;
+
+    /**
+     * Get the limit to field of the mapping.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getWildcardFields(): array;
+
+
+    /**
+     * Filter the results, based on a group of field, using regex
+     *
+     * @since 15.0.0
+     *
+     * @param array $filters
+     *
+     * @return ISearchRequest
+     */
+    public function addRegexFilters(array $filters): ISearchRequest;
+
+    /**
+     * Get the regex filters the search is limit to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getRegexFilters(): array;
+
+
+    /**
+     * Filter the results, based on a group of field, using wildcard
+     *
+     * @since 15.0.0
+     *
+     * @param array $filter
+     *
+     * @return ISearchRequest
+     */
+    public function addWildcardFilter(array $filter): ISearchRequest;
+
+    /**
+     * Get the wildcard filters the search is limit to.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getWildcardFilters(): array;
+
+
+    /**
+     * Add an extra field to the search.
+     *
+     * @since 15.0.0
+     *
+     * @param string $field
+     *
+     * @return ISearchRequest
+     */
+    public function addField(string $field): ISearchRequest;
+
+    /**
+     * Get the list of extra field to search into.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getFields(): array;
+
+
+
+    /**
+     * Add a MUST search on an extra field
+     *
+     * @param ISearchRequestSimpleQuery $query
+     *
+     * @return ISearchRequest
+     * @since 17.0.0
+     */
+    public function addSimpleQuery(ISearchRequestSimpleQuery $query): ISearchRequest;
+
+
+    /**
+     * Get the list of queries on extra field.
+     *
+     * @return ISearchRequestSimpleQuery[]
+     * @since 17.0.0
+     */
+    public function getSimpleQueries(): array;
 }

lib/public/FullTextSearch/Model/ISearchResult.php

Indentation +137 added lines, -137 removed lines

@@ -46,141 +46,141 @@
  *
  */
 interface ISearchResult {
-	/**
-	 * Get the original SearchRequest.
-	 *
-	 * @see ISearchRequest
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return ISearchRequest
-	 */
-	public function getRequest(): ISearchRequest;
-
-	/**
-	 * Get the targeted Content Provider.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IFullTextSearchProvider
-	 */
-	public function getProvider(): IFullTextSearchProvider;
-
-
-	/**
-	 * Add an IIndexDocument as one of the result of the search request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexDocument $document
-	 *
-	 * @return ISearchResult
-	 */
-	public function addDocument(IIndexDocument $document): ISearchResult;
-
-	/**
-	 * Returns all result of the search request, in an array of IIndexDocument.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndexDocument[]
-	 */
-	public function getDocuments(): array;
-
-	/**
-	 * Set an array of IIndexDocument as the result of the search request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexDocument[] $documents
-	 *
-	 * @return ISearchResult
-	 */
-	public function setDocuments(array $documents): ISearchResult;
-
-
-	/**
-	 * Add an aggregation to the result.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $category
-	 * @param string $value
-	 * @param int $count
-	 *
-	 * @return ISearchResult
-	 */
-	public function addAggregation(string $category, string $value, int $count): ISearchResult;
-
-	/**
-	 * Get all aggregations.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $category
-	 *
-	 * @return array
-	 */
-	public function getAggregations(string $category): array;
-
-
-	/**
-	 * Set the raw result of the request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $result
-	 *
-	 * @return ISearchResult
-	 */
-	public function setRawResult(string $result): ISearchResult;
-
-
-	/**
-	 * Set the total number of results for the search request.
-	 * Used by pagination.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $total
-	 *
-	 * @return ISearchResult
-	 */
-	public function setTotal(int $total): ISearchResult;
-
-
-	/**
-	 * Set the top score for the search request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $score
-	 *
-	 * @return ISearchResult
-	 */
-	public function setMaxScore(int $score): ISearchResult;
-
-
-	/**
-	 * Set the time spent by the request to perform the search.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $time
-	 *
-	 * @return ISearchResult
-	 */
-	public function setTime(int $time): ISearchResult;
-
-
-	/**
-	 * Set to true if the request timed out.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param bool $timedOut
-	 *
-	 * @return ISearchResult
-	 */
-	public function setTimedOut(bool $timedOut): ISearchResult;
+    /**
+     * Get the original SearchRequest.
+     *
+     * @see ISearchRequest
+     *
+     * @since 15.0.0
+     *
+     * @return ISearchRequest
+     */
+    public function getRequest(): ISearchRequest;
+
+    /**
+     * Get the targeted Content Provider.
+     *
+     * @since 15.0.0
+     *
+     * @return IFullTextSearchProvider
+     */
+    public function getProvider(): IFullTextSearchProvider;
+
+
+    /**
+     * Add an IIndexDocument as one of the result of the search request.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexDocument $document
+     *
+     * @return ISearchResult
+     */
+    public function addDocument(IIndexDocument $document): ISearchResult;
+
+    /**
+     * Returns all result of the search request, in an array of IIndexDocument.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndexDocument[]
+     */
+    public function getDocuments(): array;
+
+    /**
+     * Set an array of IIndexDocument as the result of the search request.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexDocument[] $documents
+     *
+     * @return ISearchResult
+     */
+    public function setDocuments(array $documents): ISearchResult;
+
+
+    /**
+     * Add an aggregation to the result.
+     *
+     * @since 15.0.0
+     *
+     * @param string $category
+     * @param string $value
+     * @param int $count
+     *
+     * @return ISearchResult
+     */
+    public function addAggregation(string $category, string $value, int $count): ISearchResult;
+
+    /**
+     * Get all aggregations.
+     *
+     * @since 15.0.0
+     *
+     * @param string $category
+     *
+     * @return array
+     */
+    public function getAggregations(string $category): array;
+
+
+    /**
+     * Set the raw result of the request.
+     *
+     * @since 15.0.0
+     *
+     * @param string $result
+     *
+     * @return ISearchResult
+     */
+    public function setRawResult(string $result): ISearchResult;
+
+
+    /**
+     * Set the total number of results for the search request.
+     * Used by pagination.
+     *
+     * @since 15.0.0
+     *
+     * @param int $total
+     *
+     * @return ISearchResult
+     */
+    public function setTotal(int $total): ISearchResult;
+
+
+    /**
+     * Set the top score for the search request.
+     *
+     * @since 15.0.0
+     *
+     * @param int $score
+     *
+     * @return ISearchResult
+     */
+    public function setMaxScore(int $score): ISearchResult;
+
+
+    /**
+     * Set the time spent by the request to perform the search.
+     *
+     * @since 15.0.0
+     *
+     * @param int $time
+     *
+     * @return ISearchResult
+     */
+    public function setTime(int $time): ISearchResult;
+
+
+    /**
+     * Set to true if the request timed out.
+     *
+     * @since 15.0.0
+     *
+     * @param bool $timedOut
+     *
+     * @return ISearchResult
+     */
+    public function setTimedOut(bool $timedOut): ISearchResult;
 }

lib/public/FullTextSearch/Model/ISearchTemplate.php

Indentation +112 added lines, -112 removed lines

@@ -52,116 +52,116 @@
  *
  */
 interface ISearchTemplate {
-	/**
-	 * Set the class of the icon to be displayed in the left panel of the
-	 * FullTextSearch navigation page, in front of the related Content Provider.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $class
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setIcon(string $class): ISearchTemplate;
-
-	/**
-	 * Get the class of the icon.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getIcon(): string;
-
-
-	/**
-	 * Set the path of a CSS file that will be loaded when needed.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $css
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setCss(string $css): ISearchTemplate;
-
-	/**
-	 * Get the path of the CSS file.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getCss(): string;
-
-
-	/**
-	 * Set the path of the file of a template that the HTML will be displayed
-	 * below the Options.
-	 * This should only be used if your Content Provider needs to set options in
-	 * a way not generated by FullTextSearch
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $template
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setTemplate(string $template): ISearchTemplate;
-
-	/**
-	 * Get the path of the template file.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getTemplate(): string;
-
-
-	/**
-	 * Add an option in the Panel that is displayed when the user start a search
-	 * within the app that generate the content.
-	 *
-	 * @see ISearchOption
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param ISearchOption $option
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function addPanelOption(ISearchOption $option): ISearchTemplate;
-
-	/**
-	 * Get all options to be displayed in the Panel.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return ISearchOption[]
-	 */
-	public function getPanelOptions(): array;
-
-
-	/**
-	 * Add an option in the left panel of the FullTextSearch navigation page.
-	 *
-	 * @see ISearchOption
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param ISearchOption $option
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function addNavigationOption(ISearchOption $option): ISearchTemplate;
-
-	/**
-	 * Get all options to be displayed in the FullTextSearch navigation page.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getNavigationOptions(): array;
+    /**
+     * Set the class of the icon to be displayed in the left panel of the
+     * FullTextSearch navigation page, in front of the related Content Provider.
+     *
+     * @since 16.0.0
+     *
+     * @param string $class
+     *
+     * @return ISearchTemplate
+     */
+    public function setIcon(string $class): ISearchTemplate;
+
+    /**
+     * Get the class of the icon.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getIcon(): string;
+
+
+    /**
+     * Set the path of a CSS file that will be loaded when needed.
+     *
+     * @since 16.0.0
+     *
+     * @param string $css
+     *
+     * @return ISearchTemplate
+     */
+    public function setCss(string $css): ISearchTemplate;
+
+    /**
+     * Get the path of the CSS file.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getCss(): string;
+
+
+    /**
+     * Set the path of the file of a template that the HTML will be displayed
+     * below the Options.
+     * This should only be used if your Content Provider needs to set options in
+     * a way not generated by FullTextSearch
+     *
+     * @since 16.0.0
+     *
+     * @param string $template
+     *
+     * @return ISearchTemplate
+     */
+    public function setTemplate(string $template): ISearchTemplate;
+
+    /**
+     * Get the path of the template file.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getTemplate(): string;
+
+
+    /**
+     * Add an option in the Panel that is displayed when the user start a search
+     * within the app that generate the content.
+     *
+     * @see ISearchOption
+     *
+     * @since 16.0.0
+     *
+     * @param ISearchOption $option
+     *
+     * @return ISearchTemplate
+     */
+    public function addPanelOption(ISearchOption $option): ISearchTemplate;
+
+    /**
+     * Get all options to be displayed in the Panel.
+     *
+     * @since 16.0.0
+     *
+     * @return ISearchOption[]
+     */
+    public function getPanelOptions(): array;
+
+
+    /**
+     * Add an option in the left panel of the FullTextSearch navigation page.
+     *
+     * @see ISearchOption
+     *
+     * @since 16.0.0
+     *
+     * @param ISearchOption $option
+     *
+     * @return ISearchTemplate
+     */
+    public function addNavigationOption(ISearchOption $option): ISearchTemplate;
+
+    /**
+     * Get all options to be displayed in the FullTextSearch navigation page.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getNavigationOptions(): array;
 }

lib/public/FullTextSearch/Model/IDocumentAccess.php

Indentation +205 added lines, -205 removed lines

@@ -45,209 +45,209 @@
  *
  */
 interface IDocumentAccess {
-	/**
-	 * Owner of the document can be set at the init of the object.
-	 *
-	 * @since 16.0.0
-	 *
-	 * IDocumentAccess constructor.
-	 *
-	 * @param string $ownerId
-	 */
-	public function __construct(string $ownerId = '');
-
-
-	/**
-	 * Set the Owner of the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $ownerId
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setOwnerId(string $ownerId): IDocumentAccess;
-
-	/**
-	 * Get the Owner of the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getOwnerId(): string;
-
-
-	/**
-	 * Set the viewer of the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $viewerId
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setViewerId(string $viewerId): IDocumentAccess;
-
-	/**
-	 * Get the viewer of the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return string
-	 */
-	public function getViewerId(): string;
-
-
-	/**
-	 * Set the list of users that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $users
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setUsers(array $users): IDocumentAccess;
-
-	/**
-	 * Add an entry to the list of users that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $user
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addUser(string $user): IDocumentAccess;
-
-	/**
-	 * Add multiple entries to the list of users that have read access to the
-	 * document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $users
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addUsers($users): IDocumentAccess;
-
-	/**
-	 * Get the complete list of users that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getUsers(): array;
-
-
-	/**
-	 * Set the list of groups that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $groups
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setGroups(array $groups): IDocumentAccess;
-
-	/**
-	 * Add an entry to the list of groups that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $group
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addGroup(string $group): IDocumentAccess;
-
-	/**
-	 * Add multiple entries to the list of groups that have read access to the
-	 * document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $groups
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addGroups(array $groups);
-
-	/**
-	 * Get the complete list of groups that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getGroups(): array;
-
-
-	/**
-	 * Set the list of circles that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $circles
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setCircles(array $circles): IDocumentAccess;
-
-	/**
-	 * Add an entry to the list of circles that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $circle
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addCircle(string $circle): IDocumentAccess;
-
-	/**
-	 * Add multiple entries to the list of groups that have read access to the
-	 * document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $circles
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function addCircles(array $circles): IDocumentAccess;
-
-	/**
-	 * Get the complete list of circles that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getCircles(): array;
-
-
-	/**
-	 * Set the list of links that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $links
-	 *
-	 * @return IDocumentAccess
-	 */
-	public function setLinks(array $links): IDocumentAccess;
-
-	/**
-	 * Get the list of links that have read access to the document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return array
-	 */
-	public function getLinks(): array;
+    /**
+     * Owner of the document can be set at the init of the object.
+     *
+     * @since 16.0.0
+     *
+     * IDocumentAccess constructor.
+     *
+     * @param string $ownerId
+     */
+    public function __construct(string $ownerId = '');
+
+
+    /**
+     * Set the Owner of the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $ownerId
+     *
+     * @return IDocumentAccess
+     */
+    public function setOwnerId(string $ownerId): IDocumentAccess;
+
+    /**
+     * Get the Owner of the document.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getOwnerId(): string;
+
+
+    /**
+     * Set the viewer of the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $viewerId
+     *
+     * @return IDocumentAccess
+     */
+    public function setViewerId(string $viewerId): IDocumentAccess;
+
+    /**
+     * Get the viewer of the document.
+     *
+     * @since 16.0.0
+     *
+     * @return string
+     */
+    public function getViewerId(): string;
+
+
+    /**
+     * Set the list of users that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $users
+     *
+     * @return IDocumentAccess
+     */
+    public function setUsers(array $users): IDocumentAccess;
+
+    /**
+     * Add an entry to the list of users that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $user
+     *
+     * @return IDocumentAccess
+     */
+    public function addUser(string $user): IDocumentAccess;
+
+    /**
+     * Add multiple entries to the list of users that have read access to the
+     * document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $users
+     *
+     * @return IDocumentAccess
+     */
+    public function addUsers($users): IDocumentAccess;
+
+    /**
+     * Get the complete list of users that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getUsers(): array;
+
+
+    /**
+     * Set the list of groups that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $groups
+     *
+     * @return IDocumentAccess
+     */
+    public function setGroups(array $groups): IDocumentAccess;
+
+    /**
+     * Add an entry to the list of groups that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $group
+     *
+     * @return IDocumentAccess
+     */
+    public function addGroup(string $group): IDocumentAccess;
+
+    /**
+     * Add multiple entries to the list of groups that have read access to the
+     * document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $groups
+     *
+     * @return IDocumentAccess
+     */
+    public function addGroups(array $groups);
+
+    /**
+     * Get the complete list of groups that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getGroups(): array;
+
+
+    /**
+     * Set the list of circles that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $circles
+     *
+     * @return IDocumentAccess
+     */
+    public function setCircles(array $circles): IDocumentAccess;
+
+    /**
+     * Add an entry to the list of circles that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param string $circle
+     *
+     * @return IDocumentAccess
+     */
+    public function addCircle(string $circle): IDocumentAccess;
+
+    /**
+     * Add multiple entries to the list of groups that have read access to the
+     * document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $circles
+     *
+     * @return IDocumentAccess
+     */
+    public function addCircles(array $circles): IDocumentAccess;
+
+    /**
+     * Get the complete list of circles that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getCircles(): array;
+
+
+    /**
+     * Set the list of links that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $links
+     *
+     * @return IDocumentAccess
+     */
+    public function setLinks(array $links): IDocumentAccess;
+
+    /**
+     * Get the list of links that have read access to the document.
+     *
+     * @since 16.0.0
+     *
+     * @return array
+     */
+    public function getLinks(): array;
 }

lib/public/FullTextSearch/IFullTextSearchPlatform.php

Indentation +141 added lines, -141 removed lines

@@ -70,145 +70,145 @@
  *
  */
 interface IFullTextSearchPlatform {
-	/**
-	 * Must returns a unique Id used to identify the Search Platform.
-	 * Id must contains only alphanumeric chars, with no space.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getId(): string;
-
-
-	/**
-	 * Must returns a descriptive name of the Search Platform.
-	 * This is used mainly in the admin settings page to display the list of
-	 * available Search Platform
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getName(): string;
-
-
-	/**
-	 * should returns the current configuration of the Search Platform.
-	 * This is used to display the configuration when using the
-	 * ./occ fulltextsearch:check command line.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getConfiguration(): array;
-
-
-	/**
-	 * Set the wrapper of the currently executed process.
-	 * Because the index process can be long and heavy, and because errors can
-	 * be encountered during the process, the IRunner is a wrapper that allow the
-	 * Search Platform to communicate with the process initiated by
-	 * FullTextSearch.
-	 *
-	 * The IRunner is coming with some methods so the Search Platform can
-	 * returns important information and errors to be displayed to the admin.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IRunner $runner
-	 */
-	public function setRunner(IRunner $runner);
-
-
-	/**
-	 * Called when FullTextSearch is loading your Search Platform.
-	 *
-	 * @since 15.0.0
-	 */
-	public function loadPlatform();
-
-
-	/**
-	 * Called to check that your Search Platform is correctly configured and that
-	 * This is also the right place to check that the Search Service is available.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return bool
-	 */
-	public function testPlatform(): bool;
-
-
-	/**
-	 * Called before an index is initiated.
-	 * Best place to initiate some stuff on the Search Server (mapping, ...)
-	 *
-	 * @since 15.0.0
-	 */
-	public function initializeIndex();
-
-
-	/**
-	 * Reset the indexes for a specific providerId.
-	 * $providerId can be 'all' if it is a global reset.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 */
-	public function resetIndex(string $providerId);
-
-
-	/**
-	 * Deleting some IIndex, sent in an array
-	 *
-	 * @see IIndex
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex[] $indexes
-	 */
-	public function deleteIndexes(array $indexes);
-
-
-	/**
-	 * Indexing a document.
-	 *
-	 * @see IndexDocument
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexDocument $document
-	 *
-	 * @return IIndex
-	 */
-	public function indexDocument(IIndexDocument $document): IIndex;
-
-
-	/**
-	 * Searching documents, ISearchResult should be updated with the result of
-	 * the search.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchResult $result
-	 * @param IDocumentAccess $access
-	 */
-	public function searchRequest(ISearchResult $result, IDocumentAccess $access);
-
-
-	/**
-	 * Return a document based on its Id and the Provider.
-	 * This is used when an admin execute ./occ fulltextsearch:document:platform
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 *
-	 * @return IIndexDocument
-	 */
-	public function getDocument(string $providerId, string $documentId): IIndexDocument;
+    /**
+     * Must returns a unique Id used to identify the Search Platform.
+     * Id must contains only alphanumeric chars, with no space.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getId(): string;
+
+
+    /**
+     * Must returns a descriptive name of the Search Platform.
+     * This is used mainly in the admin settings page to display the list of
+     * available Search Platform
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getName(): string;
+
+
+    /**
+     * should returns the current configuration of the Search Platform.
+     * This is used to display the configuration when using the
+     * ./occ fulltextsearch:check command line.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getConfiguration(): array;
+
+
+    /**
+     * Set the wrapper of the currently executed process.
+     * Because the index process can be long and heavy, and because errors can
+     * be encountered during the process, the IRunner is a wrapper that allow the
+     * Search Platform to communicate with the process initiated by
+     * FullTextSearch.
+     *
+     * The IRunner is coming with some methods so the Search Platform can
+     * returns important information and errors to be displayed to the admin.
+     *
+     * @since 15.0.0
+     *
+     * @param IRunner $runner
+     */
+    public function setRunner(IRunner $runner);
+
+
+    /**
+     * Called when FullTextSearch is loading your Search Platform.
+     *
+     * @since 15.0.0
+     */
+    public function loadPlatform();
+
+
+    /**
+     * Called to check that your Search Platform is correctly configured and that
+     * This is also the right place to check that the Search Service is available.
+     *
+     * @since 15.0.0
+     *
+     * @return bool
+     */
+    public function testPlatform(): bool;
+
+
+    /**
+     * Called before an index is initiated.
+     * Best place to initiate some stuff on the Search Server (mapping, ...)
+     *
+     * @since 15.0.0
+     */
+    public function initializeIndex();
+
+
+    /**
+     * Reset the indexes for a specific providerId.
+     * $providerId can be 'all' if it is a global reset.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     */
+    public function resetIndex(string $providerId);
+
+
+    /**
+     * Deleting some IIndex, sent in an array
+     *
+     * @see IIndex
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex[] $indexes
+     */
+    public function deleteIndexes(array $indexes);
+
+
+    /**
+     * Indexing a document.
+     *
+     * @see IndexDocument
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexDocument $document
+     *
+     * @return IIndex
+     */
+    public function indexDocument(IIndexDocument $document): IIndex;
+
+
+    /**
+     * Searching documents, ISearchResult should be updated with the result of
+     * the search.
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchResult $result
+     * @param IDocumentAccess $access
+     */
+    public function searchRequest(ISearchResult $result, IDocumentAccess $access);
+
+
+    /**
+     * Return a document based on its Id and the Provider.
+     * This is used when an admin execute ./occ fulltextsearch:document:platform
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     *
+     * @return IIndexDocument
+     */
+    public function getDocument(string $providerId, string $documentId): IIndexDocument;
 }

lib/public/FullTextSearch/IFullTextSearchManager.php

Indentation +139 added lines, -139 removed lines

@@ -41,143 +41,143 @@
  *
  */
 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/public/Files/Events/BeforeFolderScannedEvent.php

Indentation +18 added lines, -18 removed lines

@@ -31,24 +31,24 @@
  * @since 18.0.0
  */
 class BeforeFolderScannedEvent extends Event {
-	/** @var string */
-	private $absolutePath;
+    /** @var string */
+    private $absolutePath;
 
-	/**
-	 * @param string $absolutePath
-	 *
-	 * @since 18.0.0
-	 */
-	public function __construct(string $absolutePath) {
-		parent::__construct();
-		$this->absolutePath = $absolutePath;
-	}
+    /**
+     * @param string $absolutePath
+     *
+     * @since 18.0.0
+     */
+    public function __construct(string $absolutePath) {
+        parent::__construct();
+        $this->absolutePath = $absolutePath;
+    }
 
-	/**
-	 * @return string
-	 * @since 18.0.0
-	 */
-	public function getAbsolutePath(): string {
-		return $this->absolutePath;
-	}
+    /**
+     * @return string
+     * @since 18.0.0
+     */
+    public function getAbsolutePath(): string {
+        return $this->absolutePath;
+    }
 }

lib/public/Files/Events/BeforeFileScannedEvent.php

Indentation +18 added lines, -18 removed lines

@@ -31,24 +31,24 @@
  * @since 18.0.0
  */
 class BeforeFileScannedEvent extends Event {
-	/** @var string */
-	private $absolutePath;
+    /** @var string */
+    private $absolutePath;
 
-	/**
-	 * @param string $absolutePath
-	 *
-	 * @since 18.0.0
-	 */
-	public function __construct(string $absolutePath) {
-		parent::__construct();
-		$this->absolutePath = $absolutePath;
-	}
+    /**
+     * @param string $absolutePath
+     *
+     * @since 18.0.0
+     */
+    public function __construct(string $absolutePath) {
+        parent::__construct();
+        $this->absolutePath = $absolutePath;
+    }
 
-	/**
-	 * @return string
-	 * @since 18.0.0
-	 */
-	public function getAbsolutePath(): string {
-		return $this->absolutePath;
-	}
+    /**
+     * @return string
+     * @since 18.0.0
+     */
+    public function getAbsolutePath(): string {
+        return $this->absolutePath;
+    }
 }