nextcloud/lib/public/Search/PagedProvider.php

68 lines
1.7 KiB
PHP
Raw Normal View History

2014-12-11 14:58:22 +03:00
<?php
/**
* @author Joas Schilling <nickvergessen@owncloud.com>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Morris Jobke <hey@morrisjobke.de>
2014-12-11 14:58:22 +03:00
*
2016-01-12 17:02:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
2014-12-11 14:58:22 +03:00
*
2015-03-26 13:44:34 +03:00
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
2014-12-11 14:58:22 +03:00
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
2014-12-11 14:58:22 +03:00
*
2015-03-26 13:44:34 +03:00
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2014-12-11 14:58:22 +03:00
*
*/
2014-12-11 14:58:22 +03:00
namespace OCP\Search;
/**
* Provides a template for search functionality throughout ownCloud;
* @since 8.0.0
2014-12-11 14:58:22 +03:00
*/
abstract class PagedProvider extends Provider {
2014-12-31 02:11:58 +03:00
/**
* show all results
* @since 8.0.0
2014-12-31 02:11:58 +03:00
*/
const SIZE_ALL = 0;
2014-12-11 14:58:22 +03:00
/**
* Constructor
* @param array $options
* @since 8.0.0
2014-12-11 14:58:22 +03:00
*/
public function __construct($options) {
$this->options = $options;
}
/**
* Search for $query
* @param string $query
* @return array An array of OCP\Search\Result's
* @since 8.0.0
2014-12-11 14:58:22 +03:00
*/
public function search($query) {
2014-12-31 02:11:58 +03:00
// old apps might assume they get all results, so we use SIZE_ALL
$this->searchPaged($query, 1, self::SIZE_ALL);
2014-12-11 14:58:22 +03:00
}
/**
* Search for $query
* @param string $query
* @param int $page pages start at page 1
2016-02-18 12:50:00 +03:00
* @param int $size 0 = SIZE_ALL
2014-12-11 14:58:22 +03:00
* @return array An array of OCP\Search\Result's
* @since 8.0.0
2014-12-11 14:58:22 +03:00
*/
abstract public function searchPaged($query, $page, $size);
2014-12-11 14:58:22 +03:00
}