nextcloud/lib/public/isearch.php

70 lines
1.9 KiB
PHP
Raw Normal View History

2011-07-29 23:03:53 +04:00
<?php
2011-07-29 23:03:53 +04:00
/**
* ownCloud - App Framework
*
* @author Jörn Dreyer
* @copyright 2014 Jörn Dreyer jfd@owncloud.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 library. If not, see <http://www.gnu.org/licenses/>.
*
2011-07-29 23:03:53 +04:00
*/
2012-08-29 10:38:33 +04:00
namespace OCP;
2012-08-29 10:38:33 +04:00
/**
* Small Interface for Search
*/
interface ISearch {
2013-08-26 16:12:06 +04:00
/**
* Search all providers for $query
* @param string $query
* @param string[] $inApps optionally limit results to the given apps
* @return array An array of OCP\Search\Result's
2014-12-11 14:58:22 +03:00
* @deprecated use searchPaged() with page and size
2013-08-26 16:12:06 +04:00
*/
public function search($query, array $inApps = array());
2014-12-11 14:58:22 +03:00
/**
* Search all providers for $query
* @param string $query
* @param string[] $inApps optionally limit results to the given apps
* @param int $page pages start at page 1
2014-12-11 14:58:22 +03:00
* @param int $size
* @return array An array of OCP\Search\Result's
*/
public function searchPaged($query, array $inApps = array(), $page = 1, $size = 30);
2014-12-11 14:58:22 +03:00
2013-08-26 16:12:06 +04:00
/**
* Register a new search provider to search with
* @param string $class class name of a OCP\Search\Provider
* @param array $options optional
2013-08-26 16:12:06 +04:00
*/
public function registerProvider($class, array $options = array());
2013-08-26 16:12:06 +04:00
/**
* Remove one existing search provider
* @param string $provider class name of a OCP\Search\Provider
2013-08-26 16:12:06 +04:00
*/
public function removeProvider($provider);
/**
* Remove all registered search providers
*/
public function clearProviders();
2013-08-26 16:12:06 +04:00
}