SilverStripe Search

SearchResultGetTrait

Trait SearchResultGetTrait

Getters for search results to keep the class clean.

Table of Contents

Properties

$collatedSpellcheck  : string
$facets  : ArrayData
$highlight  : Highlighting
$spellcheck  : ArrayList
$totalItems  : int

Methods

getCollatedSpellcheck()  : string
Get the collated spellcheck
getFacets()  : ArrayData
Retrieve the facets from the results
getHighlight()  : Highlighting|null
Get the highlighting
getSpellcheck()  : ArrayList
Get the spellchecked results
getTotalItems()  : int
Total items in the result

Properties

Methods

getCollatedSpellcheck()

Get the collated spellcheck

public getCollatedSpellcheck() : string
Return values
string

getFacets()

Retrieve the facets from the results

public getFacets() : ArrayData
Return values
ArrayData

getHighlight()

Get the highlighting

public getHighlight() : Highlighting|null
Return values
Highlighting|null

getSpellcheck()

Get the spellchecked results

public getSpellcheck() : ArrayList
Return values
ArrayList

getTotalItems()

Total items in the result

public getTotalItems() : int
Return values
int

        
On this page

Search results