\FACTFinder\DataSuggestQuery

Represents an item in suggestions.

Summary

Methods

Properties

Constants

__construct()
getLabel()
getUrl()
setUrl()
isSelected()
getHitCount()
getType()
getImageUrl()
getAttributes()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$label
$url
$selected
$hitCount
$type
$imageUrl
$attributes

N/A

File: Data\SuggestQuery.php
Package: Default
Class hierarchy: \FACTFinder\Data\Item

\FACTFinder\Data\SuggestQuery

Properties

$label

$label : string

Type

string

$url

$url : string

Type

string

$selected

$selected : boolean

Type

boolean

$hitCount

$hitCount :

Type

$type

$type :

Type

$imageUrl

$imageUrl :

Type

$attributes

$attributes :

Type

Methods

__construct()

__construct(string  $query, string  $url, integer  $hitCount, string  $type = '', string  $imageUrl = '', array  $attributes = array())

Parameters

string	$query	The query's name - will be used as the item's label.
string	$url
integer	$hitCount	Indicates how many products this suggestions will lead to.
string	$type	Simple string which describes where this suggest query comes from (e.g. product name, category, log file).
string	$imageUrl
array	$attributes	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

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