summaryrefslogtreecommitdiffstats
path: root/lib/public/isearch.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/isearch.php')
-rw-r--r--lib/public/isearch.php57
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();
+
+}