Merge pull request Smile-SA#1161 from bitExpert/fix/enhance_filter

Extend the doc block to explain the possibility to return null to unset filter
rbayet · Oct 29, 2018 · ee30e36 · ee30e36
2 parents 5cea1d4 + c4200e1
commit ee30e36
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/module-elasticsuite-core/Api/Search/Request/Container/FilterInterface.php b/src/module-elasticsuite-core/Api/Search/Request/Container/FilterInterface.php
@@ -24,11 +24,11 @@
 interface FilterInterface
 {
     /**
-     * Get filter query according to current search context.
+     * Get filter query according to current search context. Return null to unset filter query.
      *
      * @param \Smile\ElasticsuiteCore\Api\Search\ContextInterface $searchContext Search Context
      *
-     * @return \Smile\ElasticsuiteCore\Search\Request\QueryInterface
+     * @return \Smile\ElasticsuiteCore\Search\Request\QueryInterface|null
      */
     public function getFilterQuery(\Smile\ElasticsuiteCore\Api\Search\ContextInterface $searchContext);
 }