nextcloud / server

lib/public/FullTextSearch/IFullTextSearchProvider.php

Indentation +240 added lines, -240 removed lines

@@ -71,244 +71,244 @@
  *
  */
 interface IFullTextSearchProvider {
-	/**
-	 * Must returns a unique Id used to identify the Content Provider.
-	 * 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 Content Provider.
-	 * This is used in multiple places, so better use a clear display name.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getName(): string;
-
-
-	/**
-	 * Should returns the current configuration of the Content Provider.
-	 * 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;
-
-
-	/**
-	 * Must returns a ISearchTemplate that contains displayable items and
-	 * available options to users when searching.
-	 *
-	 * @see ISearchTemplate
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function getSearchTemplate(): ISearchTemplate;
-
-
-	/**
-	 * Called when FullTextSearch is loading your Content Provider.
-	 *
-	 * @since 15.0.0
-	 */
-	public function loadProvider();
-
-
-	/**
-	 * 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
-	 * Content Provider to communicate with the process initiated by
-	 * FullTextSearch.
-	 *
-	 * The IRunner is coming with some methods so the Content Provider can
-	 * returns important information and errors to be displayed to the admin.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IRunner $runner
-	 */
-	public function setRunner(IRunner $runner);
-
-
-	/**
-	 * This method is called when the administrator specify options when running
-	 * the ./occ fulltextsearch:index or ./occ fulltextsearch:live
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexOptions $options
-	 */
-	public function setIndexOptions(IIndexOptions $options);
-
-
-	/**
-	 * Allow the provider to generate a list of chunk to split a huge list of
-	 * indexable documents
-	 *
-	 * During the indexing the generateIndexableDocuments method will be called
-	 * for each entry of the returned array.
-	 * If the returned array is empty, the generateIndexableDocuments() will be
-	 * called only once (per user).
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $userId
-	 *
-	 * @return string[]
-	 */
-	public function generateChunks(string $userId): array;
-
-
-	/**
-	 * Returns all indexable document for a user as an array of IIndexDocument.
-	 *
-	 * There is no need to fill each IIndexDocument with content; at this point,
-	 * only fill the object with the minimum information to not waste memory while
-	 * still being able to identify the document it is referring to.
-	 *
-	 * FullTextSearch will call 2 other methods of this interface for each
-	 * IIndexDocument of the array, prior to their indexing:
-	 *
-	 * - first, to compare the date of the last index,
-	 * - then, to fill each IIndexDocument with complete data
-	 *
-	 * @see IIndexDocument
-	 *
-	 * @since 15.0.0
-	 *  -> 16.0.0: the parameter "$chunk" was added
-	 *
-	 * @param string $userId
-	 * @param string $chunk
-	 *
-	 * @return IIndexDocument[]
-	 */
-	public function generateIndexableDocuments(string $userId, string $chunk): array;
-
-
-	/**
-	 * Called to verify that the document is not already indexed and that the
-	 * old index is not up-to-date, using the IIndex from
-	 * IIndexDocument->getIndex()
-	 *
-	 * Returning true will not queue the current IIndexDocument to any further
-	 * operation and will continue on the next element from the list returned by
-	 * generateIndexableDocuments().
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexDocument $document
-	 *
-	 * @return bool
-	 */
-	public function isDocumentUpToDate(IIndexDocument $document): bool;
-
-
-	/**
-	 * Must fill IIndexDocument with all information relative to the document,
-	 * before its indexing by the Search Platform.
-	 *
-	 * Method is called for each element returned previously by
-	 * generateIndexableDocuments().
-	 *
-	 * @see IIndexDocument
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexDocument $document
-	 */
-	public function fillIndexDocument(IIndexDocument $document);
-
-
-	/**
-	 * The Search Provider must create and return an IIndexDocument
-	 * based on the IIndex and its status. The IIndexDocument must contains all
-	 * information as it will be send for indexing.
-	 *
-	 * Method is called during a cron or a ./occ fulltextsearch:live after a
-	 * new document is created, or an old document is set as modified.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 *
-	 * @return IIndexDocument
-	 */
-	public function updateDocument(IIndex $index): IIndexDocument;
-
-
-	/**
-	 * Called when an index is initiated by the administrator.
-	 * This is should only be used in case of a specific mapping is needed.
-	 * (ie. _almost_ never)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IFullTextSearchPlatform $platform
-	 */
-	public function onInitializingIndex(IFullTextSearchPlatform $platform);
-
-
-	/**
-	 * Called when administrator is resetting the index.
-	 * This is should only be used in case of a specific mapping has been
-	 * created.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IFullTextSearchPlatform $platform
-	 */
-	public function onResettingIndex(IFullTextSearchPlatform $platform);
-
-
-	/**
-	 * Method is called when a search request is initiated by a user, prior to
-	 * be sent to the Search Platform.
-	 *
-	 * Your Content Provider can interact with the ISearchRequest to apply the
-	 * search options and make the search more precise.
-	 *
-	 * @see ISearchRequest
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchRequest $searchRequest
-	 */
-	public function improveSearchRequest(ISearchRequest $searchRequest);
-
-
-	/**
-	 * Method is called after results of a search are returned by the
-	 * Search Platform.
-	 *
-	 * Your Content Provider can detail each entry with local data to improve
-	 * the display of the search result.
-	 *
-	 * @see ISearchResult
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchResult $searchResult
-	 */
-	public function improveSearchResult(ISearchResult $searchResult);
-
-
-	/**
-	 * not used yet.
-	 *
-	 * @since 15.0.0
-	 */
-	public function unloadProvider();
+    /**
+     * Must returns a unique Id used to identify the Content Provider.
+     * 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 Content Provider.
+     * This is used in multiple places, so better use a clear display name.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getName(): string;
+
+
+    /**
+     * Should returns the current configuration of the Content Provider.
+     * 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;
+
+
+    /**
+     * Must returns a ISearchTemplate that contains displayable items and
+     * available options to users when searching.
+     *
+     * @see ISearchTemplate
+     *
+     * @since 15.0.0
+     *
+     * @return ISearchTemplate
+     */
+    public function getSearchTemplate(): ISearchTemplate;
+
+
+    /**
+     * Called when FullTextSearch is loading your Content Provider.
+     *
+     * @since 15.0.0
+     */
+    public function loadProvider();
+
+
+    /**
+     * 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
+     * Content Provider to communicate with the process initiated by
+     * FullTextSearch.
+     *
+     * The IRunner is coming with some methods so the Content Provider can
+     * returns important information and errors to be displayed to the admin.
+     *
+     * @since 15.0.0
+     *
+     * @param IRunner $runner
+     */
+    public function setRunner(IRunner $runner);
+
+
+    /**
+     * This method is called when the administrator specify options when running
+     * the ./occ fulltextsearch:index or ./occ fulltextsearch:live
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexOptions $options
+     */
+    public function setIndexOptions(IIndexOptions $options);
+
+
+    /**
+     * Allow the provider to generate a list of chunk to split a huge list of
+     * indexable documents
+     *
+     * During the indexing the generateIndexableDocuments method will be called
+     * for each entry of the returned array.
+     * If the returned array is empty, the generateIndexableDocuments() will be
+     * called only once (per user).
+     *
+     * @since 16.0.0
+     *
+     * @param string $userId
+     *
+     * @return string[]
+     */
+    public function generateChunks(string $userId): array;
+
+
+    /**
+     * Returns all indexable document for a user as an array of IIndexDocument.
+     *
+     * There is no need to fill each IIndexDocument with content; at this point,
+     * only fill the object with the minimum information to not waste memory while
+     * still being able to identify the document it is referring to.
+     *
+     * FullTextSearch will call 2 other methods of this interface for each
+     * IIndexDocument of the array, prior to their indexing:
+     *
+     * - first, to compare the date of the last index,
+     * - then, to fill each IIndexDocument with complete data
+     *
+     * @see IIndexDocument
+     *
+     * @since 15.0.0
+     *  -> 16.0.0: the parameter "$chunk" was added
+     *
+     * @param string $userId
+     * @param string $chunk
+     *
+     * @return IIndexDocument[]
+     */
+    public function generateIndexableDocuments(string $userId, string $chunk): array;
+
+
+    /**
+     * Called to verify that the document is not already indexed and that the
+     * old index is not up-to-date, using the IIndex from
+     * IIndexDocument->getIndex()
+     *
+     * Returning true will not queue the current IIndexDocument to any further
+     * operation and will continue on the next element from the list returned by
+     * generateIndexableDocuments().
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexDocument $document
+     *
+     * @return bool
+     */
+    public function isDocumentUpToDate(IIndexDocument $document): bool;
+
+
+    /**
+     * Must fill IIndexDocument with all information relative to the document,
+     * before its indexing by the Search Platform.
+     *
+     * Method is called for each element returned previously by
+     * generateIndexableDocuments().
+     *
+     * @see IIndexDocument
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexDocument $document
+     */
+    public function fillIndexDocument(IIndexDocument $document);
+
+
+    /**
+     * The Search Provider must create and return an IIndexDocument
+     * based on the IIndex and its status. The IIndexDocument must contains all
+     * information as it will be send for indexing.
+     *
+     * Method is called during a cron or a ./occ fulltextsearch:live after a
+     * new document is created, or an old document is set as modified.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     *
+     * @return IIndexDocument
+     */
+    public function updateDocument(IIndex $index): IIndexDocument;
+
+
+    /**
+     * Called when an index is initiated by the administrator.
+     * This is should only be used in case of a specific mapping is needed.
+     * (ie. _almost_ never)
+     *
+     * @since 15.0.0
+     *
+     * @param IFullTextSearchPlatform $platform
+     */
+    public function onInitializingIndex(IFullTextSearchPlatform $platform);
+
+
+    /**
+     * Called when administrator is resetting the index.
+     * This is should only be used in case of a specific mapping has been
+     * created.
+     *
+     * @since 15.0.0
+     *
+     * @param IFullTextSearchPlatform $platform
+     */
+    public function onResettingIndex(IFullTextSearchPlatform $platform);
+
+
+    /**
+     * Method is called when a search request is initiated by a user, prior to
+     * be sent to the Search Platform.
+     *
+     * Your Content Provider can interact with the ISearchRequest to apply the
+     * search options and make the search more precise.
+     *
+     * @see ISearchRequest
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchRequest $searchRequest
+     */
+    public function improveSearchRequest(ISearchRequest $searchRequest);
+
+
+    /**
+     * Method is called after results of a search are returned by the
+     * Search Platform.
+     *
+     * Your Content Provider can detail each entry with local data to improve
+     * the display of the search result.
+     *
+     * @see ISearchResult
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchResult $searchResult
+     */
+    public function improveSearchResult(ISearchResult $searchResult);
+
+
+    /**
+     * not used yet.
+     *
+     * @since 15.0.0
+     */
+    public function unloadProvider();
 }

lib/public/FullTextSearch/Service/IProviderService.php

Indentation +16 added lines, -16 removed lines

@@ -32,22 +32,22 @@
  *
  */
 interface IProviderService {
-	/**
-	 * Check if the provider $providerId is already indexed.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 *
-	 * @return bool
-	 */
-	public function isProviderIndexed(string $providerId);
+    /**
+     * Check if the provider $providerId is already indexed.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     *
+     * @return bool
+     */
+    public function isProviderIndexed(string $providerId);
 
 
-	/**
-	 * Add the Javascript API in the navigation page of an app.
-	 *
-	 * @since 15.0.0
-	 */
-	public function addJavascriptAPI();
+    /**
+     * Add the Javascript API in the navigation page of an app.
+     *
+     * @since 15.0.0
+     */
+    public function addJavascriptAPI();
 }

lib/public/FullTextSearch/Service/IIndexService.php

Indentation +56 added lines, -56 removed lines

@@ -34,68 +34,68 @@
  *
  */
 interface IIndexService {
-	/**
-	 * Create an Index
-	 *
-	 * @since 15.0.1
-	 *
-	 * @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): IIndex;
+    /**
+     * Create an Index
+     *
+     * @since 15.0.1
+     *
+     * @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): IIndex;
 
 
-	/**
-	 * 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;
+    /**
+     * 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;
 
 
-	/**
-	 * Update the status of an 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 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 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 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 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 array $indexes
-	 */
-	public function updateIndexes(array $indexes);
+    /**
+     * Update an array of Index.
+     *
+     * @since 15.0.0
+     *
+     * @param array $indexes
+     */
+    public function updateIndexes(array $indexes);
 }

lib/public/FullTextSearch/Service/ISearchService.php

Indentation +37 added lines, -37 removed lines

@@ -35,43 +35,43 @@
  *
  */
 interface ISearchService {
-	/**
-	 * generate a search request, based on an array:
-	 *
-	 * $request =
-	 *   [
-	 *        'providers' =>    (string/array) 'all'
-	 *        'author' =>       (string) owner of the document.
-	 *        'search' =>       (string) search string,
-	 *        'size' =>         (int) number of items to be return
-	 *        'page' =>         (int) page
-	 *        'parts' =>        (array) parts of document to search within,
-	 *        'options' =       (array) search options,
-	 *        'tags'     =>     (array) tags,
-	 *        'metatags' =>     (array) metatags,
-	 *        'subtags'  =>     (array) subtags
-	 *   ]
-	 *
-	 * 'providers' can be an array of providerIds
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $request
-	 *
-	 * @return ISearchRequest
-	 */
-	public function generateSearchRequest(array $request): ISearchRequest;
+    /**
+     * generate a search request, based on an array:
+     *
+     * $request =
+     *   [
+     *        'providers' =>    (string/array) 'all'
+     *        'author' =>       (string) owner of the document.
+     *        'search' =>       (string) search string,
+     *        'size' =>         (int) number of items to be return
+     *        'page' =>         (int) page
+     *        'parts' =>        (array) parts of document to search within,
+     *        'options' =       (array) search options,
+     *        'tags'     =>     (array) tags,
+     *        'metatags' =>     (array) metatags,
+     *        'subtags'  =>     (array) subtags
+     *   ]
+     *
+     * 'providers' can be an array of providerIds
+     *
+     * @since 15.0.0
+     *
+     * @param array $request
+     *
+     * @return ISearchRequest
+     */
+    public function generateSearchRequest(array $request): ISearchRequest;
 
 
-	/**
-	 * Search documents
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $userId
-	 * @param ISearchRequest $searchRequest
-	 *
-	 * @return ISearchResult[]
-	 */
-	public function search(string $userId, ISearchRequest $searchRequest): array;
+    /**
+     * Search documents
+     *
+     * @since 15.0.0
+     *
+     * @param string $userId
+     * @param ISearchRequest $searchRequest
+     *
+     * @return ISearchResult[]
+     */
+    public function search(string $userId, ISearchRequest $searchRequest): array;
 }

lib/public/FullTextSearch/Model/IIndexOptions.php

Indentation +33 added lines, -33 removed lines

@@ -37,39 +37,39 @@
  *
  */
 interface IIndexOptions {
-	/**
-	 * Get the value (as a string) for an option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param string $default
-	 *
-	 * @return string
-	 */
-	public function getOption(string $option, string $default = ''): string;
+    /**
+     * Get the value (as a string) for an option.
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param string $default
+     *
+     * @return string
+     */
+    public function getOption(string $option, string $default = ''): string;
 
-	/**
-	 * Get the value (as an array) for an option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param array $default
-	 *
-	 * @return array
-	 */
-	public function getOptionArray(string $option, array $default = []): array;
+    /**
+     * Get the value (as an array) for an option.
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param array $default
+     *
+     * @return array
+     */
+    public function getOptionArray(string $option, array $default = []): array;
 
-	/**
-	 * Get the value (as an boolean) for an option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $option
-	 * @param bool $default
-	 *
-	 * @return bool
-	 */
-	public function getOptionBool(string $option, bool $default): bool;
+    /**
+     * Get the value (as an boolean) for an option.
+     *
+     * @since 15.0.0
+     *
+     * @param string $option
+     * @param bool $default
+     *
+     * @return bool
+     */
+    public function getOptionBool(string $option, bool $default): bool;
 }

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;
 }