Documentation updates for ext-mongodb 1.21#4500
Merged
jmikola merged 3 commits intophp:masterfrom Feb 27, 2025
Merged
Conversation
This was introduced in libmongocrypt with ext-mongodb 1.20 but was never documented. https://jira.mongodb.org/browse/PHPLIB-1375
jmikola
force-pushed
the
mongodb-1.21
branch
from
b4b1e53 to
629a526
Compare
alcaeus
approved these changes
Feb 27, 2025
Girgias
reviewed
Mar 6, 2025
| <methodparam><type>string</type><parameter>db</parameter></methodparam> | ||
| <methodparam><type>MongoDB\Driver\Command</type><parameter>command</parameter></methodparam> | ||
| <methodparam choice="opt"><type class="union"><type>array</type><type>MongoDB\Driver\ReadPreference</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam> | ||
| <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam> |
Member
There was a problem hiding this comment.
Maybe you should use the #[\Deprecated] attribute for parameter to indicate it is deprecated?
@TimWolla is this supported by the engine btw?
Member
There was a problem hiding this comment.
is this supported by the engine btw?
Yes, it's used for all deprecations in PHP core to provide the message: php/php-src#14750
Member
There was a problem hiding this comment.
Oh, I misread: No, it's not supported for parameters.
Member
Author
There was a problem hiding this comment.
FWIW, we explicitly raise a deprecation notice in the 1.x branch: https://github.com/mongodb/mongo-php-driver/blob/v1.x/src/phongo_util.c#L95
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
https://jira.mongodb.org/browse/PHPLIB-1375 (missed for 1.20)
https://jira.mongodb.org/browse/PHPC-2518
https://jira.mongodb.org/browse/PHPC-2489