more phpcs errors

Author: norareidy

source/data-formats/modeling-bson-data.txt

@@ -57,7 +57,7 @@ these values into BSON documents when inserting them into a collection.
 The following example creates a BSON document that represents the preceding
 :ref:`sample BSON document <php-bson-sample>`:
 
-.. literalinclude:: /includes/bson.php
+.. literalinclude:: /includes/bson/interact-bson.php
     :language: php
     :dedent:
     :start-after: start-create-doc
@@ -73,7 +73,7 @@ to the :ref:`sample BSON document <php-bson-sample>`:
 - Adds a new ``restaurant_id`` field that has a value of ``12345``
 - Changes the ``name`` field value to ``"Galaxy Pizza"``
 
-.. literalinclude:: /includes/bson.php
+.. literalinclude:: /includes/bson/interact-bson.php
     :language: php
     :dedent:
     :start-after: start-modify-doc
@@ -142,7 +142,7 @@ Custom Type Map Example
 The following example sets the ``typeMap`` option for the ``restaurants`` collection
 that serializes arrays and BSON documents as ``MongoDB\Model\BSONDocument`` objects:
 
-.. literalinclude:: /includes/bson.php
+.. literalinclude:: /includes/bson/interact-bson.php
     :language: php
     :dedent:
     :start-after: start-type-map
@@ -170,7 +170,7 @@ Consider the following ``Person`` class definition, which implements the
 ``Persistable`` interface and specifies how to serialize and deserialize
 object fields as BSON values:
 
-.. literalinclude:: /includes/bson.php
+.. literalinclude:: /includes/bson/Person.php
     :language: php
     :dedent:
     :start-after: start-person-class
@@ -182,7 +182,7 @@ database, and reads it back as an object of the same type:
 .. io-code-block::
    :copyable:
 
-   .. input:: /includes/bson.php
+   .. input:: /includes/bson/interact-bson.php
       :start-after: start-person-serialize
       :end-before: end-person-serialize
       :language: php
@@ -245,24 +245,33 @@ and ``bsonUnserialize()`` methods in your class definition.
 Example
 ```````
 
-Consider the following ``User`` class definition, which specifies
-logic for serializing and deserializing its fields into BSON values.
-The class includes a ``role`` field, which has a backed enum value:
+Consider the following backed enum named ``Role``, which has two
+integer-valued cases:
 
-.. literalinclude:: /includes/bson.php
+.. literalinclude:: /includes/bson/Role.php
     :language: php
-    :emphasize-lines: 15, 24
     :dedent:
     :start-after: start-backed-enum
     :end-before: end-backed-enum
 
+This ``User`` class definition includes a ``role`` field with a ``Role`` enum
+value and specifies logic for serializing and deserializing its fields into BSON
+values:
+
+.. literalinclude:: /includes/bson/User.php
+    :language: php
+    :emphasize-lines: 5
+    :dedent:
+    :start-after: start-user-class
+    :end-before: end-user-class
+
 The following example constructs a ``User`` object with a ``role`` field,
 inserts it into the database, and reads it back as an object of the same type:
 
 .. io-code-block::
    :copyable:
 
-   .. input:: /includes/bson.php
+   .. input:: /includes/bson/interact-bson.php
       :start-after: start-enum-serialize
       :end-before: end-enum-serialize
       :language: php

source/includes/bson.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Bson;
+
+// start-person-class
+class Person implements MongoDB\BSON\Persistable
+{
+    private MongoDB\BSON\ObjectId $id;
+    private string $name;
+    private MongoDB\BSON\UTCDateTime $createdAt;
+
+    public function __construct(string $name)
+    {
+        $this->id = new MongoDB\BSON\ObjectId;
+        $this->name = $name;
+        $this->createdAt = new MongoDB\BSON\UTCDateTime;
+    }
+
+    function bsonSerialize()
+    {
+        return [
+            '_id' => $this->id,
+            'name' => $this->name,
+            'createdAt' => $this->createdAt,
+        ];
+    }
+
+    function bsonUnserialize(array $data)
+    {
+        $this->id = $data['_id'];
+        $this->name = $data['name'];
+        $this->createdAt = $data['createdAt'];
+    }
+}
+// end-person-class

source/includes/bson/Person.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Bson;
+
+// start-backed-enum
+enum Role: int
+{
+    case USER = 1;
+    case ADMIN = 2;
+}
+// end-backed-enum

source/includes/bson/Role.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Bson;
+
+// start-user-class
+class User implements MongoDB\BSON\Persistable
+{
+    public function __construct(
+        private string $username,
+        private Role $role,
+        private MongoDB\BSON\ObjectId $_id = new MongoDB\BSON\ObjectId(),
+    ) {}
+
+    public function bsonSerialize(): array
+    {
+        return [
+            '_id' => $this->_id,
+            'username' => $this->username,
+            'role' => $this->role,
+        ];
+    }
+
+    public function bsonUnserialize(array $data): void
+    {
+        $this->_id = $data['_id'];
+        $this->username = $data['username'];
+        $this->role = Role::from($data['role']);
+    }
+}
+// end-user-class

source/includes/bson/User.php

@@ -0,0 +1,56 @@
+<?php
+
+require 'vendor/autoload.php';
+
+use Bson\Person;
+use Bson\User;
+use Bson\Role;
+
+$uri = getenv('MONGODB_URI') ?: throw new RuntimeException('Set the MONGODB_URI variable to your Atlas URI that connects to the sample dataset');
+$client = new MongoDB\Client($uri);
+$db = $client->test;
+
+// start-create-doc
+$document = [
+    'address' => [
+        'street' => 'Pizza St',
+        'zipcode' => '10003'
+    ],
+    'coord' => [-73.982419, 41.579505],
+    'cuisine' => 'Pizza',
+    'name' => 'Planet Pizza'
+];
+// end-create-doc
+
+// start-modify-doc
+$document['restaurant_id'] = 12345;
+$document['name'] = 'Galaxy Pizza';
+// end-modify-doc
+
+// start-type-map
+$options = [
+    'typeMap' => [
+        'array' => 'MongoDB\Model\BSONDocument',
+        'root' => 'MongoDB\Model\BSONDocument', 
+        'document' => 'MongoDB\Model\BSONDocument',
+    ],
+];
+
+$db->createCollection('restaurants', $options);
+// end-type-map
+
+// start-person-serialize
+$collection = $client->test->persons;
+$result = $collection->insertOne(new Person('Bob'));
+$person = $collection->findOne(['_id' => $result->getInsertedId()]);
+
+var_dump($person);
+// end-person-serialize
+
+// start-enum-serialize
+$collection = $client->test->users;
+$result = $collection->insertOne(new User('alice', Role::USER));
+$person = $collection->findOne(['_id' => $result->getInsertedId()]);
+
+var_dump($person);
+// end-enum-serialize