search_core/Classes/Connection/SuggestRequestInterface.php

49 lines
1.3 KiB
PHP

<?php
namespace Codappix\SearchCore\Connection;
/*
* Copyright (C) 2017 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.
*/
/**
* Used to request suggest from connection.
*/
interface SuggestRequestInterface
{
/**
* The identifier of the suggest, used as key in arrays and to get the
* suggest from search request, etc.
*
* @return string
*/
public function getIdentifier();
/**
* The field to use for suggest building.
*
* @return string
*/
public function getField();
/**
* Returns the number of results.
*
* @return int
*/
public function getSize();
}