Skip to content

Commit

Permalink
Extend the doc block to explain the possibility to return null to uns…
Browse files Browse the repository at this point in the history
…et filter

Basically an extension due to the discussion in Smile-SA#1158. Since one does not
need to return a \Smile\ElasticsuiteCore\Search\Request\QueryInterface the
doc block comment should indicate that.
  • Loading branch information
shochdoerfer committed Oct 26, 2018
1 parent 5cea1d4 commit c4200e1
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}

0 comments on commit c4200e1

Please sign in to comment.