nextcloud / server

lib/public/Calendar/Room/IBackend.php

Indentation +32 added lines, -32 removed lines

@@ -31,39 +31,39 @@
  * @since 14.0.0
  */
 interface IBackend {
-	/**
-	 * get a list of all rooms in this backend
-	 *
-	 * @throws BackendTemporarilyUnavailableException
-	 * @return IRoom[]
-	 * @since 14.0.0
-	 */
-	public function getAllRooms():array;
+    /**
+     * get a list of all rooms in this backend
+     *
+     * @throws BackendTemporarilyUnavailableException
+     * @return IRoom[]
+     * @since 14.0.0
+     */
+    public function getAllRooms():array;
 
-	/**
-	 * get a list of all room identifiers in this backend
-	 *
-	 * @throws BackendTemporarilyUnavailableException
-	 * @return string[]
-	 * @since 14.0.0
-	 */
-	public function listAllRooms():array;
+    /**
+     * get a list of all room identifiers in this backend
+     *
+     * @throws BackendTemporarilyUnavailableException
+     * @return string[]
+     * @since 14.0.0
+     */
+    public function listAllRooms():array;
 
-	/**
-	 * get a room by it's id
-	 *
-	 * @param string $id
-	 * @throws BackendTemporarilyUnavailableException
-	 * @return IRoom|null
-	 * @since 14.0.0
-	 */
-	public function getRoom($id);
+    /**
+     * get a room by it's id
+     *
+     * @param string $id
+     * @throws BackendTemporarilyUnavailableException
+     * @return IRoom|null
+     * @since 14.0.0
+     */
+    public function getRoom($id);
 
-	/**
-	 * Get unique identifier of the backend
-	 *
-	 * @return string
-	 * @since 14.0.0
-	 */
-	public function getBackendIdentifier():string;
+    /**
+     * Get unique identifier of the backend
+     *
+     * @return string
+     * @since 14.0.0
+     */
+    public function getBackendIdentifier():string;
 }

lib/public/Calendar/ICalendarProvider.php

Indentation +7 added lines, -7 removed lines

@@ -34,11 +34,11 @@
  * @since 23.0.0
  */
 interface ICalendarProvider {
-	/**
-	 * @param string $principalUri URI of the principal
-	 * @param string[] $calendarUris optionally specify which calendars to load, or all if this array is empty
-	 * @return ICalendar[]
-	 * @since 23.0.0
-	 */
-	public function getCalendars(string $principalUri, array $calendarUris = []): array;
+    /**
+     * @param string $principalUri URI of the principal
+     * @param string[] $calendarUris optionally specify which calendars to load, or all if this array is empty
+     * @return ICalendar[]
+     * @since 23.0.0
+     */
+    public function getCalendars(string $principalUri, array $calendarUris = []): array;
 }

lib/public/Encryption/Keys/IStorage.php

Indentation +135 added lines, -135 removed lines

@@ -31,151 +31,151 @@
  * @since 8.1.0
  */
 interface IStorage {
-	/**
-	 * get user specific key
-	 *
-	 * @param string $uid ID if the user for whom we want the key
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return mixed key
-	 * @since 8.1.0
-	 */
-	public function getUserKey($uid, $keyId, $encryptionModuleId);
+    /**
+     * get user specific key
+     *
+     * @param string $uid ID if the user for whom we want the key
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return mixed key
+     * @since 8.1.0
+     */
+    public function getUserKey($uid, $keyId, $encryptionModuleId);
 
-	/**
-	 * get file specific key
-	 *
-	 * @param string $path path to file
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return mixed key
-	 * @since 8.1.0
-	 */
-	public function getFileKey($path, $keyId, $encryptionModuleId);
+    /**
+     * get file specific key
+     *
+     * @param string $path path to file
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return mixed key
+     * @since 8.1.0
+     */
+    public function getFileKey($path, $keyId, $encryptionModuleId);
 
-	/**
-	 * get system-wide encryption keys not related to a specific user,
-	 * e.g something like a key for public link shares
-	 *
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return mixed key
-	 * @since 8.1.0
-	 */
-	public function getSystemUserKey($keyId, $encryptionModuleId);
+    /**
+     * get system-wide encryption keys not related to a specific user,
+     * e.g something like a key for public link shares
+     *
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return mixed key
+     * @since 8.1.0
+     */
+    public function getSystemUserKey($keyId, $encryptionModuleId);
 
-	/**
-	 * set user specific key
-	 *
-	 * @param string $uid ID if the user for whom we want the key
-	 * @param string $keyId id of the key
-	 * @param mixed $key
-	 * @param string $encryptionModuleId
-	 * @since 8.1.0
-	 */
-	public function setUserKey($uid, $keyId, $key, $encryptionModuleId);
+    /**
+     * set user specific key
+     *
+     * @param string $uid ID if the user for whom we want the key
+     * @param string $keyId id of the key
+     * @param mixed $key
+     * @param string $encryptionModuleId
+     * @since 8.1.0
+     */
+    public function setUserKey($uid, $keyId, $key, $encryptionModuleId);
 
-	/**
-	 * set file specific key
-	 *
-	 * @param string $path path to file
-	 * @param string $keyId id of the key
-	 * @param mixed $key
-	 * @param string $encryptionModuleId
-	 * @since 8.1.0
-	 */
-	public function setFileKey($path, $keyId, $key, $encryptionModuleId);
+    /**
+     * set file specific key
+     *
+     * @param string $path path to file
+     * @param string $keyId id of the key
+     * @param mixed $key
+     * @param string $encryptionModuleId
+     * @since 8.1.0
+     */
+    public function setFileKey($path, $keyId, $key, $encryptionModuleId);
 
-	/**
-	 * set system-wide encryption keys not related to a specific user,
-	 * e.g something like a key for public link shares
-	 *
-	 * @param string $keyId id of the key
-	 * @param mixed $key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return mixed key
-	 * @since 8.1.0
-	 */
-	public function setSystemUserKey($keyId, $key, $encryptionModuleId);
+    /**
+     * set system-wide encryption keys not related to a specific user,
+     * e.g something like a key for public link shares
+     *
+     * @param string $keyId id of the key
+     * @param mixed $key
+     * @param string $encryptionModuleId
+     *
+     * @return mixed key
+     * @since 8.1.0
+     */
+    public function setSystemUserKey($keyId, $key, $encryptionModuleId);
 
-	/**
-	 * delete user specific key
-	 *
-	 * @param string $uid ID if the user for whom we want to delete the key
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return boolean False when the key could not be deleted
-	 * @since 8.1.0
-	 */
-	public function deleteUserKey($uid, $keyId, $encryptionModuleId);
+    /**
+     * delete user specific key
+     *
+     * @param string $uid ID if the user for whom we want to delete the key
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return boolean False when the key could not be deleted
+     * @since 8.1.0
+     */
+    public function deleteUserKey($uid, $keyId, $encryptionModuleId);
 
-	/**
-	 * delete file specific key
-	 *
-	 * @param string $path path to file
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return boolean False when the key could not be deleted
-	 * @since 8.1.0
-	 */
-	public function deleteFileKey($path, $keyId, $encryptionModuleId);
+    /**
+     * delete file specific key
+     *
+     * @param string $path path to file
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return boolean False when the key could not be deleted
+     * @since 8.1.0
+     */
+    public function deleteFileKey($path, $keyId, $encryptionModuleId);
 
-	/**
-	 * delete all file keys for a given file
-	 *
-	 * @param string $path to the file
-	 *
-	 * @return boolean False when the keys could not be deleted
-	 * @since 8.1.0
-	 */
-	public function deleteAllFileKeys($path);
+    /**
+     * delete all file keys for a given file
+     *
+     * @param string $path to the file
+     *
+     * @return boolean False when the keys could not be deleted
+     * @since 8.1.0
+     */
+    public function deleteAllFileKeys($path);
 
-	/**
-	 * delete system-wide encryption keys not related to a specific user,
-	 * e.g something like a key for public link shares
-	 *
-	 * @param string $keyId id of the key
-	 * @param string $encryptionModuleId
-	 *
-	 * @return boolean False when the key could not be deleted
-	 * @since 8.1.0
-	 */
-	public function deleteSystemUserKey($keyId, $encryptionModuleId);
+    /**
+     * delete system-wide encryption keys not related to a specific user,
+     * e.g something like a key for public link shares
+     *
+     * @param string $keyId id of the key
+     * @param string $encryptionModuleId
+     *
+     * @return boolean False when the key could not be deleted
+     * @since 8.1.0
+     */
+    public function deleteSystemUserKey($keyId, $encryptionModuleId);
 
-	/**
-	 * copy keys if a file was renamed
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function renameKeys($source, $target);
+    /**
+     * copy keys if a file was renamed
+     *
+     * @param string $source
+     * @param string $target
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function renameKeys($source, $target);
 
-	/**
-	 * move keys if a file was renamed
-	 *
-	 * @param string $source
-	 * @param string $target
-	 * @return boolean
-	 * @since 8.1.0
-	 */
-	public function copyKeys($source, $target);
+    /**
+     * move keys if a file was renamed
+     *
+     * @param string $source
+     * @param string $target
+     * @return boolean
+     * @since 8.1.0
+     */
+    public function copyKeys($source, $target);
 
-	/**
-	 * backup keys of a given encryption module
-	 *
-	 * @param string $encryptionModuleId
-	 * @param string $purpose
-	 * @param string $uid
-	 * @return bool
-	 * @since 12.0.0
-	 */
-	public function backupUserKeys($encryptionModuleId, $purpose, $uid);
+    /**
+     * backup keys of a given encryption module
+     *
+     * @param string $encryptionModuleId
+     * @param string $purpose
+     * @param string $uid
+     * @return bool
+     * @since 12.0.0
+     */
+    public function backupUserKeys($encryptionModuleId, $purpose, $uid);
 }

lib/public/Encryption/IManager.php

Indentation +55 added lines, -55 removed lines

@@ -33,66 +33,66 @@
  * @since 8.1.0
  */
 interface IManager {
-	/**
-	 * Check if encryption is available (at least one encryption module needs to be enabled)
-	 *
-	 * @return bool true if enabled, false if not
-	 * @since 8.1.0
-	 */
-	public function isEnabled();
+    /**
+     * Check if encryption is available (at least one encryption module needs to be enabled)
+     *
+     * @return bool true if enabled, false if not
+     * @since 8.1.0
+     */
+    public function isEnabled();
 
-	/**
-	 * Registers an callback function which must return an encryption module instance
-	 *
-	 * @param string $id
-	 * @param string $displayName
-	 * @param callable $callback
-	 * @throws ModuleAlreadyExistsException
-	 * @since 8.1.0
-	 */
-	public function registerEncryptionModule($id, $displayName, callable $callback);
+    /**
+     * Registers an callback function which must return an encryption module instance
+     *
+     * @param string $id
+     * @param string $displayName
+     * @param callable $callback
+     * @throws ModuleAlreadyExistsException
+     * @since 8.1.0
+     */
+    public function registerEncryptionModule($id, $displayName, callable $callback);
 
-	/**
-	 * Unregisters an encryption module
-	 *
-	 * @param string $moduleId
-	 * @since 8.1.0
-	 */
-	public function unregisterEncryptionModule($moduleId);
+    /**
+     * Unregisters an encryption module
+     *
+     * @param string $moduleId
+     * @since 8.1.0
+     */
+    public function unregisterEncryptionModule($moduleId);
 
-	/**
-	 * get a list of all encryption modules
-	 *
-	 * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
-	 * @since 8.1.0
-	 */
-	public function getEncryptionModules();
+    /**
+     * get a list of all encryption modules
+     *
+     * @return array [id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
+     * @since 8.1.0
+     */
+    public function getEncryptionModules();
 
 
-	/**
-	 * get a specific encryption module
-	 *
-	 * @param string $moduleId Empty to get the default module
-	 * @return IEncryptionModule
-	 * @throws ModuleDoesNotExistsException
-	 * @since 8.1.0
-	 */
-	public function getEncryptionModule($moduleId = '');
+    /**
+     * get a specific encryption module
+     *
+     * @param string $moduleId Empty to get the default module
+     * @return IEncryptionModule
+     * @throws ModuleDoesNotExistsException
+     * @since 8.1.0
+     */
+    public function getEncryptionModule($moduleId = '');
 
-	/**
-	 * get default encryption module Id
-	 *
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function getDefaultEncryptionModuleId();
+    /**
+     * get default encryption module Id
+     *
+     * @return string
+     * @since 8.1.0
+     */
+    public function getDefaultEncryptionModuleId();
 
-	/**
-	 * set default encryption module Id
-	 *
-	 * @param string $moduleId
-	 * @return string
-	 * @since 8.1.0
-	 */
-	public function setDefaultEncryptionModule($moduleId);
+    /**
+     * set default encryption module Id
+     *
+     * @param string $moduleId
+     * @return string
+     * @since 8.1.0
+     */
+    public function setDefaultEncryptionModule($moduleId);
 }

lib/public/Encryption/IFile.php

Indentation +8 added lines, -8 removed lines

@@ -29,12 +29,12 @@
  * @since 8.1.0
  */
 interface IFile {
-	/**
-	 * get list of users with access to the file
-	 *
-	 * @param string $path to the file
-	 * @return array
-	 * @since 8.1.0
-	 */
-	public function getAccessList($path);
+    /**
+     * get list of users with access to the file
+     *
+     * @param string $path to the file
+     * @return array
+     * @since 8.1.0
+     */
+    public function getAccessList($path);
 }

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