diff --git a/snooty.toml b/snooty.toml index c7c062de..938cdc0d 100644 --- a/snooty.toml +++ b/snooty.toml @@ -1,7 +1,11 @@ name = "php-library" title = "PHP Library Manual" -intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"] +intersphinx = [ + "https://www.mongodb.com/docs/manual/objects.inv", + "https://www.mongodb.com/docs/drivers/objects.inv", + "https://www.mongodb.com/docs/atlas/objects.inv", +] toc_landing_pages = [ "/reference/class/MongoDBClient", @@ -22,6 +26,8 @@ toc_landing_pages = [ "/indexes" ] +sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" + [substitutions] php-library = "MongoDB PHP Library" diff --git a/source/compatibility.txt b/source/compatibility.txt new file mode 100644 index 00000000..b3362b5a --- /dev/null +++ b/source/compatibility.txt @@ -0,0 +1,64 @@ +.. _php-compatibility: + +============= +Compatibility +============= + +.. contents:: On this page + :local: + :backlinks: none + :depth: 2 + :class: singlecol + +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: backwards compatibility, versions, upgrade + +MongoDB Compatibility +--------------------- + +The following compatibility table specifies the recommended version or versions +of the {+php-library+} and extension that you can use with a specific version of MongoDB. + +The first column lists the version of the library and extension. + +.. sharedinclude:: dbx/lifecycle-schedule-callout.rst + +.. sharedinclude:: dbx/compatibility-table-legend.rst + +.. include:: /includes/mongodb-compatibility-table-php.rst + +For more information on how to read the compatibility tables, see our guide on +:ref:`MongoDB Compatibility Tables `. + +Language Compatibility +---------------------- + +The following compatibility table specifies the recommended version or versions +of the {+php-library+} and extension that you can use with a specific version of PHP. + +The first column lists the version of the library and extension. + +.. include:: /includes/language-compatibility-table-php.rst + +.. sharedinclude:: dbx/about-driver-compatibility.rst + +For more information on how to read the compatibility tables, see our guide on +:ref:`MongoDB Compatibility Tables `. + +How to Get Help +--------------- + +If you have questions about compatibility, visit the following resources for further guidance: + +- Ask questions on our :community-forum:`MongoDB Community Forums <>`. +- Visit our :technical-support:`Support Channels `. +- File an issue or feature request in our issue tracker, JIRA, under one of the + following projects: + + - `PHPC - Extension `_ + + - `PHPLIB - Library `_ diff --git a/source/includes/language-compatibility-table-php.rst b/source/includes/language-compatibility-table-php.rst new file mode 100644 index 00000000..c50e52b3 --- /dev/null +++ b/source/includes/language-compatibility-table-php.rst @@ -0,0 +1,49 @@ +.. list-table:: + :header-rows: 1 + :stub-columns: 1 + :class: compatibility-large + + * - PHP Driver Versions + - PHP 8.4 + - PHP 8.3 + - PHP 8.2 + - PHP 8.1 + - PHP 8.0 + - PHP 7.4 + - PHP 7.3 + + * - ext + lib 1.20 + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - + + * - ext + lib 1.17 to 1.19 + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - + - + + * - ext + lib 1.16 + - + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + + * - ext + lib 1.15 + - + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ \ No newline at end of file diff --git a/source/includes/mongodb-compatibility-table-php.rst b/source/includes/mongodb-compatibility-table-php.rst new file mode 100644 index 00000000..febec5a4 --- /dev/null +++ b/source/includes/mongodb-compatibility-table-php.rst @@ -0,0 +1,48 @@ +.. list-table:: + :header-rows: 1 + :stub-columns: 1 + :class: compatibility-large + + * - PHP Driver Versions + - MongoDB 8.0 + - MongoDB 7.0 + - MongoDB 6.0 + - MongoDB 5.0 + - MongoDB 4.4 + - MongoDB 4.2 + - MongoDB 4.0 + - MongoDB 3.6 + - MongoDB 3.4 + + * - ext + lib 1.20 + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - + - + + * - ext + lib 1.16 to 1.19 + - ⊛ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - + + * - ext + lib 1.15 + - ⊛ + - ⊛ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - ✓ + - \ No newline at end of file diff --git a/source/index.txt b/source/index.txt index 95e744a0..0a589f6e 100644 --- a/source/index.txt +++ b/source/index.txt @@ -21,6 +21,7 @@ MongoDB PHP Library /upgrade /reference FAQ + /compatibility /whats-new The |php-library| provides a high-level abstraction around the lower-level