Cloud Firestore V1 Client - Class Filter (1.53.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

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ composite_filter
CompositeFilter

A composite filter.

↳ field_filter
FieldFilter

A filter on a document field.

↳ unary_filter
UnaryFilter

A filter that takes exactly one argument.

getCompositeFilter

A composite filter.

Returns
Type
Description

hasCompositeFilter

setCompositeFilter

A composite filter.

Parameter
Name
Description
Returns
Type
Description
$this

getFieldFilter

A filter on a document field.

Returns
Type
Description
FieldFilter |null

hasFieldFilter

setFieldFilter

A filter on a document field.

Parameter
Name
Description
Returns
Type
Description
$this

getUnaryFilter

A filter that takes exactly one argument.

Returns
Type
Description
UnaryFilter |null

hasUnaryFilter

setUnaryFilter

A filter that takes exactly one argument.

Parameter
Name
Description
Returns
Type
Description
$this

getFilterType

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: