GeoDistanceSorting
extends Message
in package
Generated from protobuf message <code>couchbase.search.v1.GeoDistanceSorting</code>
Table of Contents
- $center : mixed
- Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
- $descending : mixed
- Generated from protobuf field <code>bool descending = 2;</code>
- $field : mixed
- Generated from protobuf field <code>string field = 1;</code>
- $unit : mixed
- Generated from protobuf field <code>string unit = 4;</code>
- __construct() : mixed
- Constructor.
- clearCenter() : mixed
- getCenter() : LatLng|null
- Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
- getDescending() : bool
- Generated from protobuf field <code>bool descending = 2;</code>
- getField() : string
- Generated from protobuf field <code>string field = 1;</code>
- getUnit() : string
- Generated from protobuf field <code>string unit = 4;</code>
- hasCenter() : mixed
- setCenter() : $this
- Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
- setDescending() : $this
- Generated from protobuf field <code>bool descending = 2;</code>
- setField() : $this
- Generated from protobuf field <code>string field = 1;</code>
- setUnit() : $this
- Generated from protobuf field <code>string unit = 4;</code>
Properties
$center
Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
protected
mixed
$center
= null
$descending
Generated from protobuf field <code>bool descending = 2;</code>
protected
mixed
$descending
= false
$field
Generated from protobuf field <code>string field = 1;</code>
protected
mixed
$field
= ''
$unit
Generated from protobuf field <code>string unit = 4;</code>
protected
mixed
$unit
= ''
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 string $field @type bool $descending @type \Couchbase\Protostellar\Generated\Search\V1\LatLng $center @type string $unit
}
Return values
mixed —clearCenter()
public
clearCenter() : mixed
Return values
mixed —getCenter()
Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
public
getCenter() : LatLng|null
Return values
LatLng|null —getDescending()
Generated from protobuf field <code>bool descending = 2;</code>
public
getDescending() : bool
Return values
bool —getField()
Generated from protobuf field <code>string field = 1;</code>
public
getField() : string
Return values
string —getUnit()
Generated from protobuf field <code>string unit = 4;</code>
public
getUnit() : string
Return values
string —hasCenter()
public
hasCenter() : mixed
Return values
mixed —setCenter()
Generated from protobuf field <code>.couchbase.search.v1.LatLng center = 3;</code>
public
setCenter(LatLng $var) : $this
Parameters
- $var : LatLng
Return values
$this —setDescending()
Generated from protobuf field <code>bool descending = 2;</code>
public
setDescending(bool $var) : $this
Parameters
- $var : bool
Return values
$this —setField()
Generated from protobuf field <code>string field = 1;</code>
public
setField(string $var) : $this
Parameters
- $var : string
Return values
$this —setUnit()
Generated from protobuf field <code>string unit = 4;</code>
public
setUnit(string $var) : $this
Parameters
- $var : string