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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\StructuredQuery\CompositeFilter|null | |
hasCompositeFilter
setCompositeFilter
A composite filter.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\StructuredQuery\CompositeFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFieldFilter
A filter on a document field.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\StructuredQuery\FieldFilter|null | |
hasFieldFilter
setFieldFilter
A filter on a document field.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\StructuredQuery\FieldFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUnaryFilter
A filter that takes exactly one argument.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\StructuredQuery\UnaryFilter|null | |
hasUnaryFilter
setUnaryFilter
A filter that takes exactly one argument.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\StructuredQuery\UnaryFilter
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilterType
| Returns | |
|---|---|
| Type | Description |
string | |