# Cloud Firestore V1 Client - Class PBFunction (2.2.0-RC1)

2.2.0-RC1 2.1.0 (latest) 2.0.2-RC1 1.55.0 1.54.4 1.53.1 1.52.0 1.51.0 1.50.0 1.48.1 1.47.3 1.46.0 1.45.2 1.44.1 1.43.3 1.40.0 1.39.0 1.38.0 1.37.7 1.36.1 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.28.0 1.27.3 Reference documentation and code samples for the Cloud Firestore V1 Client class PBFunction.

Represents an unevaluated scalar expression.

For example, the expression `like(user_name, "%alice%")` is represented as:

    name: "like"
    args { field_reference: "user_name" }
    args { string_value: "%alice%" }

Generated from protobuf message `google.firestore.v1.Function`

## Namespace

Google \\ Cloud \\ Firestore \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Required. The name of the function to evaluate. **Requires:** \* \* must be in snake case (lower case with underscore separator). |
| `↳ args` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Value>` Optional. Ordered list of arguments the given function expects. |
| `↳ options` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` Optional. Optional named arguments that certain functions may support. |

### getName

Required. The name of the function to evaluate.

**Requires:**

- must be in snake case (lower case with underscore separator).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Required. The name of the function to evaluate.

**Requires:**

- must be in snake case (lower case with underscore separator).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getArgs

Optional. Ordered list of arguments the given function expects.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/RepeatedField` |   |

### setArgs

Optional. Ordered list of arguments the given function expects.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-firestore/latest/V1.Value>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getOptions

Optional. Optional named arguments that certain functions may support.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setOptions

Optional. Optional named arguments that certain functions may support.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |