\ElasticaResult

__construct()

__construct(array  $hit) 

Constructs a single results object.

Parameters

getParam()

getParam(string  $name) : mixed

Returns a param from the result hit array.

This function can be used to retrieve all data for which a specific function doesn't exist. If the param does not exist, an empty array is returned

Parameters

Returns

Result data

hasParam()

hasParam(string  $name) : boolean

Test if a param from the result hit is set.

Parameters

Returns

True if the param is set, false otherwise

getId()

getId() : string

Returns the hit id.

Returns

Hit id

getType()

getType() : string

Returns the type of the result.

Returns

Result type

getFields()

getFields() : array

Returns list of fields.

Returns

Fields list

hasFields()

hasFields() : boolean

Returns whether result has fields.

Returns

getIndex()

getIndex() : string

Returns the index name of the result.

Returns

Index name

getScore()

getScore() : float

Returns the score of the result.

Returns

Result score

getHit()

getHit() : array

Returns the raw hit array.

Returns

Hit array

getVersion()

getVersion() : string|integer

Returns the version information from the hit.

Returns

Document version

getInnerHits()

getInnerHits() : array

Returns inner hits.

Returns

Fields list

hasInnerHits()

hasInnerHits() : boolean

Returns whether result has inner hits.

Returns

getData()

getData() : array

Returns result data.

Checks for partial result data with getFields, falls back to getSource or both

Returns

Result data array

getSource()

getSource() : array

Returns the result source.

Returns

Source data array

getHighlights()

getHighlights() : array

Returns result data.

Returns

Result data array

getExplanation()

getExplanation() : array

Returns explanation on how its score was computed.

Returns

explanations

getDocument()

getDocument() : \Elastica\Document

Returns Document.

Returns

setParam()

setParam(string  $param, mixed  $value) 

Sets a parameter on the hit.

Parameters

__get()

__get(string  $key) : mixed

Magic function to directly access keys inside the result.

Returns null if key does not exist

Parameters

Returns

Key value

__isset()

__isset(string  $key) : boolean

Magic function to support isset() calls.

Parameters

Returns