Copied!

SearchHit

SearchHit.php : 18
Extends ValueObject

This class represents a SearchHit matching the query.

Properties

public $highlight

SearchHit.php : 45

A representation of the search hit including highlighted terms.

public string|null $highlight = null

public $index

SearchHit.php : 35

The index identifier where this value was found.

public string|null $index = null

public $matchedTranslation

SearchHit.php : 40

Language code of the Content translation that matched the query.

public string|null $matchedTranslation

public $score

SearchHit.php : 30

The score of this value;.

public float|null $score = null

public $valueObject

SearchHit.php : 25

The value found by the search.

public mixed $valueObject

Methods

public__construct()

ValueObject.php : 32

Construct object optionally with a set of properties.

public __construct([array<string, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they aren't writable anymore after object has been created.

Parameters

Name Type Default value Description
$properties array<string, mixed> [] -

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

Override to add dynamic properties.

Parameters

Name Type Default value Description
$dynamicProperties array<int, string> []

Additional dynamic properties exposed on the object

Return values

array<int, string>

Attributes
#[Ignore]