FieldSorting
extends Message
in package
Generated from protobuf message <code>couchbase.search.v1.FieldSorting</code>
Table of Contents
- $descending : mixed
- Generated from protobuf field <code>bool descending = 2;</code>
- $field : mixed
- Generated from protobuf field <code>string field = 1;</code>
- $missing : mixed
- Generated from protobuf field <code>string missing = 3;</code>
- $mode : mixed
- Generated from protobuf field <code>string mode = 4;</code>
- $type : mixed
- Generated from protobuf field <code>string type = 5;</code>
- __construct() : mixed
- Constructor.
- getDescending() : bool
- Generated from protobuf field <code>bool descending = 2;</code>
- getField() : string
- Generated from protobuf field <code>string field = 1;</code>
- getMissing() : string
- Generated from protobuf field <code>string missing = 3;</code>
- getMode() : string
- Generated from protobuf field <code>string mode = 4;</code>
- getType() : string
- Generated from protobuf field <code>string type = 5;</code>
- setDescending() : $this
- Generated from protobuf field <code>bool descending = 2;</code>
- setField() : $this
- Generated from protobuf field <code>string field = 1;</code>
- setMissing() : $this
- Generated from protobuf field <code>string missing = 3;</code>
- setMode() : $this
- Generated from protobuf field <code>string mode = 4;</code>
- setType() : $this
- Generated from protobuf field <code>string type = 5;</code>
Properties
$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
= ''
$missing
Generated from protobuf field <code>string missing = 3;</code>
protected
mixed
$missing
= ''
$mode
Generated from protobuf field <code>string mode = 4;</code>
protected
mixed
$mode
= ''
$type
Generated from protobuf field <code>string type = 5;</code>
protected
mixed
$type
= ''
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 string $missing @type string $mode @type string $type
}
Return values
mixed —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 —getMissing()
Generated from protobuf field <code>string missing = 3;</code>
public
getMissing() : string
Return values
string —getMode()
Generated from protobuf field <code>string mode = 4;</code>
public
getMode() : string
Return values
string —getType()
Generated from protobuf field <code>string type = 5;</code>
public
getType() : string
Return values
string —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 —setMissing()
Generated from protobuf field <code>string missing = 3;</code>
public
setMissing(string $var) : $this
Parameters
- $var : string
Return values
$this —setMode()
Generated from protobuf field <code>string mode = 4;</code>
public
setMode(string $var) : $this
Parameters
- $var : string
Return values
$this —setType()
Generated from protobuf field <code>string type = 5;</code>
public
setType(string $var) : $this
Parameters
- $var : string