nextcloud/lib/public/search/provider.php

48 lines
1.2 KiB
PHP
Raw Normal View History

2011-07-29 23:03:53 +04:00
<?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/>.
*
2011-07-29 23:03:53 +04:00
*/
2012-08-29 10:38:33 +04:00
namespace OCP\Search;
2012-08-29 10:38:33 +04:00
/**
* Provides a template for search functionality throughout ownCloud;
*/
abstract class Provider {
2013-08-26 16:12:06 +04:00
/**
* List of options (currently unused)
* @var array
*/
private $options;
2013-08-26 16:12:06 +04:00
/**
* Constructor
* @param array $options
*/
public function __construct($options) {
$this->options = $options;
}
2013-08-26 16:12:06 +04:00
/**
* Search for $query
* @param string $query
* @return array An array of OCP\Search\Result's
2013-08-26 16:12:06 +04:00
*/
abstract public function search($query);
}