DOCSP-47059: Work with BSON #263
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-php-library ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
rustagir
reviewed
Jun 3, 2025
| selected classes (e.g. :phpmethod:`MongoDB\Client::getDatabase()`). | ||
| **BSON**, or Binary JSON, is the data format that MongoDB uses to organize | ||
| and store data. This data format includes all JSON data structure types and | ||
| supports additional types, including dates, different-sized integers, ``ObjectId`` |
There was a problem hiding this comment.
S: to resolve vale error
Suggested change
| supports additional types, including dates, different-sized integers, ``ObjectId`` | |
| also supports other types, such as dates, different-sized integers, ``ObjectId`` |
rustagir
requested changes
Jun 3, 2025
Comment on lines
23
to
24
| values, and binary data. The {+library-short+} provides the ``MongoDB\Model\BSONArray`` | ||
| and ``MongoDB\Model\BSONDocument`` types to store BSON data. |
Comment on lines
28
to
29
| For a complete list of supported BSON types, see :manual:`BSON Types | ||
| </reference/bson-types>` in the {+mdb-server+} manual. |
There was a problem hiding this comment.
Suggested change
| For a complete list of supported BSON types, see :manual:`BSON Types | |
| </reference/bson-types>` in the {+mdb-server+} manual. | |
| To view a complete list of supported BSON types, see :manual:`BSON Types | |
| </reference/bson-types>` in the {+mdb-server+} manual. |
|
|
||
| Persistable Classes | ||
| ------------------- | ||
| You can create a BSON document by using the same notation you use to create an |
There was a problem hiding this comment.
S: style guide
Suggested change
| You can create a BSON document by using the same notation you use to create an | |
| You can create a BSON document by using the same notation that you use to create an |
Comment on lines
69
to
71
| You can modify the contents of a BSON document by using the same notation you use to | ||
| modify an associative array in {+language+}. This example makes the following changes | ||
| to the :ref:`sample BSON document <php-bson-sample>`: |
There was a problem hiding this comment.
Suggested change
| You can modify the contents of a BSON document by using the same notation you use to | |
| modify an associative array in {+language+}. This example makes the following changes | |
| to the :ref:`sample BSON document <php-bson-sample>`: | |
| You can modify the contents of a BSON document by using the same notation that you use to | |
| modify an associative array in {+language+}. This example makes the following changes | |
| to the :ref:`sample BSON document <php-bson-sample>`: |
| }, | ||
| "coord" : [-73.982419, 41.579505] | ||
| "cuisine" : "Pizza", | ||
| "name" : "Mongo's Pizza" |
There was a problem hiding this comment.
S: consider using a name that doesn't include a char that needs escaping, unless you specifically want to demonstrate this (which is good too!)
There was a problem hiding this comment.
Updated, I don't think it's necessary to demonstrate
| Example | ||
| ``````` | ||
|
|
||
| Consider the following ``Person`` class definition: |
There was a problem hiding this comment.
S: explain what is special/expected by defining the class this way
Comment on lines
229
to
230
| you must specify serialization logic by defining the ``bsonSerialize()`` | ||
| and ``bsonUnserialize()`` methods. |
There was a problem hiding this comment.
Suggested change
| you must specify serialization logic by defining the ``bsonSerialize()`` | |
| and ``bsonUnserialize()`` methods. | |
| you must specify serialization logic by defining the ``bsonSerialize()`` | |
| and ``bsonUnserialize()`` methods in your class definition. |
Comment on lines
244
to
248
| .. literalinclude:: /includes/bson.php | ||
| :language: php | ||
| :dedent: | ||
| :start-after: start-backed-enum | ||
| :end-before: end-backed-enum |
There was a problem hiding this comment.
S: consider adding highlighting for the methods of interest
Comment on lines
252
to
256
| Enums cannot implement the ``MongoDB\BSON\Unserializable`` and | ||
| ``MongoDB\BSON\Persistable`` interfaces, since enum cases have no | ||
| state and cannot be instantiated like class objects. However, pure and backed | ||
| enums can implement ``MongoDB\BSON\Serializable``, which you can use to | ||
| override the default enum serialization behavior. |
There was a problem hiding this comment.
Suggested change
| Enums cannot implement the ``MongoDB\BSON\Unserializable`` and | |
| ``MongoDB\BSON\Persistable`` interfaces, since enum cases have no | |
| state and cannot be instantiated like class objects. However, pure and backed | |
| enums can implement ``MongoDB\BSON\Serializable``, which you can use to | |
| override the default enum serialization behavior. | |
| Enums cannot implement the ``MongoDB\BSON\Unserializable`` and | |
| ``MongoDB\BSON\Persistable`` interfaces because enum cases have no | |
| state and cannot be instantiated like class objects. However, pure and backed | |
| enums can implement ``MongoDB\BSON\Serializable``, which you can use to | |
| override the default enum serialization behavior. |
| :dedent: | ||
| :start-after: start-backed-enum | ||
| :end-before: end-backed-enum | ||
|
|
There was a problem hiding this comment.
S: consider demonstrating an example as you did in the previous section of the serialization roundtrip
rustagir
reviewed
Jun 5, 2025
Comment on lines
+82
to
+87
| .. note:: | ||
|
|
||
| The preceding code changes only the in-memory values of the sample BSON | ||
| document. It does not run any database operations that change values stored | ||
| in MongoDB. To learn how to modify documents stored in MongoDB, see the | ||
| :ref:`php-write-update` guide. |
There was a problem hiding this comment.
This looks good and addresses my concern!
rustagir
approved these changes
Jun 5, 2025
Comment on lines
92
to
93
| The following sections describe how to configure your application's | ||
| serialization of BSON data: |
There was a problem hiding this comment.
S: simplify
Suggested change
| The following sections describe how to configure your application's | |
| serialization of BSON data: | |
| The following sections describe how to configure the way your application | |
| serializes BSON data: |
| :start-after: start-enum-serialize | ||
| :end-before: end-enum-serialize | ||
| :language: php | ||
| :dedent: |
There was a problem hiding this comment.
S: maybe its worth adding a sentence below here that says that the USER enum value was stored as a 1 in MongoDB, but deserialized correctly into the enum value. But can also leave out if its obvious/redundant.
norareidy
requested review from
a team and
paulinevos
and removed request for
a team
paulinevos
approved these changes
Jun 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
Edits the existing BSON page for style guide alignment and adds some content.
JIRA - https://jira.mongodb.org/browse/DOCSP-47059
Staging Links
Self-Review Checklist