Cloud Firestore Client - Class FieldPath (1.53.0)

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']); 

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

Example:

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

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

Example:

 $string = $path->pathString(); 

Get the path elements.

Cast the path to a string.

Create a field path indicating the document ID.

Example:

 use Google\Cloud\Firestore\FieldPath;

$path = FieldPath::documentId(); 

Create a FieldPath from a string path.

Example:

 use Google\Cloud\Firestore\FieldPath;

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