2011-04-24 16:09:07 +02:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* ownCloud
|
|
|
|
*
|
|
|
|
* @author Frank Karlitschek
|
2012-05-26 19:14:24 +02:00
|
|
|
* @copyright 2012 Frank Karlitschek frank@owncloud.org
|
2011-04-24 16:09:07 +02: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.
|
|
|
|
*
|
|
|
|
* 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/>.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* provides an interface to all search providers
|
|
|
|
*/
|
2011-07-29 21:36:03 +02:00
|
|
|
class OC_Search{
|
2011-04-24 16:09:07 +02:00
|
|
|
static private $providers=array();
|
2012-04-14 11:29:44 +02:00
|
|
|
static private $registeredProviders=array();
|
2012-08-29 08:38:33 +02:00
|
|
|
|
2012-04-14 11:29:44 +02:00
|
|
|
/**
|
|
|
|
* remove all registered search providers
|
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
public static function clearProviders() {
|
2012-04-14 11:29:44 +02:00
|
|
|
self::$providers=array();
|
|
|
|
self::$registeredProviders=array();
|
|
|
|
}
|
2012-08-29 08:38:33 +02:00
|
|
|
|
2011-04-24 16:09:07 +02:00
|
|
|
/**
|
|
|
|
* register a new search provider to be used
|
2012-03-01 22:58:44 +01:00
|
|
|
* @param string $provider class name of a OC_Search_Provider
|
2011-04-24 16:09:07 +02:00
|
|
|
*/
|
2012-11-02 19:53:02 +01:00
|
|
|
public static function registerProvider($class, $options=array()) {
|
2012-11-04 11:10:46 +01:00
|
|
|
self::$registeredProviders[]=array('class'=>$class, 'options'=>$options);
|
2011-04-24 16:09:07 +02:00
|
|
|
}
|
2012-08-29 08:38:33 +02:00
|
|
|
|
2011-04-24 16:09:07 +02:00
|
|
|
/**
|
|
|
|
* search all provider for $query
|
|
|
|
* @param string query
|
2011-07-29 21:03:53 +02:00
|
|
|
* @return array An array of OC_Search_Result's
|
2011-04-24 16:09:07 +02:00
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
public static function search($query) {
|
2012-04-14 11:29:44 +02:00
|
|
|
self::initProviders();
|
2011-04-24 16:09:07 +02:00
|
|
|
$results=array();
|
2012-09-07 15:22:01 +02:00
|
|
|
foreach(self::$providers as $provider) {
|
2012-04-14 11:29:44 +02:00
|
|
|
$results=array_merge($results, $provider->search($query));
|
2011-04-24 16:09:07 +02:00
|
|
|
}
|
|
|
|
return $results;
|
|
|
|
}
|
2013-02-22 17:21:57 +01:00
|
|
|
|
2013-02-01 19:21:54 +01:00
|
|
|
/**
|
|
|
|
* remove an existing search provider
|
|
|
|
* @param string $provider class name of a OC_Search_Provider
|
|
|
|
*/
|
|
|
|
public static function removeProvider($provider) {
|
|
|
|
self::$registeredProviders = array_filter(
|
2013-02-22 17:21:57 +01:00
|
|
|
self::$registeredProviders,
|
2013-02-01 19:21:54 +01:00
|
|
|
function ($element) use ($provider) {
|
|
|
|
return ($element['class'] != $provider);
|
|
|
|
}
|
|
|
|
);
|
|
|
|
// force regeneration of providers on next search
|
|
|
|
self::$providers=array();
|
|
|
|
}
|
|
|
|
|
2012-08-29 08:38:33 +02:00
|
|
|
|
2012-04-14 11:29:44 +02:00
|
|
|
/**
|
|
|
|
* create instances of all the registered search providers
|
|
|
|
*/
|
2012-09-07 15:22:01 +02:00
|
|
|
private static function initProviders() {
|
|
|
|
if(count(self::$providers)>0) {
|
2012-04-14 11:29:44 +02:00
|
|
|
return;
|
|
|
|
}
|
2012-09-07 15:22:01 +02:00
|
|
|
foreach(self::$registeredProviders as $provider) {
|
2012-04-14 11:29:44 +02:00
|
|
|
$class=$provider['class'];
|
|
|
|
$options=$provider['options'];
|
|
|
|
self::$providers[]=new $class($options);
|
|
|
|
}
|
|
|
|
}
|
2011-04-24 16:09:07 +02:00
|
|
|
}
|