diff options
author | Jörn Friedrich Dreyer <jfd@butonic.de> | 2014-06-06 01:17:02 +0200 |
---|---|---|
committer | Jörn Friedrich Dreyer <jfd@butonic.de> | 2014-06-06 01:17:02 +0200 |
commit | aaf0d131718dc9079a5b3717276455f8701feeea (patch) | |
tree | ca915a5012b5d107d8d201d25a365a312e71a095 /lib/public/isearch.php | |
parent | 5034bd1b129b75e7b571cb0ed239d02010c806f7 (diff) | |
download | nextcloud-server-aaf0d131718dc9079a5b3717276455f8701feeea.tar.gz nextcloud-server-aaf0d131718dc9079a5b3717276455f8701feeea.zip |
make search non-static, add ISearch to server container, make legacy a static wrapper for it, move provider and result to public api
Diffstat (limited to 'lib/public/isearch.php')
-rw-r--r-- | lib/public/isearch.php | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/lib/public/isearch.php b/lib/public/isearch.php new file mode 100644 index 00000000000..3b83dbf35e8 --- /dev/null +++ b/lib/public/isearch.php @@ -0,0 +1,57 @@ +<?php + +/** + * 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/>. + * + */ + +namespace OCP; + + +/** + * Small Interface for Search + */ +interface ISearch { + + /** + * Search all providers for $query + * @param string $query + * @return array An array of OCP\Search\Result's + */ + public function search($query); + + /** + * Register a new search provider to search with + * @param string $class class name of a OCP\Search\Provider + * @param array $options optional + */ + public function registerProvider($class, $options = array()); + + /** + * Remove one existing search provider + * @param string $provider class name of a OCP\Search\Provider + */ + public function removeProvider($provider); + + /** + * Remove all registered search providers + */ + public function clearProviders(); + +} |