README

Use MongoDB as data gateway for Matryoshka.

Community

For questions and support please visit the slack channel (get an invite here).

Installation

Install it using composer.

Add the following to your composer.json file:

"require": {
    "matryoshka-model/mongo-wrapper": "~0.8.0"
}

Configuration

This library provides two abstract factories for Zend\ServiceManager to make MongoDb and MongoCollection available as services. In order to use them in a ZF2 application, register the provided factories through the service_manager configuration node:

'service_manager'    => [
    'abstract_factories' => [
        'Matryoshka\Model\Wrapper\Mongo\Service\MongoDbAbstractServiceFactory',
        'Matryoshka\Model\Wrapper\Mongo\Service\MongoCollectionAbstractServiceFactory',
    ],
],

Then in your configuration you can add the mongodb and mongocollection nodes and configure them as in example:

'mongodb' => [
    'Application\MongoDb\YourDatabaseName' => [
        'hosts' => '127.0.0.1:27017',
        'database' => 'yourDatabaseName'
    ],
    ...
],

'mongocollection'    => [
    'Application\DataGateway\YourCollectionName' => [
        'database'   => 'Application\MongoDb\YourDatabaseName',
        'collection' => 'yourCollectionName'
    ],
    ...
],

Usage

This wrapper provides extensions and default implementations for using MongoCollection as a datagateway.

Main concepts:

1. Inject a Matryoshka\Model\Wrapper\Mongo\Criteria\ActiveRecordCriteria instance into your Matryoshka\Model\Object\AbstractActiveRecord objects

   This way the matryoshka Active Record implementation will work with your MongoDB collections

2. Matryoshka\Model\Wrapper\Mongo\Paginator

   MongoPaginatorAdapter is a paginator adapter that can be used within paginable criterias

3. Matryoshka\Model\Wrapper\Mongo\ResultSet

   HydratingResultSet makes the counting functionality working correctly with MongoCursor datasources

NOTES

It's important to always use the HydratingResultSet class included in this package because MongoCursor does not implement the Countable and MongoCursor::count() must be called passing true as parameter.

Components

• Matryoshka\Model\Wrapper\Mongo\Criteria directory contains the aforementioned ActiveRecordCriteria matryoshka criteria.

• Matryoshka\Model\Wrapper\Mongo\Hydrator directory contains

  • ClassMethods, an hydrator that can be used with matryoshka objects when you have MongoDB collections as datagateways

  • NamingStrategy\DefaultNamingStrategy and NamingStrategy\UnderscoreNamingStrategy, two strategies that can be overridden to setup the naming rules map of your fields. By default, both convert _id to id.

  • Strategy\*, some common strategies for MongoDB.

• Matryoshka\Model\Wrapper\Mongo\Paginator directory contains the aforementioned MongoPaginatorAdapter adapter.

• Matryoshka\Model\Wrapper\Mongo\ResultSet contains the aforementioned HydratingResultSet which extends matryoshka's HydratingResultSet to make the MongoCursor counting functionality working properly.

• Matryoshka\Model\Wrapper\Mongo\Service contains abstract service factories generally aimed at instantiation of \MongoCollection and \MongoDb objects. Use mongocollection and mongodb configuration nodes to respectively setup them (see above).

Continuous integration

CI provided through TravisCI.

This wrapper is tested against the following MongoDB PHP clients: 1.4.5, 1.5.0, 1.5.1, 1.5.2, 1.5.3, 1.5.3, 1.5.5, 1.5.6, 1.5.7, 1.5.8, 1.6.0, 1.6.1, 1.6.2, 1.6.3, 1.6.4, 1.6.5, 1.6.6, 1.6.7, 1.6.8, 1.6.9, 1.6.10, 1.6.11, 1.6.12, 1.6.13.