nextcloud / server

lib/public/FullTextSearch/IFullTextSearchProvider.php

Indentation +220 added lines, -220 removed lines

@@ -80,225 +80,225 @@
 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 SearchTemplate that contains displayable items and
-	 * available options to users when searching.
-	 *
-	 * @see SearchTemplate
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return SearchTemplate
-	 */
-	public function getSearchTemplate(): SearchTemplate;
-
-
-	/**
-	 * 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);
-
-
-	/**
-	 * Returns all indexable document for a user as an array of IndexDocument.
-	 *
-	 * There is no need to fill each IndexDocument 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
-	 * IndexDocument of the array, prior to their indexing:
-	 *
-	 * - first, to compare the date of the last index,
-	 * - then, to fill each IndexDocument with complete data
-	 *
-	 * @see IndexDocument
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $userId
-	 *
-	 * @return IndexDocument[]
-	 */
-	public function generateIndexableDocuments(string $userId): 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
-	 * IndexDocument->getIndex()
-	 *
-	 * Returning true will not queue the current IndexDocument to any further
-	 * operation and will continue on the next element from the list returned by
-	 * generateIndexableDocuments().
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IndexDocument $document
-	 *
-	 * @return bool
-	 */
-	public function isDocumentUpToDate(IndexDocument $document): bool;
-
-
-	/**
-	 * Must fill IndexDocument 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 IndexDocument
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IndexDocument $document
-	 */
-	public function fillIndexDocument(IndexDocument $document);
-
-
-	/**
-	 * The Search Provider must create and return an IndexDocument
-	 * based on the IIndex and its status. The IndexDocument 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 IndexDocument
-	 */
-	public function updateDocument(IIndex $index): IndexDocument;
-
-
-	/**
-	 * 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 SearchTemplate that contains displayable items and
+     * available options to users when searching.
+     *
+     * @see SearchTemplate
+     *
+     * @since 15.0.0
+     *
+     * @return SearchTemplate
+     */
+    public function getSearchTemplate(): SearchTemplate;
+
+
+    /**
+     * 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);
+
+
+    /**
+     * Returns all indexable document for a user as an array of IndexDocument.
+     *
+     * There is no need to fill each IndexDocument 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
+     * IndexDocument of the array, prior to their indexing:
+     *
+     * - first, to compare the date of the last index,
+     * - then, to fill each IndexDocument with complete data
+     *
+     * @see IndexDocument
+     *
+     * @since 15.0.0
+     *
+     * @param string $userId
+     *
+     * @return IndexDocument[]
+     */
+    public function generateIndexableDocuments(string $userId): 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
+     * IndexDocument->getIndex()
+     *
+     * Returning true will not queue the current IndexDocument to any further
+     * operation and will continue on the next element from the list returned by
+     * generateIndexableDocuments().
+     *
+     * @since 15.0.0
+     *
+     * @param IndexDocument $document
+     *
+     * @return bool
+     */
+    public function isDocumentUpToDate(IndexDocument $document): bool;
+
+
+    /**
+     * Must fill IndexDocument 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 IndexDocument
+     *
+     * @since 15.0.0
+     *
+     * @param IndexDocument $document
+     */
+    public function fillIndexDocument(IndexDocument $document);
+
+
+    /**
+     * The Search Provider must create and return an IndexDocument
+     * based on the IIndex and its status. The IndexDocument 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 IndexDocument
+     */
+    public function updateDocument(IIndex $index): IndexDocument;
+
+
+    /**
+     * 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/ISearchService.php

Indentation +37 added lines, -37 removed lines

@@ -45,45 +45,45 @@
 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/Service/IIndexService.php

Indentation +50 added lines, -50 removed lines

@@ -44,56 +44,56 @@
 interface IIndexService {
 
 
-	/**
-	 * 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 $documentId
-	 * @param int $status
-	 * @param bool $reset
-	 */
-	public function updateIndexStatus(string $providerId, $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 array $indexes
-	 */
-	public function updateIndexes(array $indexes);
+    /**
+     * 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 $documentId
+     * @param int $status
+     * @param bool $reset
+     */
+    public function updateIndexStatus(string $providerId, $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 array $indexes
+     */
+    public function updateIndexes(array $indexes);
 
 }
 

lib/public/FullTextSearch/Service/IProviderService.php

Indentation +16 added lines, -16 removed lines

@@ -41,24 +41,24 @@
 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/IFullTextSearchPlatform.php

Indentation +141 added lines, -141 removed lines

@@ -80,147 +80,147 @@
 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 IndexDocument $document
-	 *
-	 * @return IIndex
-	 */
-	public function indexDocument(IndexDocument $document): IIndex;
-
-
-	/**
-	 * Searching documents, ISearchResult should be updated with the result of
-	 * the search.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchResult $result
-	 * @param DocumentAccess $access
-	 */
-	public function searchRequest(ISearchResult $result, DocumentAccess $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 IndexDocument
-	 */
-	public function getDocument(string $providerId, string $documentId): IndexDocument;
+    /**
+     * 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 IndexDocument $document
+     *
+     * @return IIndex
+     */
+    public function indexDocument(IndexDocument $document): IIndex;
+
+
+    /**
+     * Searching documents, ISearchResult should be updated with the result of
+     * the search.
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchResult $result
+     * @param DocumentAccess $access
+     */
+    public function searchRequest(ISearchResult $result, DocumentAccess $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 IndexDocument
+     */
+    public function getDocument(string $providerId, string $documentId): IndexDocument;
 
 
 }

lib/public/FullTextSearch/IFullTextSearchManager.php

Indentation +129 added lines, -129 removed lines

@@ -51,135 +51,135 @@
 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);
-
-
-	/**
-	 * 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);
+
+
+    /**
+     * 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/FullTextSearch/Model/IIndexOptions.php

Indentation +33 added lines, -33 removed lines

@@ -46,41 +46,41 @@
 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/ISearchResult.php

Indentation +137 added lines, -137 removed lines

@@ -56,143 +56,143 @@
 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 IndexDocument as one of the result of the search request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IndexDocument $document
-	 *
-	 * @return ISearchResult
-	 */
-	public function addDocument(IndexDocument $document): ISearchResult;
-
-	/**
-	 * Returns all result of the search request, in an array of IndexDocument.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getDocuments(): array;
-
-	/**
-	 * Set an array of IndexDocument as the result of the search request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IndexDocument[] $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 IndexDocument as one of the result of the search request.
+     *
+     * @since 15.0.0
+     *
+     * @param IndexDocument $document
+     *
+     * @return ISearchResult
+     */
+    public function addDocument(IndexDocument $document): ISearchResult;
+
+    /**
+     * Returns all result of the search request, in an array of IndexDocument.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getDocuments(): array;
+
+    /**
+     * Set an array of IndexDocument as the result of the search request.
+     *
+     * @since 15.0.0
+     *
+     * @param IndexDocument[] $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/IRunner.php

Indentation +88 added lines, -88 removed lines

@@ -48,94 +48,94 @@
 interface IRunner {
 
 
-	const RESULT_TYPE_SUCCESS = 1;
-	const RESULT_TYPE_WARNING = 4;
-	const RESULT_TYPE_FAIL = 9;
-
-
-	/**
-	 * Info are displayed in the user interface when an admin execute the
-	 * ./occ fulltextsearch:index command.
-	 *
-	 * quick list of info that can be edited:
-	 *   'documentId', 'info', 'title', 'resultIndex', 'resultStatus',
-	 *   'content', 'documentCurrent', 'documentTotal', 'progressStatus',
-	 *   'errorCurrent', 'errorException', 'errorIndex'.
-	 *
-	 * List of all editable info can be find in the Command\Index.php of the
-	 * FullTextSearch app.
-	 * (look for a comment 'full list of info that can be edited')
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $value
-	 */
-	public function setInfo(string $info, string $value);
-
-
-	/**
-	 * This method should be used when editing multiple info to avoid too many
-	 * refresh of the interface.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $data
-	 */
-	public function setInfoArray(array $data);
-
-
-	/**
-	 * Method used to update the current Action when an index is running.
-	 *
-	 * This method should be used instead of manually update the 'action' using
-	 * setInfo()/setInfoArray() as it is also used to keep the process alive,
-	 * manage the input, and some statistics of the load of the process.
-	 *
-	 * $action is a string with no space
-	 * $force should be set to true if the action is heavy while being executed
-	 * multiple times
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $action
-	 * @param bool $force
-	 *
-	 * @return string
-	 * @throws \Exception
-	 */
-	public function updateAction(string $action = '', bool $force = false): string;
-
-
-	/**
-	 * Call this method in a Search Platform or Content Provider if there is an
-	 * issue while generating a document or while indexing the current document.
-	 * This is used to store and display errors in the UI during an index to help
-	 * admin to keep track of errors.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 * @param string $message
-	 * @param string $class
-	 * @param int $sev
-	 */
-	public function newIndexError(IIndex $index, string $message, string $class = '', int $sev = 3);
-
-
-	/**
-	 * Call this method only in a Search Platform after an index of a document.
-	 * This is used to store and display results (good or bad) in the UI during
-	 * an index to help admin to keep track of fail and successful indexes.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 * @param string $message
-	 * @param string $status
-	 * @param int $type
-	 */
-	public function newIndexResult(IIndex $index, string $message, string $status, int $type);
+    const RESULT_TYPE_SUCCESS = 1;
+    const RESULT_TYPE_WARNING = 4;
+    const RESULT_TYPE_FAIL = 9;
+
+
+    /**
+     * Info are displayed in the user interface when an admin execute the
+     * ./occ fulltextsearch:index command.
+     *
+     * quick list of info that can be edited:
+     *   'documentId', 'info', 'title', 'resultIndex', 'resultStatus',
+     *   'content', 'documentCurrent', 'documentTotal', 'progressStatus',
+     *   'errorCurrent', 'errorException', 'errorIndex'.
+     *
+     * List of all editable info can be find in the Command\Index.php of the
+     * FullTextSearch app.
+     * (look for a comment 'full list of info that can be edited')
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $value
+     */
+    public function setInfo(string $info, string $value);
+
+
+    /**
+     * This method should be used when editing multiple info to avoid too many
+     * refresh of the interface.
+     *
+     * @since 15.0.0
+     *
+     * @param array $data
+     */
+    public function setInfoArray(array $data);
+
+
+    /**
+     * Method used to update the current Action when an index is running.
+     *
+     * This method should be used instead of manually update the 'action' using
+     * setInfo()/setInfoArray() as it is also used to keep the process alive,
+     * manage the input, and some statistics of the load of the process.
+     *
+     * $action is a string with no space
+     * $force should be set to true if the action is heavy while being executed
+     * multiple times
+     *
+     * @since 15.0.0
+     *
+     * @param string $action
+     * @param bool $force
+     *
+     * @return string
+     * @throws \Exception
+     */
+    public function updateAction(string $action = '', bool $force = false): string;
+
+
+    /**
+     * Call this method in a Search Platform or Content Provider if there is an
+     * issue while generating a document or while indexing the current document.
+     * This is used to store and display errors in the UI during an index to help
+     * admin to keep track of errors.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     * @param string $message
+     * @param string $class
+     * @param int $sev
+     */
+    public function newIndexError(IIndex $index, string $message, string $class = '', int $sev = 3);
+
+
+    /**
+     * Call this method only in a Search Platform after an index of a document.
+     * This is used to store and display results (good or bad) in the UI during
+     * an index to help admin to keep track of fail and successful indexes.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     * @param string $message
+     * @param string $status
+     * @param int $type
+     */
+    public function newIndexResult(IIndex $index, string $message, string $status, int $type);
 
 
 }