interface SearchDocumentInterface

Interface SearchDocumentInterface

Methods

array
get_document_count_by_search(string $searchterm, null $instance_id = NULL, int $post_type = -1, array $limit = [], array $advanced_options = [], array $facetted_search = [])

Gets the maximum available hits count for this search-term

get_documents_by_search($searchterm, string $instance_id = NULL, int $post_type = -1, array $limit = [], array $advanced_options = [], array $facetted_search = [], Term $term = NULL)

Search for "Documents"

array
get_facetted_search_info()

Returns facet search data based on the last search query.

get_min_length()

Returns the min length of a single search word

string[]
get_searchterm_suggest(string $q)

Function will return suggestions based on input usually spell corrected or similar queries (Did you mean ...)

Details

Gets the maximum available hits count for this search-term

Parameters

string $searchterm
null $instance_id
int $post_type
array $limit

[limit] or [offset,limit]

array $advanced_options
array $facetted_search

Return Value

array

Search for "Documents"

Parameters

$searchterm
string $instance_id
int $post_type
array $limit

[limit] or [offset,limit]

array $advanced_options
array $facetted_search
Term $term

at line 18
array get_facetted_search_info()

Returns facet search data based on the last search query.

Return Value

array

at line 64
get_min_length()

Returns the min length of a single search word

at line 28
string[] get_searchterm_suggest(string $q)

Function will return suggestions based on input usually spell corrected or similar queries (Did you mean ...)

Parameters

string $q

The search query

Return Value

string[]

Array of suggestions