Cloud Firestore Client - Class FieldPath (1.36.1)

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

Represents a path to a Firestore Document field.

Example:

use Google\Cloud\Firestore\FirestoreClient;

$firestore = new FirestoreClient();
$path = $firestore->fieldPath(['accounts', 'usd']);

Namespace

Google \ Cloud \ Firestore

Parameter
Name	Description
`fieldNames`	`array` A list of field names.

Get a new FieldPath with the given path part appended to the current path.

Example:

$child = $path->child('element');

Parameter
Name	Description
`part`	`string` The child path part.

Returns
Type	Description
`Google\Cloud\Firestore\FieldPath`

Get the current path as a string, with special characters escaped.

Example:

$string = $path->pathString();

Returns
Type	Description
`string`

Get the path elements.

Returns
Type	Description
`array`

Cast the path to a string.

Returns
Type	Description
`string`

Create a field path indicating the document ID.

Example:

use Google\Cloud\Firestore\FieldPath;

$path = FieldPath::documentId();

Returns
Type	Description
`Google\Cloud\Firestore\FieldPath`

Create a FieldPath from a string path.

Example:

use Google\Cloud\Firestore\FieldPath;

$path = FieldPath::fromString('path.to.field');

Parameters
Name	Description
`path`	`string` The field path string.
`splitPath`	`bool` If false, the input path will not be split on `.`. Defaults to `true`.

Returns
Type	Description
`Google\Cloud\Firestore\FieldPath`

Value: '/^[^*~\\/[\\]]+$/'

Value: '/^[_a-zA-Z][_a-zA-Z0-9]*$/'