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