Documentation

Facet extends Message
in package

Generated from protobuf message <code>couchbase.search.v1.Facet</code>

Table of Contents

$facet  : mixed
__construct()  : mixed
Constructor.
getDateRangeFacet()  : DateRangeFacet|null
Generated from protobuf field <code>.couchbase.search.v1.DateRangeFacet date_range_facet = 1;</code>
getFacet()  : string
getNumericRangeFacet()  : NumericRangeFacet|null
Generated from protobuf field <code>.couchbase.search.v1.NumericRangeFacet numeric_range_facet = 2;</code>
getTermFacet()  : TermFacet|null
Generated from protobuf field <code>.couchbase.search.v1.TermFacet term_facet = 3;</code>
hasDateRangeFacet()  : mixed
hasNumericRangeFacet()  : mixed
hasTermFacet()  : mixed
setDateRangeFacet()  : $this
Generated from protobuf field <code>.couchbase.search.v1.DateRangeFacet date_range_facet = 1;</code>
setNumericRangeFacet()  : $this
Generated from protobuf field <code>.couchbase.search.v1.NumericRangeFacet numeric_range_facet = 2;</code>
setTermFacet()  : $this
Generated from protobuf field <code>.couchbase.search.v1.TermFacet term_facet = 3;</code>

Properties

$facet

protected mixed $facet

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type \Couchbase\Protostellar\Generated\Search\V1\DateRangeFacet $date_range_facet
@type \Couchbase\Protostellar\Generated\Search\V1\NumericRangeFacet $numeric_range_facet
@type \Couchbase\Protostellar\Generated\Search\V1\TermFacet $term_facet

}

Return values
mixed

getDateRangeFacet()

Generated from protobuf field <code>.couchbase.search.v1.DateRangeFacet date_range_facet = 1;</code>

public getDateRangeFacet() : DateRangeFacet|null
Return values
DateRangeFacet|null

getFacet()

public getFacet() : string
Return values
string

getNumericRangeFacet()

Generated from protobuf field <code>.couchbase.search.v1.NumericRangeFacet numeric_range_facet = 2;</code>

public getNumericRangeFacet() : NumericRangeFacet|null
Return values
NumericRangeFacet|null

getTermFacet()

Generated from protobuf field <code>.couchbase.search.v1.TermFacet term_facet = 3;</code>

public getTermFacet() : TermFacet|null
Return values
TermFacet|null

hasDateRangeFacet()

public hasDateRangeFacet() : mixed
Return values
mixed

hasNumericRangeFacet()

public hasNumericRangeFacet() : mixed
Return values
mixed

hasTermFacet()

public hasTermFacet() : mixed
Return values
mixed

setDateRangeFacet()

Generated from protobuf field <code>.couchbase.search.v1.DateRangeFacet date_range_facet = 1;</code>

public setDateRangeFacet(DateRangeFacet $var) : $this
Parameters
$var : DateRangeFacet
Return values
$this

setNumericRangeFacet()

Generated from protobuf field <code>.couchbase.search.v1.NumericRangeFacet numeric_range_facet = 2;</code>

public setNumericRangeFacet(NumericRangeFacet $var) : $this
Parameters
$var : NumericRangeFacet
Return values
$this

setTermFacet()

Generated from protobuf field <code>.couchbase.search.v1.TermFacet term_facet = 3;</code>

public setTermFacet(TermFacet $var) : $this
Parameters
$var : TermFacet
Return values
$this

        

Search results