Cloud Firestore Client - Class Aggregate (1.32.0)

Version 1.32.0

• 1.47.2 (latest)
• 1.47.1
• 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 Client class Aggregate.

Represents Aggregate properties.

Example:

$count = Aggregate::count();
$count->alias('count');

echo json_encode($count->getProps());

Methods

count

Creates count aggregation properties.

Example:

$count = Aggregate::count();

Returns
Type	Description
Google\Cloud\Firestore\Aggregate

alias

Set the aggregate alias.

Example:

$count = Aggregate->count();
$count->alias('total');

echo $count->props()['alias'];

Parameter
Name	Description
alias	string The alias for aggregate.

Returns
Type	Description
Google\Cloud\Firestore\Aggregate

getProps

Get the array representation for the aggregate.

Returns
Type	Description
array