codelegance / doctrine-mongo-odm-module
Zend Framework 2 Module that provides Doctrine MongoDB ODM functionality
Requires
- php: ^5.6 || ^7.0
- doctrine/doctrine-module: ^1.1
- doctrine/mongodb-odm: ~1.0
- zendframework/zend-mvc: 2.*
- zendframework/zend-servicemanager: 2.*
- zendframework/zend-stdlib: 2.*
Requires (Dev)
- phpunit/phpunit: ~4.8 || ~5.0
- zendframework/zendframework: 2.*
Replaces
This package is auto-updated.
Last update: 2021-08-18 14:15:24 UTC
README
The DoctrineMongoODMModule integrates Doctrine 2 MongoDB ODM with Zend Framework 2 quickly and easily. The following features are intended to work out of the box:
- MongoDB support
- Multiple document managers
- Multiple connections
- Support for using existing
Mongo
connections - Doctrine Cli 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
-
cd my/project/directory
-
create a
composer.json
file with following contents:{ "minimum-stability": "alpha", "require": { "doctrine/doctrine-mongo-odm-module": "dev-master" } }
-
install composer via
curl -s http://getcomposer.org/installer | php
(on windows, download http://getcomposer.org/installer and execute it with PHP) -
run
php composer.phar install
-
open
my/project/directory/configs/application.config.php
and add following keys to yourmodules
(in this order)'DoctrineModule', 'DoctrineMongoODMModule',
-
copy
vendor/doctrine/doctrine-mongo-odm-module/config/module.doctrine-mongo-odm.local.php.dist
into your application'sconfig/autoload
directory, rename it tomodule.doctrine-mongo-odm.local.php
and make the appropriate changes. With this config file you can configure your mongo connection, add extra annotations to register, add subscribers to the event manager, add filters to the filter collection, and drivers to the driver chain. -
create directory
my/project/directory/data/DoctrineMongoODMModule/Proxy
andmy/project/directory/data/DoctrineMongoODMModule/Hydrator
and make sure your application has write access to it.
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');
Configuration
Connection section
Either server
or connectionString
option has to be set.
Name | Default | Description |
---|---|---|
server | 'localhost' | IP of mongod instance |
port | 27017 | mongod port |
connectionString | null | If the connection string is specified, it will overwrite other connection options (server ,port ,user ,password ,dbname ). Still, the connection will respect the settings passed in options array. |
user | null | If set, the client will try to authenticate with given username and password |
password | null | If set, the client will try to authenticate with given username and password |
dbname | null | If dbname is not specified, "admin" will be used for authentication. Also, specifiing dbname affecs the defaultDB configuration option, if that's not specified explicitly. |
options | array() | Array with connection options. More detailed description in http://www.php.net/manual/en/mongoclient.construct.php |