Documentation

Sorting extends Message
in package

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

Table of Contents

$sorting  : mixed
__construct()  : mixed
Constructor.
getFieldSorting()  : FieldSorting|null
Generated from protobuf field <code>.couchbase.search.v1.FieldSorting field_sorting = 1;</code>
getGeoDistanceSorting()  : GeoDistanceSorting|null
Generated from protobuf field <code>.couchbase.search.v1.GeoDistanceSorting geo_distance_sorting = 2;</code>
getIdSorting()  : IdSorting|null
Generated from protobuf field <code>.couchbase.search.v1.IdSorting id_sorting = 3;</code>
getScoreSorting()  : ScoreSorting|null
Generated from protobuf field <code>.couchbase.search.v1.ScoreSorting score_sorting = 4;</code>
getSorting()  : string
hasFieldSorting()  : mixed
hasGeoDistanceSorting()  : mixed
hasIdSorting()  : mixed
hasScoreSorting()  : mixed
setFieldSorting()  : $this
Generated from protobuf field <code>.couchbase.search.v1.FieldSorting field_sorting = 1;</code>
setGeoDistanceSorting()  : $this
Generated from protobuf field <code>.couchbase.search.v1.GeoDistanceSorting geo_distance_sorting = 2;</code>
setIdSorting()  : $this
Generated from protobuf field <code>.couchbase.search.v1.IdSorting id_sorting = 3;</code>
setScoreSorting()  : $this
Generated from protobuf field <code>.couchbase.search.v1.ScoreSorting score_sorting = 4;</code>

Properties

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\FieldSorting $field_sorting
@type \Couchbase\Protostellar\Generated\Search\V1\GeoDistanceSorting $geo_distance_sorting
@type \Couchbase\Protostellar\Generated\Search\V1\IdSorting $id_sorting
@type \Couchbase\Protostellar\Generated\Search\V1\ScoreSorting $score_sorting

}

Return values
mixed —

getFieldSorting()

Generated from protobuf field <code>.couchbase.search.v1.FieldSorting field_sorting = 1;</code>

public getFieldSorting() : FieldSorting|null
Return values
FieldSorting|null —

getGeoDistanceSorting()

Generated from protobuf field <code>.couchbase.search.v1.GeoDistanceSorting geo_distance_sorting = 2;</code>

public getGeoDistanceSorting() : GeoDistanceSorting|null
Return values
GeoDistanceSorting|null —

getIdSorting()

Generated from protobuf field <code>.couchbase.search.v1.IdSorting id_sorting = 3;</code>

public getIdSorting() : IdSorting|null
Return values
IdSorting|null —

getScoreSorting()

Generated from protobuf field <code>.couchbase.search.v1.ScoreSorting score_sorting = 4;</code>

public getScoreSorting() : ScoreSorting|null
Return values
ScoreSorting|null —

getSorting()

public getSorting() : string
Return values
string —

hasFieldSorting()

public hasFieldSorting() : mixed
Return values
mixed —

hasGeoDistanceSorting()

public hasGeoDistanceSorting() : mixed
Return values
mixed —

hasIdSorting()

public hasIdSorting() : mixed
Return values
mixed —

hasScoreSorting()

public hasScoreSorting() : mixed
Return values
mixed —

setFieldSorting()

Generated from protobuf field <code>.couchbase.search.v1.FieldSorting field_sorting = 1;</code>

public setFieldSorting(FieldSorting $var) : $this
Parameters
$var : FieldSorting
Return values
$this —

setGeoDistanceSorting()

Generated from protobuf field <code>.couchbase.search.v1.GeoDistanceSorting geo_distance_sorting = 2;</code>

public setGeoDistanceSorting(GeoDistanceSorting $var) : $this
Parameters
$var : GeoDistanceSorting
Return values
$this —

setIdSorting()

Generated from protobuf field <code>.couchbase.search.v1.IdSorting id_sorting = 3;</code>

public setIdSorting(IdSorting $var) : $this
Parameters
$var : IdSorting
Return values
$this —

setScoreSorting()

Generated from protobuf field <code>.couchbase.search.v1.ScoreSorting score_sorting = 4;</code>

public setScoreSorting(ScoreSorting $var) : $this
Parameters
$var : ScoreSorting
Return values
$this — 

        

        
    




    

    

                

    

        

            
Search results