nextcloud / server

lib/public/FullTextSearch/Model/ISearchTemplate.php

Indentation +112 added lines, -112 removed lines

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

lib/public/FullTextSearch/Model/IDocumentAccess.php

Indentation +205 added lines, -205 removed lines

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

lib/public/FullTextSearch/Model/ISearchResult.php

Indentation +137 added lines, -137 removed lines

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

lib/public/FullTextSearch/IFullTextSearchPlatform.php

Indentation +141 added lines, -141 removed lines

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

lib/public/FullTextSearch/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/IndexDocument.php

Spacing +1 added lines, -1 removed lines

@@ -389,7 +389,7 @@
 		foreach ($ak as $source) {
 			$tags = $this->subTags[$source];
 			foreach ($tags as $tag) {
-				$subTags[] = $source . '_' . $tag;
+				$subTags[] = $source.'_'.$tag;
 			}
 		}
 

Indentation +934 added lines, -934 removed lines

@@ -49,940 +49,940 @@
 class IndexDocument implements IIndexDocument, JsonSerializable {
 
 
-	/** @var string */
-	protected $id = '';
+    /** @var string */
+    protected $id = '';
 
-	/** @var string */
-	protected $providerId = '';
+    /** @var string */
+    protected $providerId = '';
 
-	/** @var DocumentAccess */
-	protected $access;
-
-	/** @var IIndex */
-	protected $index;
-
-	/** @var int */
-	protected $modifiedTime = 0;
-
-	/** @var string */
-	protected $source = '';
-
-	/** @var array */
-	protected $tags = [];
-
-	/** @var array */
-	protected $metaTags = [];
-
-	/** @var array */
-	protected $subTags = [];
-
-	/** @var string */
-	protected $title = '';
-
-	/** @var string */
-	protected $content = '';
-
-	/** @var string */
-	protected $hash = '';
-
-	/** @var array */
-	protected $parts = [];
-
-	/** @var string */
-	protected $link = '';
-
-	/** @var array */
-	protected $more = [];
-
-	/** @var array */
-	protected $excerpts = [];
-
-	/** @var string */
-	protected $score = '';
-
-	/** @var array */
-	protected $info = [];
-
-	/** @var int */
-	protected $contentEncoded = 0;
-
-
-	/**
-	 * IIndexDocument constructor.
-	 *
-	 * On creation, we assure the uniqueness of the object using the providerId
-	 * and the Id of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $providerId
-	 * @param string $documentId
-	 */
-	public function __construct(string $providerId, string $documentId) {
-		$this->providerId = $providerId;
-		$this->id = $documentId;
-	}
-
-
-	/**
-	 * Returns the Id of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getId(): string {
-		return $this->id;
-	}
-
-
-	/**
-	 * Returns the Id of the provider.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getProviderId(): string {
-		return $this->providerId;
-	}
-
-
-	/**
-	 * Set the Index related to the IIndexDocument.
-	 *
-	 * @see IIndex
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IIndex $index
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setIndex(IIndex $index): IIndexDocument {
-		$this->index = $index;
-
-		return $this;
-	}
-
-	/**
-	 * Get the Index.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndex
-	 */
-	final public function getIndex(): IIndex {
-		return $this->index;
-	}
-
-	/**
-	 * return if Index is defined.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @return bool
-	 */
-	final public function hasIndex(): bool {
-		return ($this->index !== null);
-	}
-
-
-	/**
-	 * Set the modified time of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $modifiedTime
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setModifiedTime(int $modifiedTime): IIndexDocument {
-		$this->modifiedTime = $modifiedTime;
-
-		return $this;
-	}
-
-	/**
-	 * Get the modified time of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function getModifiedTime(): int {
-		return $this->modifiedTime;
-	}
-
-	/**
-	 * Check if the original document of the IIndexDocument is older than $time.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param int $time
-	 *
-	 * @return bool
-	 */
-	final public function isOlderThan(int $time): bool {
-		return ($this->modifiedTime < $time);
-	}
-
-
-	/**
-	 * Set the read rights of the original document using a IDocumentAccess.
-	 *
-	 * @see IDocumentAccess
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IDocumentAccess $access
-	 *
-	 * @return $this
-	 */
-	final public function setAccess(IDocumentAccess $access): IIndexDocument {
-		$this->access = $access;
-
-		return $this;
-	}
-
-	/**
-	 * Get the IDocumentAccess related to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IDocumentAccess
-	 */
-	final public function getAccess(): IDocumentAccess {
-		return $this->access;
-	}
-
-
-	/**
-	 * Add a tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addTag(string $tag): IIndexDocument {
-		$this->tags[] = $tag;
-
-		return $this;
-	}
-
-	/**
-	 * Set the list of tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setTags(array $tags): IIndexDocument {
-		$this->tags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getTags(): array {
-		return $this->tags;
-	}
-
-
-	/**
-	 * Add a meta tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addMetaTag(string $tag): IIndexDocument {
-		$this->metaTags[] = $tag;
-
-		return $this;
-	}
-
-	/**
-	 * Set the list of meta tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setMetaTags(array $tags): IIndexDocument {
-		$this->metaTags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of meta tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getMetaTags(): array {
-		return $this->metaTags;
-	}
-
-
-	/**
-	 * Add a sub tag to the list.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $sub
-	 * @param string $tag
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addSubTag(string $sub, string $tag): IIndexDocument {
-		if (!array_key_exists($sub, $this->subTags)) {
-			$this->subTags[$sub] = [];
-		}
-
-		$this->subTags[$sub][] = $tag;
-
-		return $this;
-	}
-
-
-	/**
-	 * Set the list of sub tags assigned to the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $tags
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setSubTags(array $tags): IIndexDocument {
-		$this->subTags = $tags;
-
-		return $this;
-	}
-
-	/**
-	 * Get the list of sub tags assigned to the original document.
-	 * If $formatted is true, the result will be formatted in a one
-	 * dimensional array.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param bool $formatted
-	 *
-	 * @return array
-	 */
-	final public function getSubTags(bool $formatted = false): array {
-		if ($formatted === false) {
-			return $this->subTags;
-		}
-
-		$subTags = [];
-		$ak = array_keys($this->subTags);
-		foreach ($ak as $source) {
-			$tags = $this->subTags[$source];
-			foreach ($tags as $tag) {
-				$subTags[] = $source . '_' . $tag;
-			}
-		}
-
-		return $subTags;
-	}
-
-
-	/**
-	 * Set the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $source
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setSource(string $source): IIndexDocument {
-		$this->source = $source;
-
-		return $this;
-	}
-
-	/**
-	 * Get the source of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getSource(): string {
-		return $this->source;
-	}
-
-
-	/**
-	 * Set the title of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $title
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setTitle(string $title): IIndexDocument {
-		$this->title = $title;
-
-		return $this;
-	}
-
-	/**
-	 * Get the title of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getTitle(): string {
-		return $this->title;
-	}
-
-
-	/**
-	 * Set the content of the document.
-	 * $encoded can be NOT_ENCODED or ENCODED_BASE64 if the content is raw or
-	 * encoded in base64.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $content
-	 * @param int $encoded
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setContent(string $content, int $encoded = 0): IIndexDocument {
-		$this->content = $content;
-		$this->contentEncoded = $encoded;
-
-		return $this;
-	}
-
-	/**
-	 * Get the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getContent(): string {
-		return $this->content;
-	}
-
-	/**
-	 * Returns the type of the encoding on the content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function isContentEncoded(): int {
-		return $this->contentEncoded;
-	}
-
-	/**
-	 * Return the size of the content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return int
-	 */
-	final public function getContentSize(): int {
-		return strlen($this->getContent());
-	}
-
-
-	/**
-	 * Generate an hash, based on the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function initHash(): IIndexDocument {
-		if ($this->getContent() === '' || is_null($this->getContent())) {
-			return $this;
-		}
-
-		$this->hash = hash("md5", $this->getContent());
-
-		return $this;
-	}
-
-	/**
-	 * Set the hash of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $hash
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setHash(string $hash): IIndexDocument {
-		$this->hash = $hash;
-
-		return $this;
-	}
-
-	/**
-	 * Get the hash of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getHash(): string {
-		return $this->hash;
-	}
-
-
-	/**
-	 * Add a part, identified by a string, and its content.
-	 *
-	 * It is strongly advised to use alphanumerical chars with no space in the
-	 * $part string.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $part
-	 * @param string $content
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addPart(string $part, string $content): IIndexDocument {
-		$this->parts[$part] = $content;
-
-		return $this;
-	}
-
-	/**
-	 * Set all parts and their content.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $parts
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setParts(array $parts): IIndexDocument {
-		$this->parts = $parts;
-
-		return $this;
-	}
-
-	/**
-	 * Get all parts of the IIndexDocument.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getParts(): array {
-		return $this->parts;
-	}
-
-
-	/**
-	 * Add a link, usable by the frontend.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $link
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setLink(string $link): IIndexDocument {
-		$this->link = $link;
-
-		return $this;
-	}
-
-	/**
-	 * Get the link.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getLink(): string {
-		return $this->link;
-	}
-
-
-	/**
-	 * Set more information that couldn't be set using other method.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param array $more
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setMore(array $more): IIndexDocument {
-		$this->more = $more;
-
-		return $this;
-	}
-
-	/**
-	 * Get more information.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getMore(): array {
-		return $this->more;
-	}
-
-
-	/**
-	 * Add some excerpt of the content of the original document, usually based
-	 * on the search request.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $source
-	 * @param string $excerpt
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function addExcerpt(string $source, string $excerpt): IIndexDocument {
-		$this->excerpts[] =
-			[
-				'source' => $source,
-				'excerpt' => $this->cleanExcerpt($excerpt)
-			];
-
-		return $this;
-	}
-
-
-	/**
-	 * Set all excerpts of the content of the original document.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param array $excerpts
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setExcerpts(array $excerpts): IIndexDocument {
-		$new = [];
-		foreach ($excerpts as $entry) {
-			$new[] = [
-				'source' => $entry['source'],
-				'excerpt' => $this->cleanExcerpt($entry['excerpt'])
-			];
-		}
-
-		$this->excerpts = $new;
-
-		return $this;
-	}
-
-	/**
-	 * Get all excerpts of the content of the original document.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getExcerpts(): array {
-		return $this->excerpts;
-	}
-
-	/**
-	 * Clean excerpt.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $excerpt
-	 * @return string
-	 */
-	private function cleanExcerpt(string $excerpt): string {
-		$excerpt = str_replace("\\n", ' ', $excerpt);
-		$excerpt = str_replace("\\r", ' ', $excerpt);
-		$excerpt = str_replace("\\t", ' ', $excerpt);
-		$excerpt = str_replace("\n", ' ', $excerpt);
-		$excerpt = str_replace("\r", ' ', $excerpt);
-		$excerpt = str_replace("\t", ' ', $excerpt);
-
-		return $excerpt;
-	}
-
-
-	/**
-	 * Set the score to the result assigned to this document during a search
-	 * request.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $score
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setScore(string $score): IIndexDocument {
-		$this->score = $score;
-
-		return $this;
-	}
-
-	/**
-	 * Get the score.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return string
-	 */
-	final public function getScore(): string {
-		return $this->score;
-	}
-
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as string)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfo(string $info, string $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (string)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param string $default
-	 *
-	 * @return string
-	 */
-	final public function getInfo(string $info, string $default = ''): string {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as array)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param array $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoArray(string $info, array $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (array)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param array $default
-	 *
-	 * @return array
-	 */
-	final public function getInfoArray(string $info, array $default = []): array {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as int)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param int $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoInt(string $info, int $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (int)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param int $default
-	 *
-	 * @return int
-	 */
-	final public function getInfoInt(string $info, int $default = 0): int {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Set some information about the original document that will be available
-	 * to the front-end when displaying search result. (as bool)
-	 * Because this information will not be indexed, this method can also be
-	 * used to manage some data while filling the IIndexDocument before its
-	 * indexing.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param bool $value
-	 *
-	 * @return IIndexDocument
-	 */
-	final public function setInfoBool(string $info, bool $value): IIndexDocument {
-		$this->info[$info] = $value;
-
-		return $this;
-	}
-
-	/**
-	 * Get an information about a document. (bool)
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param string $info
-	 * @param bool $default
-	 *
-	 * @return bool
-	 */
-	final public function getInfoBool(string $info, bool $default = false): bool {
-		if (!key_exists($info, $this->info)) {
-			return $default;
-		}
-
-		return $this->info[$info];
-	}
-
-	/**
-	 * Get all info.
-	 *
-	 * @since 15.0.0
-	 *
-	 * @return array
-	 */
-	final public function getInfoAll(): array {
-		$info = [];
-		foreach ($this->info as $k => $v) {
-			if (substr($k, 0, 1) === '_') {
-				continue;
-			}
-
-			$info[$k] = $v;
-		}
-
-		return $info;
-	}
-
-
-	/**
-	 * @since 15.0.0
-	 *
-	 * On some version of PHP, it is better to force destruct the object.
-	 * And during the index, the number of generated IIndexDocument can be
-	 * _huge_.
-	 */
-	public function __destruct() {
-		unset($this->id);
-		unset($this->providerId);
-		unset($this->access);
-		unset($this->modifiedTime);
-		unset($this->title);
-		unset($this->content);
-		unset($this->hash);
-		unset($this->link);
-		unset($this->source);
-		unset($this->tags);
-		unset($this->metaTags);
-		unset($this->subTags);
-		unset($this->more);
-		unset($this->excerpts);
-		unset($this->score);
-		unset($this->info);
-		unset($this->contentEncoded);
-	}
-
-	/**
-	 * @since 15.0.0
-	 */
-	public function jsonSerialize(): array {
-		return [
-			'id' => $this->getId(),
-			'providerId' => $this->getProviderId(),
-			'access' => $this->access,
-			'modifiedTime' => $this->getModifiedTime(),
-			'title' => $this->getTitle(),
-			'link' => $this->getLink(),
-			'index' => $this->index,
-			'source' => $this->getSource(),
-			'info' => $this->getInfoAll(),
-			'hash' => $this->getHash(),
-			'contentSize' => $this->getContentSize(),
-			'tags' => $this->getTags(),
-			'metatags' => $this->getMetaTags(),
-			'subtags' => $this->getSubTags(),
-			'more' => $this->getMore(),
-			'excerpts' => $this->getExcerpts(),
-			'score' => $this->getScore()
-		];
-	}
+    /** @var DocumentAccess */
+    protected $access;
+
+    /** @var IIndex */
+    protected $index;
+
+    /** @var int */
+    protected $modifiedTime = 0;
+
+    /** @var string */
+    protected $source = '';
+
+    /** @var array */
+    protected $tags = [];
+
+    /** @var array */
+    protected $metaTags = [];
+
+    /** @var array */
+    protected $subTags = [];
+
+    /** @var string */
+    protected $title = '';
+
+    /** @var string */
+    protected $content = '';
+
+    /** @var string */
+    protected $hash = '';
+
+    /** @var array */
+    protected $parts = [];
+
+    /** @var string */
+    protected $link = '';
+
+    /** @var array */
+    protected $more = [];
+
+    /** @var array */
+    protected $excerpts = [];
+
+    /** @var string */
+    protected $score = '';
+
+    /** @var array */
+    protected $info = [];
+
+    /** @var int */
+    protected $contentEncoded = 0;
+
+
+    /**
+     * IIndexDocument constructor.
+     *
+     * On creation, we assure the uniqueness of the object using the providerId
+     * and the Id of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $providerId
+     * @param string $documentId
+     */
+    public function __construct(string $providerId, string $documentId) {
+        $this->providerId = $providerId;
+        $this->id = $documentId;
+    }
+
+
+    /**
+     * Returns the Id of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getId(): string {
+        return $this->id;
+    }
+
+
+    /**
+     * Returns the Id of the provider.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getProviderId(): string {
+        return $this->providerId;
+    }
+
+
+    /**
+     * Set the Index related to the IIndexDocument.
+     *
+     * @see IIndex
+     *
+     * @since 15.0.0
+     *
+     * @param IIndex $index
+     *
+     * @return IIndexDocument
+     */
+    final public function setIndex(IIndex $index): IIndexDocument {
+        $this->index = $index;
+
+        return $this;
+    }
+
+    /**
+     * Get the Index.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndex
+     */
+    final public function getIndex(): IIndex {
+        return $this->index;
+    }
+
+    /**
+     * return if Index is defined.
+     *
+     * @since 16.0.0
+     *
+     * @return bool
+     */
+    final public function hasIndex(): bool {
+        return ($this->index !== null);
+    }
+
+
+    /**
+     * Set the modified time of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param int $modifiedTime
+     *
+     * @return IIndexDocument
+     */
+    final public function setModifiedTime(int $modifiedTime): IIndexDocument {
+        $this->modifiedTime = $modifiedTime;
+
+        return $this;
+    }
+
+    /**
+     * Get the modified time of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function getModifiedTime(): int {
+        return $this->modifiedTime;
+    }
+
+    /**
+     * Check if the original document of the IIndexDocument is older than $time.
+     *
+     * @since 15.0.0
+     *
+     * @param int $time
+     *
+     * @return bool
+     */
+    final public function isOlderThan(int $time): bool {
+        return ($this->modifiedTime < $time);
+    }
+
+
+    /**
+     * Set the read rights of the original document using a IDocumentAccess.
+     *
+     * @see IDocumentAccess
+     *
+     * @since 15.0.0
+     *
+     * @param IDocumentAccess $access
+     *
+     * @return $this
+     */
+    final public function setAccess(IDocumentAccess $access): IIndexDocument {
+        $this->access = $access;
+
+        return $this;
+    }
+
+    /**
+     * Get the IDocumentAccess related to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return IDocumentAccess
+     */
+    final public function getAccess(): IDocumentAccess {
+        return $this->access;
+    }
+
+
+    /**
+     * Add a tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addTag(string $tag): IIndexDocument {
+        $this->tags[] = $tag;
+
+        return $this;
+    }
+
+    /**
+     * Set the list of tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setTags(array $tags): IIndexDocument {
+        $this->tags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getTags(): array {
+        return $this->tags;
+    }
+
+
+    /**
+     * Add a meta tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addMetaTag(string $tag): IIndexDocument {
+        $this->metaTags[] = $tag;
+
+        return $this;
+    }
+
+    /**
+     * Set the list of meta tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setMetaTags(array $tags): IIndexDocument {
+        $this->metaTags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of meta tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getMetaTags(): array {
+        return $this->metaTags;
+    }
+
+
+    /**
+     * Add a sub tag to the list.
+     *
+     * @since 15.0.0
+     *
+     * @param string $sub
+     * @param string $tag
+     *
+     * @return IIndexDocument
+     */
+    final public function addSubTag(string $sub, string $tag): IIndexDocument {
+        if (!array_key_exists($sub, $this->subTags)) {
+            $this->subTags[$sub] = [];
+        }
+
+        $this->subTags[$sub][] = $tag;
+
+        return $this;
+    }
+
+
+    /**
+     * Set the list of sub tags assigned to the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param array $tags
+     *
+     * @return IIndexDocument
+     */
+    final public function setSubTags(array $tags): IIndexDocument {
+        $this->subTags = $tags;
+
+        return $this;
+    }
+
+    /**
+     * Get the list of sub tags assigned to the original document.
+     * If $formatted is true, the result will be formatted in a one
+     * dimensional array.
+     *
+     * @since 15.0.0
+     *
+     * @param bool $formatted
+     *
+     * @return array
+     */
+    final public function getSubTags(bool $formatted = false): array {
+        if ($formatted === false) {
+            return $this->subTags;
+        }
+
+        $subTags = [];
+        $ak = array_keys($this->subTags);
+        foreach ($ak as $source) {
+            $tags = $this->subTags[$source];
+            foreach ($tags as $tag) {
+                $subTags[] = $source . '_' . $tag;
+            }
+        }
+
+        return $subTags;
+    }
+
+
+    /**
+     * Set the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $source
+     *
+     * @return IIndexDocument
+     */
+    final public function setSource(string $source): IIndexDocument {
+        $this->source = $source;
+
+        return $this;
+    }
+
+    /**
+     * Get the source of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getSource(): string {
+        return $this->source;
+    }
+
+
+    /**
+     * Set the title of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $title
+     *
+     * @return IIndexDocument
+     */
+    final public function setTitle(string $title): IIndexDocument {
+        $this->title = $title;
+
+        return $this;
+    }
+
+    /**
+     * Get the title of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getTitle(): string {
+        return $this->title;
+    }
+
+
+    /**
+     * Set the content of the document.
+     * $encoded can be NOT_ENCODED or ENCODED_BASE64 if the content is raw or
+     * encoded in base64.
+     *
+     * @since 15.0.0
+     *
+     * @param string $content
+     * @param int $encoded
+     *
+     * @return IIndexDocument
+     */
+    final public function setContent(string $content, int $encoded = 0): IIndexDocument {
+        $this->content = $content;
+        $this->contentEncoded = $encoded;
+
+        return $this;
+    }
+
+    /**
+     * Get the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getContent(): string {
+        return $this->content;
+    }
+
+    /**
+     * Returns the type of the encoding on the content.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function isContentEncoded(): int {
+        return $this->contentEncoded;
+    }
+
+    /**
+     * Return the size of the content.
+     *
+     * @since 15.0.0
+     *
+     * @return int
+     */
+    final public function getContentSize(): int {
+        return strlen($this->getContent());
+    }
+
+
+    /**
+     * Generate an hash, based on the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return IIndexDocument
+     */
+    final public function initHash(): IIndexDocument {
+        if ($this->getContent() === '' || is_null($this->getContent())) {
+            return $this;
+        }
+
+        $this->hash = hash("md5", $this->getContent());
+
+        return $this;
+    }
+
+    /**
+     * Set the hash of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @param string $hash
+     *
+     * @return IIndexDocument
+     */
+    final public function setHash(string $hash): IIndexDocument {
+        $this->hash = $hash;
+
+        return $this;
+    }
+
+    /**
+     * Get the hash of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getHash(): string {
+        return $this->hash;
+    }
+
+
+    /**
+     * Add a part, identified by a string, and its content.
+     *
+     * It is strongly advised to use alphanumerical chars with no space in the
+     * $part string.
+     *
+     * @since 15.0.0
+     *
+     * @param string $part
+     * @param string $content
+     *
+     * @return IIndexDocument
+     */
+    final public function addPart(string $part, string $content): IIndexDocument {
+        $this->parts[$part] = $content;
+
+        return $this;
+    }
+
+    /**
+     * Set all parts and their content.
+     *
+     * @since 15.0.0
+     *
+     * @param array $parts
+     *
+     * @return IIndexDocument
+     */
+    final public function setParts(array $parts): IIndexDocument {
+        $this->parts = $parts;
+
+        return $this;
+    }
+
+    /**
+     * Get all parts of the IIndexDocument.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getParts(): array {
+        return $this->parts;
+    }
+
+
+    /**
+     * Add a link, usable by the frontend.
+     *
+     * @since 15.0.0
+     *
+     * @param string $link
+     *
+     * @return IIndexDocument
+     */
+    final public function setLink(string $link): IIndexDocument {
+        $this->link = $link;
+
+        return $this;
+    }
+
+    /**
+     * Get the link.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getLink(): string {
+        return $this->link;
+    }
+
+
+    /**
+     * Set more information that couldn't be set using other method.
+     *
+     * @since 15.0.0
+     *
+     * @param array $more
+     *
+     * @return IIndexDocument
+     */
+    final public function setMore(array $more): IIndexDocument {
+        $this->more = $more;
+
+        return $this;
+    }
+
+    /**
+     * Get more information.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getMore(): array {
+        return $this->more;
+    }
+
+
+    /**
+     * Add some excerpt of the content of the original document, usually based
+     * on the search request.
+     *
+     * @since 16.0.0
+     *
+     * @param string $source
+     * @param string $excerpt
+     *
+     * @return IIndexDocument
+     */
+    final public function addExcerpt(string $source, string $excerpt): IIndexDocument {
+        $this->excerpts[] =
+            [
+                'source' => $source,
+                'excerpt' => $this->cleanExcerpt($excerpt)
+            ];
+
+        return $this;
+    }
+
+
+    /**
+     * Set all excerpts of the content of the original document.
+     *
+     * @since 16.0.0
+     *
+     * @param array $excerpts
+     *
+     * @return IIndexDocument
+     */
+    final public function setExcerpts(array $excerpts): IIndexDocument {
+        $new = [];
+        foreach ($excerpts as $entry) {
+            $new[] = [
+                'source' => $entry['source'],
+                'excerpt' => $this->cleanExcerpt($entry['excerpt'])
+            ];
+        }
+
+        $this->excerpts = $new;
+
+        return $this;
+    }
+
+    /**
+     * Get all excerpts of the content of the original document.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getExcerpts(): array {
+        return $this->excerpts;
+    }
+
+    /**
+     * Clean excerpt.
+     *
+     * @since 16.0.0
+     *
+     * @param string $excerpt
+     * @return string
+     */
+    private function cleanExcerpt(string $excerpt): string {
+        $excerpt = str_replace("\\n", ' ', $excerpt);
+        $excerpt = str_replace("\\r", ' ', $excerpt);
+        $excerpt = str_replace("\\t", ' ', $excerpt);
+        $excerpt = str_replace("\n", ' ', $excerpt);
+        $excerpt = str_replace("\r", ' ', $excerpt);
+        $excerpt = str_replace("\t", ' ', $excerpt);
+
+        return $excerpt;
+    }
+
+
+    /**
+     * Set the score to the result assigned to this document during a search
+     * request.
+     *
+     * @since 15.0.0
+     *
+     * @param string $score
+     *
+     * @return IIndexDocument
+     */
+    final public function setScore(string $score): IIndexDocument {
+        $this->score = $score;
+
+        return $this;
+    }
+
+    /**
+     * Get the score.
+     *
+     * @since 15.0.0
+     *
+     * @return string
+     */
+    final public function getScore(): string {
+        return $this->score;
+    }
+
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as string)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfo(string $info, string $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (string)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param string $default
+     *
+     * @return string
+     */
+    final public function getInfo(string $info, string $default = ''): string {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as array)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param array $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoArray(string $info, array $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (array)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param array $default
+     *
+     * @return array
+     */
+    final public function getInfoArray(string $info, array $default = []): array {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as int)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param int $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoInt(string $info, int $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (int)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param int $default
+     *
+     * @return int
+     */
+    final public function getInfoInt(string $info, int $default = 0): int {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Set some information about the original document that will be available
+     * to the front-end when displaying search result. (as bool)
+     * Because this information will not be indexed, this method can also be
+     * used to manage some data while filling the IIndexDocument before its
+     * indexing.
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param bool $value
+     *
+     * @return IIndexDocument
+     */
+    final public function setInfoBool(string $info, bool $value): IIndexDocument {
+        $this->info[$info] = $value;
+
+        return $this;
+    }
+
+    /**
+     * Get an information about a document. (bool)
+     *
+     * @since 15.0.0
+     *
+     * @param string $info
+     * @param bool $default
+     *
+     * @return bool
+     */
+    final public function getInfoBool(string $info, bool $default = false): bool {
+        if (!key_exists($info, $this->info)) {
+            return $default;
+        }
+
+        return $this->info[$info];
+    }
+
+    /**
+     * Get all info.
+     *
+     * @since 15.0.0
+     *
+     * @return array
+     */
+    final public function getInfoAll(): array {
+        $info = [];
+        foreach ($this->info as $k => $v) {
+            if (substr($k, 0, 1) === '_') {
+                continue;
+            }
+
+            $info[$k] = $v;
+        }
+
+        return $info;
+    }
+
+
+    /**
+     * @since 15.0.0
+     *
+     * On some version of PHP, it is better to force destruct the object.
+     * And during the index, the number of generated IIndexDocument can be
+     * _huge_.
+     */
+    public function __destruct() {
+        unset($this->id);
+        unset($this->providerId);
+        unset($this->access);
+        unset($this->modifiedTime);
+        unset($this->title);
+        unset($this->content);
+        unset($this->hash);
+        unset($this->link);
+        unset($this->source);
+        unset($this->tags);
+        unset($this->metaTags);
+        unset($this->subTags);
+        unset($this->more);
+        unset($this->excerpts);
+        unset($this->score);
+        unset($this->info);
+        unset($this->contentEncoded);
+    }
+
+    /**
+     * @since 15.0.0
+     */
+    public function jsonSerialize(): array {
+        return [
+            'id' => $this->getId(),
+            'providerId' => $this->getProviderId(),
+            'access' => $this->access,
+            'modifiedTime' => $this->getModifiedTime(),
+            'title' => $this->getTitle(),
+            'link' => $this->getLink(),
+            'index' => $this->index,
+            'source' => $this->getSource(),
+            'info' => $this->getInfoAll(),
+            'hash' => $this->getHash(),
+            'contentSize' => $this->getContentSize(),
+            'tags' => $this->getTags(),
+            'metatags' => $this->getMetaTags(),
+            'subtags' => $this->getSubTags(),
+            'more' => $this->getMore(),
+            'excerpts' => $this->getExcerpts(),
+            'score' => $this->getScore()
+        ];
+    }
 }

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()
+        ];
+    }
 }