server/lib/private/legacy/search.php
2015-03-26 11:44:36 +01:00

70 lines
1.9 KiB
PHP

<?php
/**
* @author Andrew Brown <andrew@casabrown.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Morris Jobke <hey@morrisjobke.de>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* 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,
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
/**
* provides an interface to all search providers
*
* @deprecated use \OCP\ISearch / \OC\Search instead
*/
class OC_Search {
/**
* @return \OCP\ISearch
*/
private static function getSearch() {
return \OC::$server->getSearch();
}
/**
* Search all providers for $query
* @param string $query
* @return array An array of OCP\Search\Result's
*/
public static function search($query) {
return self::getSearch()->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 static function registerProvider($class, $options = array()) {
return self::getSearch()->registerProvider($class, $options);
}
/**
* Remove one existing search provider
* @param string $provider class name of a OCP\Search\Provider
*/
public static function removeProvider($provider) {
return self::getSearch()->removeProvider($provider);
}
/**
* Remove all registered search providers
*/
public static function clearProviders() {
return self::getSearch()->clearProviders();
}
}