axelcho/laminas-orm-module

Laminas Framework Module that provides Doctrine ORM functionality

1.0.0 2020-01-19 14:10 UTC

Requires

• ext-pdo: *
• axelcho/laminas-module: 1.0.1
• doctrine/dbal: ^2.6.0
• doctrine/orm: ^2.6.3
• laminas/laminas-code: ^3.4
• laminas/laminas-hydrator: ^2.3
• laminas/laminas-mvc: ^3.1
• laminas/laminas-servicemanager: ^3.3
• laminas/laminas-stdlib: ^3.2.1
• symfony/console: ^3.3 || ^4.0 || ^5.0

Requires (Dev)

• doctrine/data-fixtures: ^1.2.1
• doctrine/migrations: ^1.5 || ^2.0
• laminas/laminas-console: ^2.6
• laminas/laminas-developer-tools: ^1.1
• laminas/laminas-i18n: ^2.7.3
• laminas/laminas-log: ^2.9
• laminas/laminas-modulemanager: ^2.7.2
• laminas/laminas-mvc-console: ^1.2
• laminas/laminas-serializer: ^2.8
• phpunit/phpunit: ^7.0.3
• squizlabs/php_codesniffer: ^2.7

MIT

• orm
• module
• doctrine
• laminas

README

This is drop-in replacement for DoctrineORMModule packages.

Installation

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

composer require axelcho/laminas-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',
                ],
            ],
        ],
    ],
];