API Documentation
\
FACTFinder
Adapter
Core
Client
Server
Data
Util

\FACTFinder\DataSingleWordSearchItem

Represents a suggestion for single-word search.

Summary

Methods
Properties
Constants
__construct()
getHitCount()
getType()
getImageUrl()
getAttributes()
getLabel()
getUrl()
setUrl()
isSelected()
addPreviewRecord()
addPreviewRecords()
getPreviewRecords()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$hitCount
$type
$imageUrl
$attributes
$label
$url
$selected
$previewRecords
N/A

Properties

$hitCount

$hitCount :

Type

$type

$type :

Type

$imageUrl

$imageUrl :

Type

$attributes

$attributes :

Type

$label

$label : string

Type

string

$url

$url : string

Type

string

$selected

$selected : boolean

Type

boolean

Methods

__construct()

__construct(string  $label, string  $url, boolean  $isSelected = false)

Parameters

string $label
string $url
boolean $isSelected

getHitCount()

getHitCount() : integer

Returns

integer —

Indicates how many products this suggestions will lead to.

getType()

getType() : string

Returns

string —

Indicates where this suggest query comes from (e.g. product name, category, log file).

getImageUrl()

getImageUrl() : string

Returns

string

getAttributes()

getAttributes() : array

Returns

array —

Returns the additional return data fields

getLabel()

getLabel() : string

Returns

string

getUrl()

getUrl() : string

Returns

string

setUrl()

setUrl(  $url) : string

Parameters

$url

Returns

string

isSelected()

isSelected() : boolean

Returns

boolean

addPreviewRecords()

addPreviewRecords(array  $records)

Parameters

array $records

getPreviewRecords()

getPreviewRecords() : array<mixed,\FACTFinder\Data\Record>

Returns

array<mixed,\FACTFinder\Data\Record>