Maslosoft Manganel API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 <?php
/**
* This software package is licensed under `AGPL, Commercial` license[s].
*
* @package maslosoft/manganel
* @license AGPL, Commercial
*
* @copyright Copyright (c) Peter Maselkowski <pmaselkowski@gmail.com>
* @link https://maslosoft.com/manganel/
*/
namespace Maslosoft\Manganel\Interfaces\QueryBuilder;
use Maslosoft\Manganel\SearchCriteria;
/**
* QueryBuilderDecoratorInterface
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
interface ConditionDecoratorInterface
{
// NOTE: Do not rename this contants, as these are used directly by ES
const KindMust = 'must';
const KindFilter = 'filter';
const KindMustNot = 'must_not';
const KindShould = 'should';
public function decorate(&$conditions, SearchCriteria $criteria);
/**
* Get kind of query, should return one of interface constants:
*
* * KindMust
* * KindMustNot
* * KindFilter
* * KindShould
*
* Or false to skip condition.
*
* @return string|boolean
*/
public function getKind();
}
API documentation generated by ApiGen