Merge pull request #4553 from owncloud/update_search_classes

Update search classes

4 files changed, 177 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();
+
+}
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index 22176c36b8a..8bf97828581 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -204,4 +204,12 @@ interface IServerContainer {
 	 * @return \OCP\Route\IRouter
 	 */
 	function getRouter();
+
+	/**
+	 * Returns a search instance
+	 *
+	 * @return \OCP\ISearch
+	 */
+	function getSearch();
+
 }
diff --git a/lib/public/search/provider.php b/lib/public/search/provider.php
new file mode 100644
index 00000000000..0506f091dd9
--- /dev/null
+++ b/lib/public/search/provider.php
@@ -0,0 +1,47 @@
+<?php
+/**
+ * ownCloud
+ *
+ * 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\Search;
+
+/**
+ * Provides a template for search functionality throughout ownCloud; 
+ */
+abstract class Provider {
+
+	/**
+	 * List of options (currently unused)
+	 * @var array
+	 */
+	private $options;
+
+	/**
+	 * Constructor
+	 * @param array $options
+	 */
+	public function __construct($options) {
+		$this->options = $options;
+	}
+
+	/**
+	 * Search for $query
+	 * @param string $query
+	 * @return array An array of OCP\Search\Result's
+	 */
+	abstract public function search($query);
+}
diff --git a/lib/public/search/result.php b/lib/public/search/result.php
new file mode 100644
index 00000000000..c70f1bde880
--- /dev/null
+++ b/lib/public/search/result.php
@@ -0,0 +1,65 @@
+<?php
+/**
+ * ownCloud
+ *
+ * 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\Search;
+
+/**
+ * The generic result of a search
+ */
+class Result {
+
+	/**
+	 * A unique identifier for the result, usually given as the item ID in its
+	 * corresponding application.
+	 * @var string
+	 */
+	public $id;
+
+	/**
+	 * The name of the item returned; this will be displayed in the search
+	 * results.
+	 * @var string
+	 */
+	public $name;
+
+	/**
+	 * URL to the application item.
+	 * @var string
+	 */
+	public $link;
+
+	/**
+	 * The type of search result returned; for consistency, name this the same
+	 * as the class name (e.g. \OC\Search\File -> 'file') in lowercase. 
+	 * @var string
+	 */
+	public $type = 'generic';
+
+	/**
+	 * Create a new search result
+	 * @param string $id unique identifier from application: '[app_name]/[item_identifier_in_app]'
+	 * @param string $name displayed text of result
+	 * @param string $link URL to the result within its app
+	 */
+	public function __construct($id = null, $name = null, $link = null) {
+		$this->id = $id;
+		$this->name = $name;
+		$this->link = $link;
+	}
+}