179 lines
4.1 KiB
PHP
179 lines
4.1 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
|
|
/**
|
|
* FullTextSearch - Full text search framework for Nextcloud
|
|
*
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
* later. See the COPYING file.
|
|
*
|
|
* @author Maxence Lange <maxence@artificial-owl.com>
|
|
* @copyright 2018
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
|
|
namespace OCP\FullTextSearch\Model;
|
|
|
|
|
|
use OCP\FullTextSearch\IFullTextSearchProvider;
|
|
|
|
|
|
/**
|
|
* Class ISearchTemplate
|
|
*
|
|
* This is a data transfer object that should be created by Content Provider
|
|
* when the getSearchTemplate() method is called.
|
|
*
|
|
* The object will contain templates to be displayed, and the list of the different
|
|
* options to be available to the user when he start a new search.
|
|
*
|
|
* The display of the Options is generated by the FullTextSearch app and Options
|
|
* can be displayed in 2 places:
|
|
*
|
|
* - the navigation page of the app that generate the indexed content.
|
|
* (files, bookmarks, deck, mails, ...)
|
|
* - the navigation page of the FullTextSearch app.
|
|
*
|
|
* Both pages will have different Options, and only the first one can integrate
|
|
* a specific template.
|
|
*
|
|
* @see IFullTextSearchProvider::getSearchTemplate
|
|
*
|
|
* @since 15.0.0
|
|
*
|
|
* @package OCP\FullTextSearch\Model
|
|
*/
|
|
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 15.0.0
|
|
*
|
|
* @param string $class
|
|
*
|
|
* @return ISearchTemplate
|
|
*/
|
|
public function setIcon(string $class): ISearchTemplate;
|
|
|
|
/**
|
|
* Get the class of the icon.
|
|
*
|
|
* @since 15.0.0
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getIcon(): string;
|
|
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Get the path of the CSS file.
|
|
*
|
|
* @since 15.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 15.0.0
|
|
*
|
|
* @param string $template
|
|
*
|
|
* @return ISearchTemplate
|
|
*/
|
|
public function setTemplate(string $template): ISearchTemplate;
|
|
|
|
/**
|
|
* Get the path of the template file.
|
|
*
|
|
* @since 15.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 15.0.0
|
|
*
|
|
* @param ISearchOption $option
|
|
*
|
|
* @return ISearchTemplate
|
|
*/
|
|
public function addPanelOption(ISearchOption $option): ISearchTemplate;
|
|
|
|
/**
|
|
* Get all options to be displayed in the Panel.
|
|
*
|
|
* @since 15.0.0
|
|
*
|
|
* @return ISearchOption[]
|
|
*/
|
|
public function getPanelOptions(): array;
|
|
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Get all options to be displayed in the FullTextSearch navigation page.
|
|
*
|
|
* @since 15.0.0
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getNavigationOptions(): array;
|
|
|
|
}
|
|
|