add paged provider

2 files changed, 68 insertions, 0 deletions

diff --git a/lib/public/isearch.php b/lib/public/isearch.php
index 229376ed3ae..84e450afe6f 100644
--- a/lib/public/isearch.php
+++ b/lib/public/isearch.php
@@ -34,10 +34,20 @@ interface ISearch {
 	 * @param string $query
 	 * @param string[] $inApps optionally limit results to the given apps
 	 * @return array An array of OCP\Search\Result's
+	 * @deprecated use searchPaged() with page and size
 	 */
 	public function search($query, array $inApps = array());
 
 	/**
+	 * Search all providers for $query
+	 * @param string $query
+	 * @param int $page
+	 * @param int $size
+	 * @return array An array of OCP\Search\Result's
+	 */
+	public function searchPaged($query, $page = 0, $size = 30);
+
+	/**
 	 * Register a new search provider to search with
 	 * @param string $class class name of a OCP\Search\Provider
 	 * @param array $options optional
diff --git a/lib/public/search/pagedprovider.php b/lib/public/search/pagedprovider.php
new file mode 100644
index 00000000000..97da1dd2c85
--- /dev/null
+++ b/lib/public/search/pagedprovider.php
@@ -0,0 +1,58 @@
+<?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 PagedProvider extends 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
+	 */
+	public function search($query) {
+		$this->searchPaged($query, 0, 0);
+	}
+
+	/**
+	 * Search for $query
+	 * @param string $query
+	 * @param int $limit, 0 = unlimited
+	 * @param int $offset
+	 * @return array An array of OCP\Search\Result's
+	 */
+	abstract public function searchPaged($query, $limit, $offset);
+}