nextcloud / server

lib/public/FullTextSearch/IFullTextSearchProvider.php

Indentation +240 added lines, -240 removed lines

@@ -80,245 +80,245 @@
 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/private/FullTextSearch/Model/SearchOption.php

Indentation +243 added lines, -243 removed lines

@@ -45,247 +45,247 @@
 final class SearchOption implements ISearchOption, JsonSerializable {
 
 
-	/** @var string */
-	private $name = '';
-
-	/** @var string */
-	private $title = '';
-
-	/** @var string */
-	private $type = '';
-
-	/** @var string */
-	private $size = '';
-
-	/** @var string */
-	private $placeholder = '';
-
-
-	/**
-	 *     *
-	 *
-	 * The array can be empty in case no search options are available.
-	 * The format of the array must be like this:
-	 *
-	 * [
-	 *   'panel' => [
-	 *     'options' => [
-	 *         OPTION1,
-	 *         OPTION2,
-	 *         OPTION3
-	 *     ]
-	 *   ],
-	 *   'navigation' => [
-	 *     'icon'    => 'css-class-of-the-icon',
-	 *     'options' => [
-	 *         OPTION1,
-	 *         OPTION2,
-	 *         OPTION3
-	 *     ]
-	 *   ]
-	 * ]
-	 *
-	 * - PANEL contains entries that will be displayed in the app itself, when
-	 *   a search is initiated.
-	 * - NAVIGATION contains entries that will be available when using the
-	 *   FullTextSearch navigation page
-	 * - OPTION is an element that define each option available to the user.
-	 *
-	 * The format for the options must be like this:
-	 *
-	 * [
-	 *   'name'        => 'name_of_the_option',
-	 *   'title'       => 'Name displayed in the panel',
-	 *   'type'        => '',
-	 *   'size'        => ''   (optional),
-	 *   'placeholder' => ''   (optional)
-	 * ]
-	 *
-	 * - NAME is the variable name that is sent to the IFullTextSearchProvider
-	 *   when a ISearchRequest is requested. (keys in the array returned by the
-	 *   ISearchRequest->getOptions())
-	 * - TYPE can be 'input' or 'checkbox'
-	 * - SIZE is only used in case TYPE='input', default is 'large' but can be
-	 *   'small'
-	 * - PLACEHOLDER is only used in case TYPE='input', default is empty.
-	 */
-
-	/**
-	 * ISearchOption constructor.
-	 *
-	 * Some value can be setduring the creation of the object.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $name
-	 * @param string $title
-	 * @param string $type
-	 * @param string $size
-	 * @param string $placeholder
-	 */
-	public function __construct(string $name = '', string $title = '', string $type = '', string $size = '', string $placeholder = '') {
-		$this->name = $name;
-		$this->title = $title;
-		$this->type = $type;
-		$this->size = $size;
-		$this->placeholder = $placeholder;
-	}
-
-
-	/**
-	 * 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 15.0.0
-	 *
-	 * @param string $name
-	 *
-	 * @return ISearchOption
-	 */
-	public function setName(string $name): ISearchOption {
-		$this->name = $name;
-
-		return $this;
-	}
-
-	/**
-	 * Get the name/key of the option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getName(): string {
-		return $this->name;
-	}
-
-
-	/**
-	 * Set the title/display name of the option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $title
-	 *
-	 * @return ISearchOption
-	 */
-	public function setTitle(string $title): ISearchOption {
-		$this->title = $title;
-
-		return $this;
-	}
-
-	/**
-	 * Get the title of the option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getTitle(): string {
-		return $this->title;
-	}
-
-
-	/**
-	 * Set the type of the option.
-	 * $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $type
-	 *
-	 * @return ISearchOption
-	 */
-	public function setType(string $type): ISearchOption {
-		$this->type = $type;
-
-		return $this;
-	}
-
-	/**
-	 * Get the type of the option.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getType(): string {
-		return $this->type;
-	}
-
-
-	/**
-	 * In case of Type is INPUT, set the size of the input field.
-	 * Value can be ISearchOption::INPUT_SMALL or not defined.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $size
-	 *
-	 * @return ISearchOption
-	 */
-	public function setSize(string $size): ISearchOption {
-		$this->size = $size;
-
-		return $this;
-	}
-
-	/**
-	 * Get the size of the INPUT.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getSize(): string {
-		return $this->size;
-	}
-
-
-	/**
-	 * In case of Type is , set the placeholder to be displayed in the input
-	 * field.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $placeholder
-	 *
-	 * @return ISearchOption
-	 */
-	public function setPlaceholder(string $placeholder): ISearchOption {
-		$this->placeholder = $placeholder;
-
-		return $this;
-	}
-
-	/**
-	 * Get the placeholder.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getPlaceholder(): string {
-		return $this->placeholder;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'name' => $this->getName(),
-			'title' => $this->getTitle(),
-			'type' => $this->getType(),
-			'size' => $this->getSize(),
-			'placeholder' => $this->getPlaceholder()
-		];
-	}
+    /** @var string */
+    private $name = '';
+
+    /** @var string */
+    private $title = '';
+
+    /** @var string */
+    private $type = '';
+
+    /** @var string */
+    private $size = '';
+
+    /** @var string */
+    private $placeholder = '';
+
+
+    /**
+     *     *
+     *
+     * The array can be empty in case no search options are available.
+     * The format of the array must be like this:
+     *
+     * [
+     *   'panel' => [
+     *     'options' => [
+     *         OPTION1,
+     *         OPTION2,
+     *         OPTION3
+     *     ]
+     *   ],
+     *   'navigation' => [
+     *     'icon'    => 'css-class-of-the-icon',
+     *     'options' => [
+     *         OPTION1,
+     *         OPTION2,
+     *         OPTION3
+     *     ]
+     *   ]
+     * ]
+     *
+     * - PANEL contains entries that will be displayed in the app itself, when
+     *   a search is initiated.
+     * - NAVIGATION contains entries that will be available when using the
+     *   FullTextSearch navigation page
+     * - OPTION is an element that define each option available to the user.
+     *
+     * The format for the options must be like this:
+     *
+     * [
+     *   'name'        => 'name_of_the_option',
+     *   'title'       => 'Name displayed in the panel',
+     *   'type'        => '',
+     *   'size'        => ''   (optional),
+     *   'placeholder' => ''   (optional)
+     * ]
+     *
+     * - NAME is the variable name that is sent to the IFullTextSearchProvider
+     *   when a ISearchRequest is requested. (keys in the array returned by the
+     *   ISearchRequest->getOptions())
+     * - TYPE can be 'input' or 'checkbox'
+     * - SIZE is only used in case TYPE='input', default is 'large' but can be
+     *   'small'
+     * - PLACEHOLDER is only used in case TYPE='input', default is empty.
+     */
+
+    /**
+     * ISearchOption constructor.
+     *
+     * Some value can be setduring the creation of the object.
+     *
+     * @since 15.0.0
+     *
+     * @param string $name
+     * @param string $title
+     * @param string $type
+     * @param string $size
+     * @param string $placeholder
+     */
+    public function __construct(string $name = '', string $title = '', string $type = '', string $size = '', string $placeholder = '') {
+        $this->name = $name;
+        $this->title = $title;
+        $this->type = $type;
+        $this->size = $size;
+        $this->placeholder = $placeholder;
+    }
+
+
+    /**
+     * 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 15.0.0
+     *
+     * @param string $name
+     *
+     * @return ISearchOption
+     */
+    public function setName(string $name): ISearchOption {
+        $this->name = $name;
+
+        return $this;
+    }
+
+    /**
+     * Get the name/key of the option.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getName(): string {
+        return $this->name;
+    }
+
+
+    /**
+     * Set the title/display name of the option.
+     *
+     * @since 15.0.0
+     *
+     * @param string $title
+     *
+     * @return ISearchOption
+     */
+    public function setTitle(string $title): ISearchOption {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * Get the title of the option.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getTitle(): string {
+        return $this->title;
+    }
+
+
+    /**
+     * Set the type of the option.
+     * $type can be ISearchOption::CHECKBOX or ISearchOption::INPUT
+     *
+     * @since 15.0.0
+     *
+     * @param string $type
+     *
+     * @return ISearchOption
+     */
+    public function setType(string $type): ISearchOption {
+        $this->type = $type;
+
+        return $this;
+    }
+
+    /**
+     * Get the type of the option.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getType(): string {
+        return $this->type;
+    }
+
+
+    /**
+     * In case of Type is INPUT, set the size of the input field.
+     * Value can be ISearchOption::INPUT_SMALL or not defined.
+     *
+     * @since 15.0.0
+     *
+     * @param string $size
+     *
+     * @return ISearchOption
+     */
+    public function setSize(string $size): ISearchOption {
+        $this->size = $size;
+
+        return $this;
+    }
+
+    /**
+     * Get the size of the INPUT.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getSize(): string {
+        return $this->size;
+    }
+
+
+    /**
+     * In case of Type is , set the placeholder to be displayed in the input
+     * field.
+     *
+     * @since 15.0.0
+     *
+     * @param string $placeholder
+     *
+     * @return ISearchOption
+     */
+    public function setPlaceholder(string $placeholder): ISearchOption {
+        $this->placeholder = $placeholder;
+
+        return $this;
+    }
+
+    /**
+     * Get the placeholder.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getPlaceholder(): string {
+        return $this->placeholder;
+    }
+
+
+    /**
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function jsonSerialize(): array {
+        return [
+            'name' => $this->getName(),
+            'title' => $this->getTitle(),
+            'type' => $this->getType(),
+            'size' => $this->getSize(),
+            'placeholder' => $this->getPlaceholder()
+        ];
+    }
 }

lib/private/FullTextSearch/Model/SearchTemplate.php

Indentation +191 added lines, -191 removed lines

@@ -65,196 +65,196 @@
 final class SearchTemplate implements ISearchTemplate, JsonSerializable {
 
 
-	/** @var string */
-	private $icon = '';
-
-	/** @var string */
-	private $css = '';
-
-	/** @var string */
-	private $template = '';
-
-	/** @var SearchOption[] */
-	private $panelOptions = [];
-
-	/** @var SearchOption[] */
-	private $navigationOptions = [];
-
-
-	/**
-	 * ISearchTemplate constructor.
-	 *
-	 * the class of the icon and the css file to be loaded can be set during the
-	 * creation of the object.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $icon
-	 * @param string $css
-	 */
-	public function __construct(string $icon = '', string $css = '') {
-		$this->icon = $icon;
-		$this->css = $css;
-	}
-
-
-	/**
-	 * 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 15.0.0
-	 *
-	 * @param string $class
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setIcon(string $class): ISearchTemplate {
-		$this->icon = $class;
-
-		return $this;
-	}
-
-	/**
-	 * Get the class of the icon.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getIcon(): string {
-		return $this->icon;
-	}
-
-
-	/**
-	 * Set the path of a CSS file that will be loaded when needed.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $css
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setCss(string $css): ISearchTemplate {
-		$this->css = $css;
-
-		return $this;
-	}
-
-	/**
-	 * Get the path of the CSS file.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getCss(): string {
-		return $this->css;
-	}
-
-
-	/**
-	 * 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 15.0.0
-	 *
-	 * @param string $template
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function setTemplate(string $template): ISearchTemplate {
-		$this->template = $template;
-
-		return $this;
-	}
-
-	/**
-	 * Get the path of the template file.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	public function getTemplate(): string {
-		return $this->template;
-	}
-
-
-	/**
-	 * 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 15.0.0
-	 *
-	 * @param ISearchOption $option
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function addPanelOption(ISearchOption $option): ISearchTemplate {
-		$this->panelOptions[] = $option;
-
-		return $this;
-	}
-
-	/**
-	 * Get all options to be displayed in the Panel.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return SearchOption[]
-	 */
-	public function getPanelOptions(): array {
-		return $this->panelOptions;
-	}
-
-
-	/**
-	 * Add an option in the left panel of the FullTextSearch navigation page.
-	 *
-	 * @see ISearchOption
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchOption $option
-	 *
-	 * @return ISearchTemplate
-	 */
-	public function addNavigationOption(ISearchOption $option): ISearchTemplate {
-		$this->navigationOptions[] = $option;
-
-		return $this;
-	}
-
-	/**
-	 * Get all options to be displayed in the FullTextSearch navigation page.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function getNavigationOptions(): array {
-		return $this->navigationOptions;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'icon' => $this->getIcon(),
-			'css' => $this->getCss(),
-			'template' => $this->getTemplate(),
-			'panel' => $this->getPanelOptions(),
-			'navigation' => $this->getNavigationOptions()
-		];
-	}
+    /** @var string */
+    private $icon = '';
+
+    /** @var string */
+    private $css = '';
+
+    /** @var string */
+    private $template = '';
+
+    /** @var SearchOption[] */
+    private $panelOptions = [];
+
+    /** @var SearchOption[] */
+    private $navigationOptions = [];
+
+
+    /**
+     * ISearchTemplate constructor.
+     *
+     * the class of the icon and the css file to be loaded can be set during the
+     * creation of the object.
+     *
+     * @since 15.0.0
+     *
+     * @param string $icon
+     * @param string $css
+     */
+    public function __construct(string $icon = '', string $css = '') {
+        $this->icon = $icon;
+        $this->css = $css;
+    }
+
+
+    /**
+     * 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 15.0.0
+     *
+     * @param string $class
+     *
+     * @return ISearchTemplate
+     */
+    public function setIcon(string $class): ISearchTemplate {
+        $this->icon = $class;
+
+        return $this;
+    }
+
+    /**
+     * Get the class of the icon.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getIcon(): string {
+        return $this->icon;
+    }
+
+
+    /**
+     * Set the path of a CSS file that will be loaded when needed.
+     *
+     * @since 15.0.0
+     *
+     * @param string $css
+     *
+     * @return ISearchTemplate
+     */
+    public function setCss(string $css): ISearchTemplate {
+        $this->css = $css;
+
+        return $this;
+    }
+
+    /**
+     * Get the path of the CSS file.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getCss(): string {
+        return $this->css;
+    }
+
+
+    /**
+     * 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 15.0.0
+     *
+     * @param string $template
+     *
+     * @return ISearchTemplate
+     */
+    public function setTemplate(string $template): ISearchTemplate {
+        $this->template = $template;
+
+        return $this;
+    }
+
+    /**
+     * Get the path of the template file.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    public function getTemplate(): string {
+        return $this->template;
+    }
+
+
+    /**
+     * 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 15.0.0
+     *
+     * @param ISearchOption $option
+     *
+     * @return ISearchTemplate
+     */
+    public function addPanelOption(ISearchOption $option): ISearchTemplate {
+        $this->panelOptions[] = $option;
+
+        return $this;
+    }
+
+    /**
+     * Get all options to be displayed in the Panel.
+     *
+     * @since 15.0.0
+     *
+     * @return SearchOption[]
+     */
+    public function getPanelOptions(): array {
+        return $this->panelOptions;
+    }
+
+
+    /**
+     * Add an option in the left panel of the FullTextSearch navigation page.
+     *
+     * @see ISearchOption
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchOption $option
+     *
+     * @return ISearchTemplate
+     */
+    public function addNavigationOption(ISearchOption $option): ISearchTemplate {
+        $this->navigationOptions[] = $option;
+
+        return $this;
+    }
+
+    /**
+     * Get all options to be displayed in the FullTextSearch navigation page.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function getNavigationOptions(): array {
+        return $this->navigationOptions;
+    }
+
+
+    /**
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    public function jsonSerialize(): array {
+        return [
+            'icon' => $this->getIcon(),
+            'css' => $this->getCss(),
+            'template' => $this->getTemplate(),
+            'panel' => $this->getPanelOptions(),
+            'navigation' => $this->getNavigationOptions()
+        ];
+    }
 }
 

lib/private/FullTextSearch/Model/DocumentAccess.php

Indentation +303 added lines, -303 removed lines

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

lib/private/Collaboration/Resources/Resource.php

Indentation +125 added lines, -125 removed lines

@@ -31,129 +31,129 @@
 
 class Resource implements IResource {
 
-	/** @var IManager */
-	protected $manager;
-
-	/** @var IDBConnection */
-	protected $connection;
-
-	/** @var string */
-	protected $type;
-
-	/** @var string */
-	protected $id;
-
-	/** @var IUser|null */
-	protected $userForAccess;
-
-	/** @var bool|null */
-	protected $access;
-
-	/** @var array|null */
-	protected $data;
-
-	public function __construct(
-		IManager $manager,
-		IDBConnection $connection,
-		string $type,
-		string $id,
-		?IUser $userForAccess = null,
-		?bool $access = null
-	) {
-		$this->manager = $manager;
-		$this->connection = $connection;
-		$this->type = $type;
-		$this->id = $id;
-		$this->userForAccess = $userForAccess;
-		$this->access = $access;
-	}
-
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getType(): string {
-		return $this->type;
-	}
-
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getId(): string {
-		return $this->id;
-	}
-
-	/**
-	 * @return array
-	 * @since 16.0.0
-	 */
-	public function getRichObject(): array {
-		if ($this->data === null) {
-			$this->data = $this->manager->getResourceRichObject($this);
-		}
-
-		return $this->data;
-	}
-
-	/**
-	 * Can a user/guest access the resource
-	 *
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccess(?IUser $user): bool {
-		if ($user instanceof IUser) {
-			return $this->canUserAccess($user);
-		}
-		return $this->canGuestAccess();
-	}
-
-	protected function canUserAccess(IUser $user): bool {
-		if (\is_bool($this->access) && $this->userForAccess instanceof IUser && $user->getUID() === $this->userForAccess->getUID()) {
-			return $this->access;
-		}
-
-		$access = $this->manager->canAccessResource($this, $user);
-		if ($this->userForAccess instanceof IUser && $user->getUID() === $this->userForAccess->getUID()) {
-			$this->access = $access;
-		}
-		return $access;
-	}
-
-	protected function canGuestAccess(): bool {
-		if (\is_bool($this->access) && !$this->userForAccess instanceof IUser) {
-			return $this->access;
-		}
-
-		$access = $this->manager->canAccessResource($this, null);
-		if (!$this->userForAccess instanceof IUser) {
-			$this->access = $access;
-		}
-		return $access;
-	}
-
-	/**
-	 * @return ICollection[]
-	 * @since 16.0.0
-	 */
-	public function getCollections(): array {
-		$collections = [];
-
-		$query = $this->connection->getQueryBuilder();
-
-		$query->select('collection_id')
-			->from('collres_resources')
-			->where($query->expr()->eq('resource_type', $query->createNamedParameter($this->getType())))
-			->andWhere($query->expr()->eq('resource_id', $query->createNamedParameter($this->getId())));
-
-		$result = $query->execute();
-		while ($row = $result->fetch()) {
-			$collections[] = $this->manager->getCollection((int) $row['collection_id']);
-		}
-		$result->closeCursor();
-
-		return $collections;
-	}
+    /** @var IManager */
+    protected $manager;
+
+    /** @var IDBConnection */
+    protected $connection;
+
+    /** @var string */
+    protected $type;
+
+    /** @var string */
+    protected $id;
+
+    /** @var IUser|null */
+    protected $userForAccess;
+
+    /** @var bool|null */
+    protected $access;
+
+    /** @var array|null */
+    protected $data;
+
+    public function __construct(
+        IManager $manager,
+        IDBConnection $connection,
+        string $type,
+        string $id,
+        ?IUser $userForAccess = null,
+        ?bool $access = null
+    ) {
+        $this->manager = $manager;
+        $this->connection = $connection;
+        $this->type = $type;
+        $this->id = $id;
+        $this->userForAccess = $userForAccess;
+        $this->access = $access;
+    }
+
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getType(): string {
+        return $this->type;
+    }
+
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getId(): string {
+        return $this->id;
+    }
+
+    /**
+     * @return array
+     * @since 16.0.0
+     */
+    public function getRichObject(): array {
+        if ($this->data === null) {
+            $this->data = $this->manager->getResourceRichObject($this);
+        }
+
+        return $this->data;
+    }
+
+    /**
+     * Can a user/guest access the resource
+     *
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccess(?IUser $user): bool {
+        if ($user instanceof IUser) {
+            return $this->canUserAccess($user);
+        }
+        return $this->canGuestAccess();
+    }
+
+    protected function canUserAccess(IUser $user): bool {
+        if (\is_bool($this->access) && $this->userForAccess instanceof IUser && $user->getUID() === $this->userForAccess->getUID()) {
+            return $this->access;
+        }
+
+        $access = $this->manager->canAccessResource($this, $user);
+        if ($this->userForAccess instanceof IUser && $user->getUID() === $this->userForAccess->getUID()) {
+            $this->access = $access;
+        }
+        return $access;
+    }
+
+    protected function canGuestAccess(): bool {
+        if (\is_bool($this->access) && !$this->userForAccess instanceof IUser) {
+            return $this->access;
+        }
+
+        $access = $this->manager->canAccessResource($this, null);
+        if (!$this->userForAccess instanceof IUser) {
+            $this->access = $access;
+        }
+        return $access;
+    }
+
+    /**
+     * @return ICollection[]
+     * @since 16.0.0
+     */
+    public function getCollections(): array {
+        $collections = [];
+
+        $query = $this->connection->getQueryBuilder();
+
+        $query->select('collection_id')
+            ->from('collres_resources')
+            ->where($query->expr()->eq('resource_type', $query->createNamedParameter($this->getType())))
+            ->andWhere($query->expr()->eq('resource_id', $query->createNamedParameter($this->getId())));
+
+        $result = $query->execute();
+        while ($row = $result->fetch()) {
+            $collections[] = $this->manager->getCollection((int) $row['collection_id']);
+        }
+        $result->closeCursor();
+
+        return $collections;
+    }
 }

lib/public/Collaboration/Resources/IResource.php

Indentation +28 added lines, -28 removed lines

@@ -29,36 +29,36 @@
  */
 interface IResource {
 
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getType(): string;
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getType(): string;
 
-	/**
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getId(): string;
+    /**
+     * @return string
+     * @since 16.0.0
+     */
+    public function getId(): string;
 
-	/**
-	 * @return array
-	 * @since 16.0.0
-	 */
-	public function getRichObject(): array;
+    /**
+     * @return array
+     * @since 16.0.0
+     */
+    public function getRichObject(): array;
 
-	/**
-	 * Can a user/guest access the resource
-	 *
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccess(?IUser $user): bool;
+    /**
+     * Can a user/guest access the resource
+     *
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccess(?IUser $user): bool;
 
-	/**
-	 * @return ICollection[]
-	 * @since 16.0.0
-	 */
-	public function getCollections(): array;
+    /**
+     * @return ICollection[]
+     * @since 16.0.0
+     */
+    public function getCollections(): array;
 }

lib/public/Collaboration/Resources/IProvider.php

Indentation +24 added lines, -24 removed lines

@@ -29,31 +29,31 @@
  */
 interface IProvider {
 
-	/**
-	 * Get the resource type of the provider
-	 *
-	 * @return string
-	 * @since 16.0.0
-	 */
-	public function getType(): string;
+    /**
+     * Get the resource type of the provider
+     *
+     * @return string
+     * @since 16.0.0
+     */
+    public function getType(): string;
 
-	/**
-	 * Get the rich object data of a resource
-	 *
-	 * @param IResource $resource
-	 * @return array
-	 * @since 16.0.0
-	 */
-	public function getResourceRichObject(IResource $resource): array;
+    /**
+     * Get the rich object data of a resource
+     *
+     * @param IResource $resource
+     * @return array
+     * @since 16.0.0
+     */
+    public function getResourceRichObject(IResource $resource): array;
 
-	/**
-	 * Can a user/guest access the collection
-	 *
-	 * @param IResource $resource
-	 * @param IUser|null $user
-	 * @return bool
-	 * @since 16.0.0
-	 */
-	public function canAccessResource(IResource $resource, ?IUser $user): bool;
+    /**
+     * Can a user/guest access the collection
+     *
+     * @param IResource $resource
+     * @param IUser|null $user
+     * @return bool
+     * @since 16.0.0
+     */
+    public function canAccessResource(IResource $resource, ?IUser $user): bool;
 
 }

core/Controller/CollaborationResourcesController.php

Indentation +252 added lines, -252 removed lines

@@ -37,256 +37,256 @@
 
 class CollaborationResourcesController extends OCSController {
 
-	/** @var IManager */
-	private $manager;
-	/** @var IUserSession */
-	private $userSession;
-	/** @var ILogger */
-	private $logger;
-
-	public function __construct(
-		string $appName,
-		IRequest $request,
-		IManager $manager,
-		IUserSession $userSession,
-		ILogger $logger
-	) {
-		parent::__construct($appName, $request);
-
-		$this->manager = $manager;
-		$this->userSession = $userSession;
-		$this->logger = $logger;
-	}
-
-	/**
-	 * @param int $collectionId
-	 * @return ICollection
-	 * @throws CollectionException when the collection was not found for the user
-	 */
-	protected function getCollection(int $collectionId): ICollection {
-		$collection = $this->manager->getCollectionForUser($collectionId, $this->userSession->getUser());
-
-		if (!$collection->canAccess($this->userSession->getUser())) {
-			throw new CollectionException('Not found');
-		}
-
-		return $collection;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param int $collectionId
-	 * @return DataResponse
-	 */
-	public function listCollection(int $collectionId): DataResponse {
-		try {
-			$collection = $this->getCollection($collectionId);
-		} catch (CollectionException $e) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		return $this->respondCollection($collection);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param string $filter
-	 * @return DataResponse
-	 */
-	public function searchCollections(string $filter): DataResponse {
-		try {
-			$collections = $this->manager->searchCollections($this->userSession->getUser(), $filter);
-		} catch (CollectionException $e) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		return new DataResponse($this->prepareCollections($collections));
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param int $collectionId
-	 * @param string $resourceType
-	 * @param string $resourceId
-	 * @return DataResponse
-	 */
-	public function addResource(int $collectionId, string $resourceType, string $resourceId): DataResponse {
-		try {
-			$collection = $this->getCollection($collectionId);
-		} catch (CollectionException $e) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		$resource = $this->manager->createResource($resourceType, $resourceId);
-
-		if (!$resource->canAccess($this->userSession->getUser())) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		try {
-			$collection->addResource($resource);
-		} catch (ResourceException $e) {
-		}
-
-		return $this->respondCollection($collection);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param int $collectionId
-	 * @param string $resourceType
-	 * @param string $resourceId
-	 * @return DataResponse
-	 */
-	public function removeResource(int $collectionId, string $resourceType, string $resourceId): DataResponse {
-		try {
-			$collection = $this->getCollection($collectionId);
-		} catch (CollectionException $e) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		try {
-			$resource = $this->manager->getResourceForUser($resourceType, $resourceId, $this->userSession->getUser());
-		} catch (CollectionException $e) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		$collection->removeResource($resource);
-
-		return $this->respondCollection($collection);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param string $resourceType
-	 * @param string $resourceId
-	 * @return DataResponse
-	 */
-	public function getCollectionsByResource(string $resourceType, string $resourceId): DataResponse {
-		try {
-			$resource = $this->manager->getResourceForUser($resourceType, $resourceId, $this->userSession->getUser());
-		} catch (ResourceException $e) {
-			$resource = $this->manager->createResource($resourceType, $resourceId);
-		}
-
-		if (!$resource->canAccess($this->userSession->getUser())) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		return new DataResponse($this->prepareCollections($resource->getCollections()));
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param string $baseResourceType
-	 * @param string $baseResourceId
-	 * @param string $name
-	 * @return DataResponse
-	 */
-	public function createCollectionOnResource(string $baseResourceType, string $baseResourceId, string $name): DataResponse {
-		if (!isset($name[0]) || isset($name[64])) {
-			return new DataResponse([], Http::STATUS_BAD_REQUEST);
-		}
-
-		try {
-			$resource = $this->manager->createResource($baseResourceType, $baseResourceId);
-		} catch (CollectionException $e) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		if (!$resource->canAccess($this->userSession->getUser())) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		$collection = $this->manager->newCollection($name);
-		$collection->addResource($resource);
-
-		return $this->respondCollection($collection);
-	}
-
-	/**
-	 * @NoAdminRequired
-	 *
-	 * @param int $collectionId
-	 * @param string $collectionName
-	 * @return DataResponse
-	 */
-	public function renameCollection(int $collectionId, string $collectionName): DataResponse {
-		try {
-			$collection = $this->getCollection($collectionId);
-		} catch (CollectionException $exception) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		}
-
-		$collection->setName($collectionName);
-
-		return $this->respondCollection($collection);
-	}
-
-	protected function respondCollection(ICollection $collection): DataResponse {
-		try {
-			return new DataResponse($this->prepareCollection($collection));
-		} catch (CollectionException $e) {
-			return new DataResponse([], Http::STATUS_NOT_FOUND);
-		} catch (Exception $e) {
-			$this->logger->logException($e);
-			return new DataResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
-
-	protected function prepareCollections(array $collections): array {
-		$result = [];
-
-		foreach ($collections as $collection) {
-			try {
-				$result[] = $this->prepareCollection($collection);
-			} catch (CollectionException $e) {
-			} catch (Exception $e) {
-				$this->logger->logException($e);
-			}
-		}
-
-		return $result;
-	}
-
-	protected function prepareCollection(ICollection $collection): array {
-		if (!$collection->canAccess($this->userSession->getUser())) {
-			throw new CollectionException('Can not access collection');
-		}
-
-		return [
-			'id' => $collection->getId(),
-			'name' => $collection->getName(),
-			'resources' => $this->prepareResources($collection->getResources()),
-		];
-	}
-
-	protected function prepareResources(array $resources): ?array {
-		$result = [];
-
-		foreach ($resources as $resource) {
-			try {
-				$result[] = $this->prepareResource($resource);
-			} catch (ResourceException $e) {
-			} catch (Exception $e) {
-				$this->logger->logException($e);
-			}
-		}
-
-		return $result;
-	}
-
-	protected function prepareResource(IResource $resource): array {
-		if (!$resource->canAccess($this->userSession->getUser())) {
-			throw new ResourceException('Can not access resource');
-		}
-
-		return $resource->getRichObject();
-	}
+    /** @var IManager */
+    private $manager;
+    /** @var IUserSession */
+    private $userSession;
+    /** @var ILogger */
+    private $logger;
+
+    public function __construct(
+        string $appName,
+        IRequest $request,
+        IManager $manager,
+        IUserSession $userSession,
+        ILogger $logger
+    ) {
+        parent::__construct($appName, $request);
+
+        $this->manager = $manager;
+        $this->userSession = $userSession;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @param int $collectionId
+     * @return ICollection
+     * @throws CollectionException when the collection was not found for the user
+     */
+    protected function getCollection(int $collectionId): ICollection {
+        $collection = $this->manager->getCollectionForUser($collectionId, $this->userSession->getUser());
+
+        if (!$collection->canAccess($this->userSession->getUser())) {
+            throw new CollectionException('Not found');
+        }
+
+        return $collection;
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param int $collectionId
+     * @return DataResponse
+     */
+    public function listCollection(int $collectionId): DataResponse {
+        try {
+            $collection = $this->getCollection($collectionId);
+        } catch (CollectionException $e) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        return $this->respondCollection($collection);
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param string $filter
+     * @return DataResponse
+     */
+    public function searchCollections(string $filter): DataResponse {
+        try {
+            $collections = $this->manager->searchCollections($this->userSession->getUser(), $filter);
+        } catch (CollectionException $e) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        return new DataResponse($this->prepareCollections($collections));
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param int $collectionId
+     * @param string $resourceType
+     * @param string $resourceId
+     * @return DataResponse
+     */
+    public function addResource(int $collectionId, string $resourceType, string $resourceId): DataResponse {
+        try {
+            $collection = $this->getCollection($collectionId);
+        } catch (CollectionException $e) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        $resource = $this->manager->createResource($resourceType, $resourceId);
+
+        if (!$resource->canAccess($this->userSession->getUser())) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        try {
+            $collection->addResource($resource);
+        } catch (ResourceException $e) {
+        }
+
+        return $this->respondCollection($collection);
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param int $collectionId
+     * @param string $resourceType
+     * @param string $resourceId
+     * @return DataResponse
+     */
+    public function removeResource(int $collectionId, string $resourceType, string $resourceId): DataResponse {
+        try {
+            $collection = $this->getCollection($collectionId);
+        } catch (CollectionException $e) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        try {
+            $resource = $this->manager->getResourceForUser($resourceType, $resourceId, $this->userSession->getUser());
+        } catch (CollectionException $e) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        $collection->removeResource($resource);
+
+        return $this->respondCollection($collection);
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param string $resourceType
+     * @param string $resourceId
+     * @return DataResponse
+     */
+    public function getCollectionsByResource(string $resourceType, string $resourceId): DataResponse {
+        try {
+            $resource = $this->manager->getResourceForUser($resourceType, $resourceId, $this->userSession->getUser());
+        } catch (ResourceException $e) {
+            $resource = $this->manager->createResource($resourceType, $resourceId);
+        }
+
+        if (!$resource->canAccess($this->userSession->getUser())) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        return new DataResponse($this->prepareCollections($resource->getCollections()));
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param string $baseResourceType
+     * @param string $baseResourceId
+     * @param string $name
+     * @return DataResponse
+     */
+    public function createCollectionOnResource(string $baseResourceType, string $baseResourceId, string $name): DataResponse {
+        if (!isset($name[0]) || isset($name[64])) {
+            return new DataResponse([], Http::STATUS_BAD_REQUEST);
+        }
+
+        try {
+            $resource = $this->manager->createResource($baseResourceType, $baseResourceId);
+        } catch (CollectionException $e) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        if (!$resource->canAccess($this->userSession->getUser())) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        $collection = $this->manager->newCollection($name);
+        $collection->addResource($resource);
+
+        return $this->respondCollection($collection);
+    }
+
+    /**
+     * @NoAdminRequired
+     *
+     * @param int $collectionId
+     * @param string $collectionName
+     * @return DataResponse
+     */
+    public function renameCollection(int $collectionId, string $collectionName): DataResponse {
+        try {
+            $collection = $this->getCollection($collectionId);
+        } catch (CollectionException $exception) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        }
+
+        $collection->setName($collectionName);
+
+        return $this->respondCollection($collection);
+    }
+
+    protected function respondCollection(ICollection $collection): DataResponse {
+        try {
+            return new DataResponse($this->prepareCollection($collection));
+        } catch (CollectionException $e) {
+            return new DataResponse([], Http::STATUS_NOT_FOUND);
+        } catch (Exception $e) {
+            $this->logger->logException($e);
+            return new DataResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
+
+    protected function prepareCollections(array $collections): array {
+        $result = [];
+
+        foreach ($collections as $collection) {
+            try {
+                $result[] = $this->prepareCollection($collection);
+            } catch (CollectionException $e) {
+            } catch (Exception $e) {
+                $this->logger->logException($e);
+            }
+        }
+
+        return $result;
+    }
+
+    protected function prepareCollection(ICollection $collection): array {
+        if (!$collection->canAccess($this->userSession->getUser())) {
+            throw new CollectionException('Can not access collection');
+        }
+
+        return [
+            'id' => $collection->getId(),
+            'name' => $collection->getName(),
+            'resources' => $this->prepareResources($collection->getResources()),
+        ];
+    }
+
+    protected function prepareResources(array $resources): ?array {
+        $result = [];
+
+        foreach ($resources as $resource) {
+            try {
+                $result[] = $this->prepareResource($resource);
+            } catch (ResourceException $e) {
+            } catch (Exception $e) {
+                $this->logger->logException($e);
+            }
+        }
+
+        return $result;
+    }
+
+    protected function prepareResource(IResource $resource): array {
+        if (!$resource->canAccess($this->userSession->getUser())) {
+            throw new ResourceException('Can not access resource');
+        }
+
+        return $resource->getRichObject();
+    }
 }

lib/public/FullTextSearch/IFullTextSearchManager.php

Indentation +139 added lines, -139 removed lines

@@ -51,145 +51,145 @@
 interface IFullTextSearchManager {
 
 
-	/**
-	 * Register a IProviderService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IProviderService $providerService
-	 */
-	public function registerProviderService(IProviderService $providerService);
-
-	/**
-	 * Register a IIndexService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndexService $indexService
-	 */
-	public function registerIndexService(IIndexService $indexService);
-
-	/**
-	 * Register a ISearchService.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param ISearchService $searchService
-	 */
-	public function registerSearchService(ISearchService $searchService);
-
-	/**
-	 * returns true is Full Text Search is available (app is present and Service
-	 * are registered)
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	public function isAvailable(): bool;
-
-
-	/**
-	 * Add the Javascript API in the navigation page of an app.
-	 * Needed to replace the default search.
-	 *
-	 * @since 15.0.0
-	 */
-	public function addJavascriptAPI();
-
-
-	/**
-	 * Check if the provider $providerId is already indexed.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 *
-	 * @return bool
-	 */
-	public function isProviderIndexed(string $providerId): bool;
-
-
-	/**
-	 * Retrieve an Index from the database, based on the Id of the Provider
-	 * and the Id of the Document
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 *
-	 * @return IIndex
-	 */
-	public function getIndex(string $providerId, string $documentId): IIndex;
-
-
-	/**
-	 * Create a new Index.
-	 *
-	 * This method must be called when a new document is created.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param string $userId
-	 * @param int $status
-	 *
-	 * @return IIndex
-	 */
-	public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
-
-
-	/**
-	 * Update the status of an Index. status is a bitflag, setting $reset to
-	 * true will reset the status to the value defined in the parameter.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 * @param int $status
-	 * @param bool $reset
-	 */
-	public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
-
-
-	/**
-	 * Update the status of an array of Index. status is a bit flag, setting $reset to
-	 * true will reset the status to the value defined in the parameter.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param array $documentIds
-	 * @param int $status
-	 * @param bool $reset
-	 */
-	public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
-
-	/**
-	 * Update an array of Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex[] $indexes
-	 */
-	public function updateIndexes(array $indexes);
-
-	/**
-	 * Search using an array as request. If $userId is empty, will use the
-	 * current session.
-	 *
-	 * @see ISearchService::generateSearchRequest
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $request
-	 * @param string $userId
-	 * @return ISearchResult[]
-	 */
-	public function search(array $request, string $userId = ''): array;
+    /**
+     * Register a IProviderService.
+     *
+     * @since 15.0.0
+     *
+     * @param IProviderService $providerService
+     */
+    public function registerProviderService(IProviderService $providerService);
+
+    /**
+     * Register a IIndexService.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndexService $indexService
+     */
+    public function registerIndexService(IIndexService $indexService);
+
+    /**
+     * Register a ISearchService.
+     *
+     * @since 15.0.0
+     *
+     * @param ISearchService $searchService
+     */
+    public function registerSearchService(ISearchService $searchService);
+
+    /**
+     * returns true is Full Text Search is available (app is present and Service
+     * are registered)
+     *
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    public function isAvailable(): bool;
+
+
+    /**
+     * Add the Javascript API in the navigation page of an app.
+     * Needed to replace the default search.
+     *
+     * @since 15.0.0
+     */
+    public function addJavascriptAPI();
+
+
+    /**
+     * Check if the provider $providerId is already indexed.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     *
+     * @return bool
+     */
+    public function isProviderIndexed(string $providerId): bool;
+
+
+    /**
+     * Retrieve an Index from the database, based on the Id of the Provider
+     * and the Id of the Document
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     *
+     * @return IIndex
+     */
+    public function getIndex(string $providerId, string $documentId): IIndex;
+
+
+    /**
+     * Create a new Index.
+     *
+     * This method must be called when a new document is created.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     * @param string $userId
+     * @param int $status
+     *
+     * @return IIndex
+     */
+    public function createIndex(string $providerId, string $documentId, string $userId, int $status = 0): IIndex;
+
+
+    /**
+     * Update the status of an Index. status is a bitflag, setting $reset to
+     * true will reset the status to the value defined in the parameter.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     * @param int $status
+     * @param bool $reset
+     */
+    public function updateIndexStatus(string $providerId, string $documentId, int $status, bool $reset = false);
+
+
+    /**
+     * Update the status of an array of Index. status is a bit flag, setting $reset to
+     * true will reset the status to the value defined in the parameter.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param array $documentIds
+     * @param int $status
+     * @param bool $reset
+     */
+    public function updateIndexesStatus(string $providerId, array $documentIds, int $status, bool $reset = false);
+
+    /**
+     * Update an array of Index.
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex[] $indexes
+     */
+    public function updateIndexes(array $indexes);
+
+    /**
+     * Search using an array as request. If $userId is empty, will use the
+     * current session.
+     *
+     * @see ISearchService::generateSearchRequest
+     *
+     * @since 15.0.0
+     *
+     * @param array $request
+     * @param string $userId
+     * @return ISearchResult[]
+     */
+    public function search(array $request, string $userId = ''): array;
 
 
 }