Cloud Firestore V1 Client - Class Cursor (1.35.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class Cursor.

A position in a query result set.

Generated from protobuf message google.firestore.v1.Cursor

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ values array<Google\Cloud\Firestore\V1\Value>

The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.

↳ before bool

If the position is just before or just after the given values, relative to the sort order defined by the query.

getValues

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setValues

The values that represent a position, in the order they appear in the order by clause of a query.

Can contain fewer values than specified in the order by clause.

Parameter
NameDescription
var array<Google\Cloud\Firestore\V1\Value>
Returns
TypeDescription
$this

getBefore

If the position is just before or just after the given values, relative to the sort order defined by the query.

Returns
TypeDescription
bool

setBefore

If the position is just before or just after the given values, relative to the sort order defined by the query.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this