SilverStripe\FullTextSearch\Search\Queries\SearchQuery
Represents a search query
API very much still in flux.
Synopsis
class SearchQuery
extends ViewableData
{
- // members
- public static $missing = NULL;
- public static $present = NULL;
- public static integer $default_page_size = 10;
- public array $search = ;
- public array $classes = ;
- public array $require = ;
- public array $exclude = ;
- public array $criteria = ;
- protected integer $start = 0;
- protected integer $limit = 1;
- protected SearchAdapterInterface $adapter = NULL;
- // methods
- public void __construct()
- public SearchQuery setHandler()
- public $this addSearchTerm()
- public $this addFuzzySearchTerm()
- public array getSearchTerms()
- public $this addClassFilter()
- public array getClassFilters()
- public $this addFilter()
- public array getFilters()
- public $this addExclude()
- public array getExcludes()
- public SearchCriteriaInterface filterBy()
- public void setStart()
- public int getStart()
- public void setLimit()
- public int getLimit()
- public void setPageSize()
- public int getPageSize()
- public bool isFiltered()
- public SearchAdapterInterface getAdapter()
- public void __toString()
- public void search()
- public void fuzzysearch()
- public void inClass()
- public void filter()
- public void exclude()
- public void start()
- public void limit()
- public void page()
- public array getCriteria()
- public SearchQuery setCriteria()
- public SearchQuery addCriteria()
Hierarchy
Extends
- SilverStripe\View\ViewableData
Members
protected
- $adapter — SilverStripe\FullTextSearch\Search\Adapters\SearchAdapterInterface
- $limit
- $start
public
- $classes
- $criteria — array
- $default_page_size
- $exclude
- $missing
- $present
- $require
-
$search
These are public, but only for index & variant access - API users should not manually access these
Methods
public
- __construct() — SearchQuery constructor.
- __toString()
- addClassFilter()
- addCriteria()
- addExclude() — Excludes results which match these criteria, inverse of {@link addFilter()}.
- addFilter() — Similar to {@link addSearchTerm()}, but typically used to further narrow down based on other facets which don't influence the field relevancy.
- addFuzzySearchTerm() — Similar to {@link addSearchTerm()}, but uses stemming and other similarity algorithms to find the searched terms. For example, a term "fishing" would also likely find results containing "fish" or "fisher". Depends on search implementation.
- addSearchTerm()
- exclude()
- filter()
- filterBy() — You can pass through a string value, Criteria object, or Criterion object for $target.
- fuzzysearch()
- getAdapter()
- getClassFilters()
- getCriteria()
- getExcludes()
- getFilters()
- getLimit()
- getPageSize()
- getSearchTerms()
- getStart()
- inClass()
- isFiltered()
- limit()
- page()
- search()
- setCriteria()
- setHandler()
- setLimit()
- setPageSize()
- setStart()
- start()