mongo-php-adapter

by alcaeus

:link: Adapter to provide ext-mongo interface on top of mongo-php-library

447 Stars 103 Forks Last release: 11 months ago (1.1.11) MIT License 481 Commits 26 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Mongo PHP Adapter

Build Status Code Coverage Scrutinizer Code Quality

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.

Goal

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.

Installation

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.

Known issues

Return values and exceptions

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.

Errors

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 objects

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.

Mongo

  • The Mongo class is deprecated and was not implemented in this library. If you are still using it please update your code to use the new classes.

MongoLog

  • The MongoLog class does not log anything because the underlying driver does not offer a method to retrieve this data.

MongoClient

  • The connect and close methods are not implemented because the underlying driver connects lazily and does not offer methods for connecting disconnecting.
  • The getConnections method is not implemented because the underlying driver does not offer a method to retrieve this data.
  • The killCursor method is not yet implemented.

MongoDB

  • The authenticate method is not supported. To connect to a database with authentication, please supply the credentials using the connection string.
  • The
    $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.

MongoCollection

  • The insert, batchInsert, and save methods take the first argument by reference. While the original API does not explicitely specify by-reference arguments it does add an ID field to the objects and documents given.
  • The parallelCollectionScan method is not yet implemented.

MongoCursor

  • The info method does not reliably fill all fields in the cursor information. This includes the
    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.
  • The setFlag method is not yet implemented.
  • The timeout method will not change any query options. Client-side timeouts are no longer supported by the new driver. Use the maxTimeMS setting as a replacement.

MongoCommandCursor

  • The createFromDocument method is not yet implemented.
  • The info method does not reliably fill all fields in the cursor information. This includes the
    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.

Development

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.