SearchHit

SearchHit.php : 16 Copy path

Extends ValueObject

This class represents a SearchHit matching the query.

Properties¶

SearchHit.php : 53 Copy path

A representation of the search hit including highlighted terms.

public string $highlight

SearchHit.php : 37 Copy path

The index identifier where this value was found.

public string $index

SearchHit.php : 46 Copy path

Language code of the Content translation that matched the query.

public string $matchedTranslation

SearchHit.php : 30 Copy path

The score of this value;.

public float $score

SearchHit.php : 23 Copy path

The value found by the search.

public ValueObject $valueObject

ValueObject.php : 30 Copy path

Construct object optionally with a set of properties.

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

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

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

ValueObject.php : 50 Copy path

Function where list of properties are returned.

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

Used by attributes(), override to add dynamic properties

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

array<string|int, mixed>