README

The DoctrineCouchODMModule integrates Doctrine 2 CouchDB ODM with Zend Framework 2 quickly and easily. The following features are intended to work out of the box:

• CouchDB support

Requirements

Zend Framework 2 Application Skeleton (or compatible architecture)

Installation

Installation of this module uses composer. For composer documentation, please refer to getcomposer.org.

Installation steps

1. cd my/project/directory

2. create a composer.json file with following contents:

    {
        "minimum-stability": "alpha",
        "require": {
            "ardemiranda/doctrine-couch-odm-module": "dev-master"
        }
    }

3. install composer via curl -s http://getcomposer.org/installer | php (on windows, download http://getcomposer.org/installer and execute it with PHP)
4. run php composer.phar install

5. open my/project/directory/configs/application.config.php and add following keys to your modules (in this order)

    'DoctrineModule',
    'DoctrineCouchODMModule',

6. copy vendor/doctrine/doctrine-couch-odm-module/config/module.doctrine-couch-odm.local.php.dist into your application's config/autoload directory, rename it to module.doctrine-couch-odm.local.php and make the appropriate changes. With this config file you can configure your couch connection, add extra annotations to register, add subscribers to the event manager, add filters to the filter collection, and drivers to the driver chain.

7. create directory my/project/directory/data/DoctrineMongoODMModule/Proxy

Usage

Command Line

Access the Doctrine command line as following

./vendor/bin/doctrine-module

Service Locator

Access the document manager using the following service manager alias:

<?php
$dm = $this->getServiceLocator()->get('doctrine.documentmanager.odm_default');