doctrine / Doctrineormmodule
Doctrine ORM Module for Laminas
DoctrineORMModule integrates Doctrine ORM with Laminas quickly and easily.
- Doctrine ORM support
- Multiple ORM entity managers
- Multiple DBAL connections
- Reuse existing PDO connections in DBAL connection
Branches
There are two active branches and one bug-fix only branch.
- 3.0.x - Support for Migrations 1 & 2
- 3.2.x - Support for Migrations 3
Branch 3.1.x also supports Migrations 3 but new features required the 3.2.x branch to be created and now all enhancements happen on 3.2.x. 3.1.x will continue to receive bug fixes only.
Installation
Installation of this module uses composer. For composer documentation, please refer to getcomposer.org.
composer require doctrine/doctrine-orm-module
Then add DoctrineModule
and DoctrineORMModule
to your config/application.config.php
and create directory
data/DoctrineORMModule/Proxy
and make sure your application has write access to it.
Installation without composer is not officially supported and requires you to manually install all dependencies
that are listed in composer.json
Entities settings
To register your entities with the ORM, add following metadata driver configurations to your module (merged) configuration for each of your entities namespaces:
<?php
return [
'doctrine' => [
'driver' => [
// defines an annotation driver with two paths, and names it `my_annotation_driver`
'my_annotation_driver' => [
'class' => \Doctrine\ORM\Mapping\Driver\AnnotationDriver::class,
'cache' => 'array',
'paths' => [
'path/to/my/entities',
'another/path',
],
],
// default metadata driver, aggregates all other drivers into a single one.
// Override `orm_default` only if you know what you're doing
'orm_default' => [
'drivers' => [
// register `my_annotation_driver` for any entity under namespace `My\Namespace`
'My\Namespace' => 'my_annotation_driver',
],
],
],
],
];
Connection settings
Connection parameters can be defined in the application configuration:
<?php
return [
'doctrine' => [
'connection' => [
// default connection name
'orm_default' => [
'driverClass' => \Doctrine\DBAL\Driver\PDOMySql\Driver::class,
'params' => [
'host' => 'localhost',
'port' => '3306',
'user' => 'username',
'password' => 'password',
'dbname' => 'database',
],
],
],
],
];
Full configuration options
An exhaustive list of configuration options can be found directly in the Options classes of each module.
You can find documentation about the module's features at the following links:
Registered Service names
-
doctrine.connection.orm_default
: aDoctrine\DBAL\Connection
instance -
doctrine.configuration.orm_default
: aDoctrine\ORM\Configuration
instance -
doctrine.driver.orm_default
: default mapping driver instance -
doctrine.entitymanager.orm_default
: theDoctrine\ORM\EntityManager
instance -
Doctrine\ORM\EntityManager
: an alias ofdoctrine.entitymanager.orm_default
-
doctrine.eventmanager.orm_default
: theDoctrine\Common\EventManager
instance
Command Line
Access the Doctrine command line as following
./vendor/bin/doctrine-module
Service Locator
To access the entity manager, use the main service locator:
// for example, in a controller:
$em = $this->getServiceLocator()->get('doctrine.entitymanager.orm_default');
$em = $this->getServiceLocator()->get(\Doctrine\ORM\EntityManager::class);