mirror of
https://github.com/YunoHost-Apps/z-push_ynh.git
synced 2024-09-03 18:05:58 +02:00
125 lines
No EOL
4 KiB
PHP
125 lines
No EOL
4 KiB
PHP
<?php
|
|
/***********************************************
|
|
* File : searchprovider.php
|
|
* Project : Z-Push
|
|
* Descr : The searchprovider can be used to
|
|
* implement an alternative way perform
|
|
* searches.
|
|
* This is a stub implementation.
|
|
*
|
|
* Created : 03.08.2010
|
|
*
|
|
* Copyright 2007 - 2013 Zarafa Deutschland GmbH
|
|
*
|
|
* This program 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 with the following additional
|
|
* term according to sec. 7:
|
|
*
|
|
* According to sec. 7 of the GNU Affero General Public License, version 3,
|
|
* the terms of the AGPL are supplemented with the following terms:
|
|
*
|
|
* "Zarafa" is a registered trademark of Zarafa B.V.
|
|
* "Z-Push" is a registered trademark of Zarafa Deutschland GmbH
|
|
* The licensing of the Program under the AGPL does not imply a trademark license.
|
|
* Therefore any rights, title and interest in our trademarks remain entirely with us.
|
|
*
|
|
* However, if you propagate an unmodified version of the Program you are
|
|
* allowed to use the term "Z-Push" to indicate that you distribute the Program.
|
|
* Furthermore you may use our trademarks where it is necessary to indicate
|
|
* the intended purpose of a product or service provided you use it in accordance
|
|
* with honest practices in industrial or commercial matters.
|
|
* If you want to propagate modified versions of the Program under the name "Z-Push",
|
|
* you may only do so if you have a written permission by Zarafa Deutschland GmbH
|
|
* (to acquire a permission please contact Zarafa at trademark@zarafa.com).
|
|
*
|
|
* 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
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Consult LICENSE file for details
|
|
************************************************/
|
|
|
|
/*********************************************************************
|
|
* The SearchProvider is a stub to implement own search funtionality
|
|
*
|
|
* If you wish to implement an alternative search method, you should implement the
|
|
* ISearchProvider interface like the BackendSearchLDAP backend
|
|
*/
|
|
class SearchProvider implements ISearchProvider{
|
|
|
|
/**
|
|
* Constructor
|
|
* initializes the searchprovider to perform the search
|
|
*
|
|
* @access public
|
|
* @return
|
|
* @throws StatusException, FatalException
|
|
*/
|
|
public function SearchProvider() {
|
|
}
|
|
|
|
/**
|
|
* Indicates if a search type is supported by this SearchProvider
|
|
* Currently only the type ISearchProvider::SEARCH_GAL (Global Address List) is implemented
|
|
*
|
|
* @param string $searchtype
|
|
*
|
|
* @access public
|
|
* @return boolean
|
|
*/
|
|
public function SupportsType($searchtype) {
|
|
return ($searchtype == ISearchProvider::SEARCH_GAL);
|
|
}
|
|
|
|
/**
|
|
* Searches the GAL
|
|
*
|
|
* @param string $searchquery string to be searched for
|
|
* @param string $searchrange specified searchrange
|
|
*
|
|
* @access public
|
|
* @return array search results
|
|
* @throws StatusException
|
|
*/
|
|
public function GetGALSearchResults($searchquery, $searchrange) {
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Searches for the emails on the server
|
|
*
|
|
* @param ContentParameter $cpo
|
|
*
|
|
* @return array
|
|
*/
|
|
public function GetMailboxSearchResults($cpo){
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Terminates a search for a given PID
|
|
*
|
|
* @param int $pid
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function TerminateSearch($pid) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Disconnects from the current search provider
|
|
*
|
|
* @access public
|
|
* @return boolean
|
|
*/
|
|
public function Disconnect() {
|
|
return true;
|
|
}
|
|
}
|
|
?>
|