Cloud Firestore V1 Client - Class Filter (1.28.0)

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

A filter.

Generated from protobuf message google.firestore.v1.StructuredQuery.Filter

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ composite_filter Google\Cloud\Firestore\V1\StructuredQuery\CompositeFilter

A composite filter.

↳ field_filter Google\Cloud\Firestore\V1\StructuredQuery\FieldFilter

A filter on a document field.

↳ unary_filter Google\Cloud\Firestore\V1\StructuredQuery\UnaryFilter

A filter that takes exactly one argument.

getCompositeFilter

A composite filter.

Returns
TypeDescription
Google\Cloud\Firestore\V1\StructuredQuery\CompositeFilter|null

hasCompositeFilter

setCompositeFilter

A composite filter.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredQuery\CompositeFilter
Returns
TypeDescription
$this

getFieldFilter

A filter on a document field.

Returns
TypeDescription
Google\Cloud\Firestore\V1\StructuredQuery\FieldFilter|null

hasFieldFilter

setFieldFilter

A filter on a document field.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredQuery\FieldFilter
Returns
TypeDescription
$this

getUnaryFilter

A filter that takes exactly one argument.

Returns
TypeDescription
Google\Cloud\Firestore\V1\StructuredQuery\UnaryFilter|null

hasUnaryFilter

setUnaryFilter

A filter that takes exactly one argument.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredQuery\UnaryFilter
Returns
TypeDescription
$this

getFilterType

Returns
TypeDescription
string