search_core/Classes/Connection/ConnectionInterface.php

72 lines
2 KiB
PHP
Raw Normal View History

2016-12-09 13:19:35 +01:00
<?php
namespace Codappix\SearchCore\Connection;
2016-12-09 13:19:35 +01:00
/*
* Copyright (C) 2016 Daniel Siepmann <coding@daniel-siepmann.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301, USA.
*/
/**
* Defines interface for connections to storage backend for interacting with documents.
*/
interface ConnectionInterface
{
/**
* Will add a new document.
2016-12-09 13:19:35 +01:00
*
* @return void
2016-12-09 13:19:35 +01:00
*/
public function addDocument(string $documentType, array $document);
2016-12-09 13:19:35 +01:00
/**
* Add the given documents.
*
* @return void
2016-12-09 13:19:35 +01:00
*/
public function addDocuments(string $documentType, array $documents);
2016-12-09 13:19:35 +01:00
/**
* Will update an existing document.
2016-12-09 13:19:35 +01:00
*
* NOTE: Batch updating is not yet supported.
*
* @return void
2016-12-09 13:19:35 +01:00
*/
public function updateDocument(string $documentType, array $document);
2016-12-09 13:19:35 +01:00
/**
* Will remove an existing document.
2016-12-09 13:19:35 +01:00
*
* NOTE: Batch deleting is not yet supported.
*
* @return void
2016-12-09 13:19:35 +01:00
*/
public function deleteDocument(string $documentType, string $identifier);
2016-12-09 13:19:35 +01:00
/**
* Search by given request and return result.
*/
public function search(SearchRequestInterface $searchRequest) : SearchResultInterface;
/**
* Will delete the whole index / db.
*
* @return void
*/
public function deleteIndex(string $documentType);
2016-12-09 13:19:35 +01:00
}