Stars: 463
Forks: 130
Pull Requests: 173
Issues: 126
Watchers: 25
Last Updated: 2023-07-20 11:23:19
:link: Adapter to provide ext-mongo interface on top of mongo-php-library
License: MIT License
Languages: PHP, Shell
The Mongo PHP Adapter is a userland library designed to act as an adapter
between applications relying on ext-mongo and the new driver (ext-mongodb
).
It provides the API of ext-mongo built on top of mongo-php-library, thus being compatible with PHP 7.
This library aims to provide a compatibility layer for applications that rely on
libraries using ext-mongo, e.g.
Doctrine MongoDB ODM, but want to
migrate to PHP 7 on which ext-mongo
will not run.
You should not be using this library if you do not rely on a library using
ext-mongo
. If you are starting a new project, please check out
mongodb/mongodb.
This library requires you to have the mongodb
extension installed, and it
conflicts with the legacy mongo
extension.
The preferred method of installing this library is with Composer by running the following from your project root:
$ composer config "platform.ext-mongo" "1.6.16" && composer require alcaeus/mongo-php-adapter
The above command first marks the mongo
extension as installed, then requires
this adapter. This is to work around a bug in composer, see
composer/composer#5030.
Some methods may not throw exceptions with the same exception messages as their
counterparts in ext-mongo
. Do not rely on exception messages being the same.
Methods that return a result array containing a connectionId
field will always
return 0
as connection ID.
All errors and warnings triggered by ext-mongo
are triggered as E_USER_WARNING
and E_USER_ERROR
because trigger_error
doesn't accept the E_WARNING
and
E_USER
codes. If you rely on these error codes in your error handling routines,
please update your code accordingly.
Serialization of any Mongo* objects (e.g. MongoGridFSFile, MongoCursor, etc.) will not work properly. The objects can be serialized but are not usable after unserializing them.
$cmd
collection cannot be used due to an issue in the underlying driver.
To run commands, use the command
method instead of querying the virtual $cmd
collection.numReturned
and server
keys once the cursor has started iterating. The numReturned
field
will always show the same value as the at
field. The server
field is lacking
authentication information.at
, numReturned
,
firstBatchAt
and firstBatchNumReturned
fields. The at
and numReturned
fields always return 0 for compatibility to MongoCursor. The firstBatchAt
and
firstBatchNumReturned
fields will contain the same value, which is the internal
position of the iterator.If you are working on patches to this driver, you can run the unit tests by following these steps from the root of the repo directory:
$ composer install
$ vendor/phpunit/phpunit/phpunit --verbose
It assumes that the the localhost
is running a mongod server. Here is a sample command to start mongod for these tests:
$ mongod --smallfiles --fork --logpath /var/log/mongod.log --setParameter enableTestCommands=1
The tests also assume PHP 5.6+ and the ext-mongodb
extension being available.