JM tech review 1

Author: rustagir

source/aggregation.txt

@@ -90,9 +90,9 @@ The {+library-short+} provides the following APIs to create aggregation
 pipelines:
 
 - :ref:`php-aggregation-array-api`: Create aggregation pipelines by
-  passing arrays that specify the aggregation operators and parameters.
-- :ref:`php-aggregation-builder-api`: Create aggregation pipelines by using native
-  classes and methods to make your application more type-safe and debuggable.
+  passing arrays that specify the aggregation stages.
+- :ref:`php-aggregation-builder-api`: Create aggregation pipelines by
+  using factory methods to make your application more type-safe and debuggable.
 
 The following sections describe each API and provide examples for
 creating aggregation pipelines.
@@ -109,8 +109,8 @@ shown in the following code:
 .. code-block:: php
 
    $pipeline = [
-       ['<operator>' => <parameters>],
-       ['<operator>' => <parameters>],
+       ['<stage>' => <parameters>],
+       ['<stage>' => <parameters>],
        ...
    ];
 
@@ -198,7 +198,7 @@ perform the following actions:
 
 1. Create an array to store the pipeline stages.
 
-#. For each stage, call the an operator method from the
+#. For each stage, call the a factory method from the
    ``Stage`` that shares the same name as your desired aggregation
    stage. For example, to create an ``$unwind`` stage, call the
    ``Stage::unwind()`` method.
@@ -213,10 +213,10 @@ aggregation pipelines:
 .. code-block:: php
 
    $pipeline = [
-       Stage::<operator method>(
+       Stage::<factory method>(
            <stage specification>
        ),
-       Stage::<operator method>(
+       Stage::<factory method>(
            <stage specification>
        ),
        ...

source/includes/aggregation/aggregation.php

@@ -1,12 +1,5 @@
 <?php
 
-use MongoDB\BSON\UTCDateTime;
-use MongoDB\Builder\Accumulator;
-use MongoDB\Builder\Expression;
-use MongoDB\Builder\Query;
-use MongoDB\Builder\Stage;
-use MongoDB\Builder\Type\Sort;
-
 require 'vendor/autoload.php';
 
 $uri = getenv('MONGODB_URI') ?: throw new RuntimeException('Set the MONGODB_URI variable to your Atlas URI that connects to the sample dataset');
@@ -48,27 +41,27 @@
 
 // start-builder-match-group
 $pipeline = [
-    Stage::match(
+    MongoDB\Builder\Stage::match(
         date: [
-            Query::gte(new UTCDateTime(new DateTimeImmutable('2014-01-01'))),
-            Query::lt(new UTCDateTime(new DateTimeImmutable('2015-01-01'))),
+            MongoDB\Builder\Query::gte(new MongoDB\BSON\UTCDateTime(new DateTimeImmutable('2014-01-01'))),
+            MongoDB\Builder\Query::lt(new MongoDB\BSON\UTCDateTime(new DateTimeImmutable('2015-01-01'))),
         ],
     ),
-    Stage::group(
-        _id: Expression::dateToString(Expression::dateFieldPath('date'), '%Y-%m-%d'),
-        totalSaleAmount: Accumulator::sum(
-            Expression::multiply(
-                Expression::numberFieldPath('price'),
-                Expression::numberFieldPath('quantity'),
+    MongoDB\Builder\Stage::group(
+        _id: MongoDB\Builder\Expression::dateToString(MongoDB\Builder\Expression::dateFieldPath('date'), '%Y-%m-%d'),
+        totalSaleAmount: MongoDB\Builder\Accumulator::sum(
+            MongoDB\Builder\Expression::multiply(
+                MongoDB\Builder\Expression::numberFieldPath('price'),
+                MongoDB\Builder\Expression::numberFieldPath('quantity'),
             ),
         ),
-        averageQuantity: Accumulator::avg(
-            Expression::numberFieldPath('quantity'),
+        averageQuantity: MongoDB\Builder\Accumulator::avg(
+            MongoDB\Builder\Expression::numberFieldPath('quantity'),
         ),
-        count: Accumulator::sum(1),
+        count: MongoDB\Builder\Accumulator::sum(1),
     ),
-    Stage::sort(
-        totalSaleAmount: Sort::Desc,
+    MongoDB\Builder\Stage::sort(
+        totalSaleAmount: MongoDB\Builder\Type\Sort::Desc,
     ),
 ];
 
@@ -81,14 +74,14 @@
 
 // start-builder-unwind
 $pipeline = [
-    Stage::unwind(Expression::arrayFieldPath('items')),
-    Stage::unwind(Expression::arrayFieldPath('items.tags')),
-    Stage::group(
-        _id: Expression::fieldPath('items.tags'),
-        totalSalesAmount: Accumulator::sum(
-            Expression::multiply(
-                Expression::numberFieldPath('items.price'),
-                Expression::numberFieldPath('items.quantity'),
+    MongoDB\Builder\Stage::unwind(MongoDB\Builder\Expression::arrayFieldPath('items')),
+    MongoDB\Builder\Stage::unwind(MongoDB\Builder\Expression::arrayFieldPath('items.tags')),
+    MongoDB\Builder\Stage::group(
+        _id: MongoDB\Builder\Expression::fieldPath('items.tags'),
+        totalSalesAmount: MongoDB\Builder\Accumulator::sum(
+            MongoDB\Builder\Expression::multiply(
+                MongoDB\Builder\Expression::numberFieldPath('items.price'),
+                MongoDB\Builder\Expression::numberFieldPath('items.quantity'),
             ),
         ),
     ),
@@ -101,9 +94,11 @@
 }
 // end-builder-unwind
 
+$collection = $client->db->orders;
+
 // start-builder-lookup
 $pipeline = [
-    Stage::lookup(
+    MongoDB\Builder\Stage::lookup(
         from: 'inventory',
         localField: 'item',
         foreignField: 'sku',

source/whats-new.txt

@@ -39,7 +39,7 @@ The {+library-short+} v1.21 release includes the following features,
 improvements, and fixes:
 
 - Introduces the Aggregation Builder, an API to build aggregation
-  pipelines in a more type-safe and PHP-native way. To learn more and
+  pipelines in a more type-safe way. To learn more and
   view examples, see the :ref:`php-aggregation-builder-api` section of
   the Aggregation guide.