nextcloud/lib/public/search/pagedprovider.php

59 lines
1.5 KiB
PHP
Raw Normal View History

2014-12-11 14:58:22 +03:00
<?php
/**
* ownCloud
2014-12-11 14:58:22 +03:00
*
* 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.
2014-12-11 14:58:22 +03:00
*
* This library 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
* 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
*
* 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/>.
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;
*/
abstract class PagedProvider extends Provider {
2014-12-31 02:11:58 +03:00
/**
* show all results
*/
const SIZE_ALL = 0;
2014-12-11 14:58:22 +03:00
/**
* 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) {
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
2014-12-31 02:11:58 +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
*/
abstract public function searchPaged($query, $page, $size);
2014-12-11 14:58:22 +03:00
}