php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity
31,035 Commits 7 Branches 0 Tags
master
Commit Graph

443 Commits

Author SHA1 Message Date
Andreas Braun
dac7a370d3 Document new API in ext-mongodb 2.2.0 (#5370) 
* Document new API in ext-mongodb 2.2.0

* Apply suggestions from code review

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>

---------

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>
 2026-02-13 08:19:35 +01:00
Gina Peter Banyard
83286b1ab6 Partial revert of 4dbc737 
No a para tag is actually needed here because programlisting is a block element
 2026-01-09 02:07:17 +00:00
Gina Peter Banyard
4dbc737cee Following up GH-5052 for markup nits 2026-01-09 01:54:05 +00:00
Andreas Braun
6536bde9ac PHPC-2643: Document using PIE to install ext-mongodb (#5052) 
* Update note about required PHP version

* PHPC-2643: Document using PIE to install ext-mongodb
 2025-12-22 15:05:45 +01:00
Jérôme Tamarelle
7ba4efc752 Extract autoEncryption driver options in MongoDB\Driver\Manager::__construct() (#4754) 
* Extract MongoDB autoEncryption options into a distinct table for readability

* Add link to autoEncryption options

---------

Co-authored-by: Andreas Braun <git@alcaeus.org>
 2025-07-08 13:41:45 +02:00
Mikhail Alferov
a52e5f8a81 bulkwritecommandexception.xml Fix typo (#4701) 2025-06-05 18:05:28 +01:00
Jeremy Mikola
187032b3ea MongoDB\Driver\BulkWriteCommand and related APIs (#4610) 
* MongoDB\Driver\BulkWriteCommand

* MongoDB\Driver\BulkWriteCommandResult

* MongoDB\Driver\Exception\BulkWriteCommandException

* Manager and Server executeBulkWriteCommand() methods

* Clarify that BulkWriteCommandException exposes error details

* Fix wrong duplicate property name

---------

Co-authored-by: Andreas Braun <git@alcaeus.org>
 2025-05-20 09:47:51 +02:00
Andreas Braun
e3c3525f7f MongoDB: Fix docs errors for 2.0 version (#4662) 
* Add missing methods to BulkWriteException docs

* Add missing changelog to BSON interfaces
 2025-05-09 11:03:15 +02:00
Andreas Braun
4639881688 MongoDB: document changes in 2.0.0 (#4618) 
* PHPC-2485: Remove support for legacy option types

* PHPC-2459: Remove support for float and string args to UTCDateTime::__construct

* PHPC-2447: Extend Iterator interface in CursorInterface

* PHPC-2441: Remove deprecated manager constructor options

* PHPC-2440: Remove deprecated query options

* PHPC-2417: Add UTCDateTimeInterface::toDateTimeImmutable

* PHPC-2402: Remove range_preview client encryption constants

* PHPC-2351: Remove CursorId class and change Cursor::getId() to return Int64

* PHPC-2348: Remove WriteException

* PHPC-2346: Remove BSON functions in favor of Document methods

* PHPC-2344: Remove SSLConnectionException

* PHPC-2248: Remove Serializable interface implementations

* PHPC-2144: WriteResult getters throw exception if unacknowledged

* Add language snippets for removed functionality changelog entries

* PHPC-1741: Remove getServer API and manager reference from APM event classes

* PHPC-1021: Remove ReadPreference integer constants

* Add changelog entries for enforced return types

* Remove breaking includes

* Fix duplicate XML tag

* Rename language snippet for clarity

* Note removed parameter for Cursor::getId

* Mention write results no longer returning null

* Fix XML errors

* Remove documentation for removed Serializable methods
 2025-04-17 14:22:19 +02:00
Jakub Vrana
cf2b279980 Remove <initializer> from required params 
Or make the param optional.
 2025-04-15 12:47:12 +02:00
Jeremy Mikola
fd625de3a6 Remove note about MongoDB 2.6 in getModifiedCount() (#4607) 
Support for MongoDB 2.6 was dropped in ext-mongodb 1.5.0

https://jira.mongodb.org/browse/PHPC-1662
 2025-04-11 08:43:21 +02:00
Jeremy Mikola
9a03654d10 MongoDB: Update examples to pass WriteConcern and ReadPreference as options (#4592) 
This was missed in 51ea49d0a5

https://jira.mongodb.org/browse/PHPC-2489
 2025-04-10 08:44:49 +02:00
Jeremy Mikola
2a9a8244a0 MongoDB: Fix BulkWrite::insert() example for always returning document _id (#4589) 
https://jira.mongodb.org/browse/PHPC-471

This was missed in ca221144de
 2025-04-09 08:24:33 +02:00
Andreas Braun
ec7d2da818 Update installation instructions for MacOS (#4525) 
* Add note about pkgconf and openssl being required
* Mention shivammathur/extensions tap containing the latest version
 2025-03-11 09:47:35 +01:00
Jeremy Mikola
51ea49d0a5 Deprecate passing WriteConcern and ReadPreference directly to execute methods 
https://jira.mongodb.org/browse/PHPC-2489
 2025-02-27 10:24:54 -05:00
Jeremy Mikola
d7be221e79 MongoDB\Driver\BulkWrite::update() "sort" option 
https://jira.mongodb.org/browse/PHPC-2518
 2025-02-27 10:24:54 -05:00
Jeremy Mikola
592e10fe7c KMIP masterKey "delegated" option 
This was introduced in libmongocrypt with ext-mongodb 1.20 but was never documented.

https://jira.mongodb.org/browse/PHPLIB-1375
 2025-02-27 10:24:54 -05:00
philip
e8ac70bf54 Implemented global.ent entities for all external URLs, these new entities were 
added to global.ent via f8bdf4030e
Sorry translators for this extra work!
Note: Notes containing 'windows.php.net/downloads/pecl/releases' were
removed as the associated entity will disappear one day via https://github.com/php/doc-base/pull/143
 2025-02-22 07:59:45 -08:00
Derick Rethans
22583751fb Fixed syntax errors in more examples 2025-02-07 11:21:39 +00:00
haszi
3e871fe7ea Convert MongoDB documentation from a top element of set to book (GH-3627) 
* Convert MongoDB documentation from a top element of set to book

Convert all underlying elements as needed:
 - books to parts or chapters
 - articles to sections

Move the Predefined Constants page from the Installing/Configuring section to its own

Change the following xml:ids:
 - book.mongodb to mongodb.mongodb
 - set.mongodb to book.mongodb
 - book.bson to mongodb.bson

* [skip-revcheck] Remove trailing whitespace

* Add extension membership

---------

Co-authored-by: haszi <haszika80@gmail.com>
 2024-10-21 13:11:18 +02:00
Leonardo Lara Rodrigues
63fc290622 mongodb committransaction: Typo correction (#3831) 2024-10-05 17:57:47 +01:00
Jeremy Mikola
27aaf9a626 MongoDB range indexes are no longer experimental (#3807) 
The "sparsity" and "trimFactor" range options are optional. Also add missing changelog entry from introducing "rangeOpts" in 1.16.0.

https://jira.mongodb.org/browse/PHPC-2403
https://jira.mongodb.org/browse/PHPC-2462
 2024-09-30 09:13:17 -04:00
Jeremy Mikola
3c84b02971 PackedArray::fromJSON() and toJSON methods (#3806) 
https://jira.mongodb.org/browse/PHPC-2350

* Remove trailing commas from Document toJSON examples

* Add returnvalues sections for Document and PackedArray from/to methods

* Clarify errors for Document and PackedArray fromJSON() methods

---------

Co-authored-by: Gina Peter Banyard <girgias@php.net>
 2024-09-30 09:12:19 -04:00
Jeremy Mikola
05814842a9 Add missing version info for Document::toPHP and Iterator ctor 2024-09-30 09:10:30 -04:00
Jeremy Mikola
a74c03c56b Improve docs for when SDAM Monitoring events are dispatched 
https://jira.mongodb.org/browse/PHPC-2449
 2024-09-27 08:58:15 -04:00
Jeremy Mikola
c8564726a0 UTCDateTime supports Int64, deprecates string and float 
https://jira.mongodb.org/browse/PHPC-2443
https://jira.mongodb.org/browse/PHPC-2458
 2024-09-26 10:22:20 -04:00
Jeremy Mikola
96c36c3585 Fix <literal> closing tag 
Fixes b101dd2464
 2024-09-24 16:40:13 -04:00
Jeremy Mikola
b101dd2464 Note default connection string 2024-09-24 16:39:23 -04:00
Jeremy Mikola
8c84a7f1fd Remove docs for --with-openssl-dir configure option 
This has been deprecated since ext-mongodb 1.4 and is being removed in 2.0.
 2024-09-23 09:51:32 -04:00
Jeremy Mikola
3f4735579d Deprecate getServer and add getHost and getPort to command event classes 
https://jira.mongodb.org/browse/PHPC-2442
 2024-09-17 10:50:34 -04:00
Jeremy Mikola
73789d960f Deprecate CursorId, document Cursor::getId() returning Int64 
https://jira.mongodb.org/browse/PHPC-2412
 2024-09-13 09:49:55 -04:00
Mikhail Alferov
e50e797467 Remove extra space characters (GH-3737) 
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
 2024-09-12 23:37:42 +02:00
Tim MacDonald
8859c8b96c Standardise casting spacing (#2717) 2024-09-11 14:29:15 +01:00
Jeremy Mikola
c64016065c Deprecate ReadPreference integer constants and getMode 
Replaces usage of integer constants in examples. For selectServer() examples, the read preference could be entirely removed.

https://jira.mongodb.org/browse/PHPC-1489
 2024-09-10 11:59:47 -04:00
Jeremy Mikola
a5eca06ae7 Deprecate BSON functions in favor of Document methods 
Replace references to deprecated BSON functions with Document methods.

https://jira.mongodb.org/browse/PHPC-2347
 2024-09-10 11:59:47 -04:00
Jeremy Mikola
09194b0f2d Remove "(deprecated)" from BSON class titles 
Although the corresponding BSON types are deprecated, the PHP classes themselves are not.
 2024-09-10 11:59:47 -04:00
Jeremy Mikola
4083e8f952 SSLConnectionException and WriteException are deprecated 
Removes "(deprecated)" from page titles and adds deprecation status to versions.xml, which groups the classes under a "Deprecated" heading in the navigation.

Note: SSLConnectionException was already deprecated in 5cb9e6a37f, but this makes the content consistent and fixes XML indentation.

https://jira.mongodb.org/browse/PHPC-2411
https://jira.mongodb.org/browse/PHPC-2349
 2024-09-10 11:59:47 -04:00
Mikhail Alferov
f5300368f8 unserialize.xml Replace serialized by data (GH-3689) 2024-08-27 16:06:34 +02:00
Jim Winstead
dd9038795c Set extension-membership for MongoDB extensions (#3686) 2024-08-26 13:40:34 -07:00
Jérôme Tamarelle
c9ff64ac87 Add method MongoDB\BSON\UTCDateTime::toDateTimeImmutable (#3578) 2024-07-22 13:36:01 +02:00
Jérôme Tamarelle
af0472588c Use CommandStartedEvent::getCommandName() (#3582) 2024-07-19 19:19:02 +02:00
Mikhail Alferov
4f6d374ba3 mongodb/driver/clientencryption.xml: update documentation links (#3461) 2024-06-21 09:41:58 -04:00
Mikhail Alferov
22eb2f3997 Fix invalid code in BSON serialization examples 
Separated the classes AnotherClass4 through AnotherClass6 and instantiate them in constructors of ContainerClass1 through ContainerClass 6, respectively.

https://jira.mongodb.org/browse/PHPC-2404

---------

Co-authored-by: Jeremy Mikola <jmikola@gmail.com>
 2024-06-20 11:16:07 -04:00
Jeremy Mikola
850a9367b8 Update ext-mongodb docs for queryable encryption range V2 (#3449) 
Documents new ClientEncryption constants in ext-mongodb 1.20, and deprecation of existing constants.

Documents new trimFactor range option.

Adds more detail for existing range options and wraps long lines in the constant/option docs.

https://jira.mongodb.org/browse/PHPC-2401
 2024-06-17 09:46:05 -04:00
Gina Peter Banyard
4d17b7b494 [skip-revcheck] Convert class markup to be compatible with DocBook 5.2 
Closes GH-3415
 2024-06-14 17:04:53 +01:00
Jeremy Mikola
e9214a2619 Revise driver/extension terminology in ext-mongodb docs (#3429) 
https://jira.mongodb.org/browse/PHPLIB-1279

* Refer to ext-mongodb as "extension" instead of "driver"

* Revise driver/extension references in Monitoring docs

* Refer to extension in mongodb.note.forking snippet

* Rewrite bsonSerialize() paragraph about ObjectId generation

* Use present tense in event method docs

* Rewrite paragraph about PHPLIB Document and Array classes

* Wrap long lines

---------

Co-authored-by: Jérôme Tamarelle <jerome@tamarelle.net>
 2024-06-04 08:52:47 -04:00
Jérôme Tamarelle
87a1b45a66 Add ArrayAccess methods for ext-mongodb BSON classes (#3420) 
* Documentation for MongoDB\BSON classes implementing ArrayAccess since 1.17.0

https://jira.mongodb.org/browse/PHPORM-182
 2024-05-28 13:56:02 -04:00
Jeremy Mikola
c90167b57a Remove extra space in paragraph text 
This was missed in 8069343866
 2024-05-22 12:32:11 -04:00
Jeremy Mikola
8069343866 Clarify option inheritance for ext-mongodb execute methods (#3406) 
https://jira.mongodb.org/browse/PHPC-2303
 2024-05-22 08:50:54 -04:00
Jeremy Mikola
ca33dfb525 Add databaseName property to command events 
https://jira.mongodb.org/browse/PHPC-2255
 2024-05-13 10:22:24 -04:00