PrefixSearchQuery
in package
implements
JsonSerializable, SearchQuery
A FTS query that allows for simple matching on a given prefix.
Interfaces, Classes, Traits and Enums
- JsonSerializable
- SearchQuery
- Common interface for all classes, which could be used as a body of SearchQuery
Table of Contents
- $boost : float|null
- $field : string|null
- $prefix : string
- __construct() : mixed
- boost() : PrefixSearchQuery
- Sets the boost for this query.
- build() : PrefixSearchQuery
- Static helper to keep code more readable
- field() : PrefixSearchQuery
- Sets the field for this query.
Properties
$boost
private
float|null
$boost
$field
private
string|null
$field
$prefix
private
string
$prefix
Methods
__construct()
public
__construct(string $prefix) : mixed
Parameters
- $prefix : string
Return values
mixed —boost()
Sets the boost for this query.
public
boost(float $boost) : PrefixSearchQuery
Parameters
- $boost : float
-
the boost value to use.
Tags
Return values
PrefixSearchQuery —build()
Static helper to keep code more readable
public
static build(string $prefix) : PrefixSearchQuery
Parameters
- $prefix : string
Tags
Return values
PrefixSearchQuery —field()
Sets the field for this query.
public
field(string $field) : PrefixSearchQuery
Parameters
- $field : string
-
the field to use.