Doctrine ORM Module for Laminas
DoctrineORMModule integrates Doctrine 2 ORM with Laminas quickly and easily.
Installation of this module uses composer. For composer documentation, please refer to getcomposer.org.
composer require doctrine/doctrine-orm-module
Then add
DoctrineModuleand
DoctrineORMModuleto your
config/application.config.phpand create directory
data/DoctrineORMModule/Proxyand 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
To register your entities with the ORM, add following metadata driver configurations to your module (merged) configuration for each of your entities namespaces:
[ '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 parameters can be defined in the application configuration:
[ 'connection' => [ // default connection name 'orm_default' => [ 'driverClass' => \Doctrine\DBAL\Driver\PDOMySql\Driver::class, 'params' => [ 'host' => 'localhost', 'port' => '3306', 'user' => 'username', 'password' => 'password', 'dbname' => 'database', ], ], ], ], ];
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:
doctrine.connection.orm_default: a
Doctrine\DBAL\Connectioninstance
doctrine.configuration.orm_default: a
Doctrine\ORM\Configurationinstance
doctrine.driver.orm_default: default mapping driver instance
doctrine.entitymanager.orm_default: the
Doctrine\ORM\EntityManagerinstance
Doctrine\ORM\EntityManager: an alias of
doctrine.entitymanager.orm_default
doctrine.eventmanager.orm_default: the
Doctrine\Common\EventManagerinstance
Access the Doctrine command line as following
./vendor/bin/doctrine-module
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);