Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/streamcommon/doctrine-manager
PSR-11 Doctrine container manager
https://github.com/streamcommon/doctrine-manager
doctrine php-component php7 psr-11
Last synced: about 2 months ago
JSON representation
PSR-11 Doctrine container manager
- Host: GitHub
- URL: https://github.com/streamcommon/doctrine-manager
- Owner: streamcommon
- License: bsd-3-clause
- Created: 2019-02-10T15:55:47.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T18:28:19.000Z (over 1 year ago)
- Last Synced: 2024-07-30T20:05:16.639Z (5 months ago)
- Topics: doctrine, php-component, php7, psr-11
- Language: PHP
- Homepage:
- Size: 278 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# doctrine-manager
[](https://packagist.org/packages/streamcommon/doctrine-manager)
[](https://packagist.org/packages/streamcommon/doctrine-manager)
[](./LICENSE)
This package provide [Doctrine 2](https://github.com/doctrine) factories for [PRS-11](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-11-container.md) container standard.
# Branches
[![Master][Master branch image]][Master branch] [![Build Status][Master image]][Master] [![Coverage Status][Master coverage image]][Master coverage]
[![Develop][Develop branch image]][Develop branch] [![Build Status][Develop image]][Develop] [![Coverage Status][Develop coverage image]][Develop coverage]
## Installation
Console run:
```console
composer require streamcommon/doctrine-manager
```
Or add into your `composer.json`:
```json
"require": {
"streamcommon/doctrine-manager": "*"
}
```
## Please check doctrine documentation for more info
* [ORM version 2.6](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/index.html)
* [DBAL version 2.9](https://www.doctrine-project.org/projects/doctrine-dbal/en/2.9/index.html)
* [Migrations version 2.1](https://www.doctrine-project.org/projects/doctrine-migrations/en/2.1/index.html)
* [Event Manager version 1.0](https://www.doctrine-project.org/projects/doctrine-event-manager/en/latest/index.html)
* [Metadata driver](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/metadata-drivers.html#metadata-drivers)
* [ORM Events](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/events.html)
* [Doctrine Annotation >1.6](https://www.doctrine-project.org/projects/doctrine-annotations/en/1.6/index.html)
* [Caching](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/caching.html)
* [Entity Manager](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/working-with-objects.html)
* [ZendFramework/zend-servicemanager](https://github.com/zendframework/zend-servicemanager)
* [ZendFramework/zend-auradi-config](https://github.com/zendframework/zend-auradi-config)
* [ZendFramework/zend-pimple-config](https://github.com/zendframework/zend-pimple-config)
* [Jsoumelidis/zend-sf-di-config](https://github.com/jsoumelidis/zend-sf-di-config)
* [Laminas/laminas-servicemanager](https://github.com/laminas/laminas-servicemanager)
* [Laminas/laminas-auradi-config](https://github.com/laminas/laminas-auradi-config)
* [Laminas/laminas-pimple-config](https://github.com/laminas/laminas-pimple-config)
## Example configure project file
> `Psr\Container\ContainerInterface` container MUST have `config` key
Configure your project config file:
1. Configure doctrine configuration like:
```php
'config' => [
'doctrine' => [
'configuration' => [
// If you use single connection
'orm_default' => [
'result_cache' => 'array',
'metadata_cache' => 'array',
'query_cache' => 'array',
'hydration_cache' => 'array',
'driver' => 'orm_default',
],
// If you want to add a second connection
'orm_custom' => [
'result_cache' => 'memcached',
'metadata_cache' => 'memcached',
'query_cache' => 'memcached',
'hydration_cache' => 'memcached',
'driver' => 'orm_custom',
],
],
```
2. Configure connection options like:
```php
'connection' => [
// If you use single connection
// Default using MySql connection
'orm_default' => [
'configuration' => 'orm_default',
'event_manager' => 'orm_default',
'params' => [
'dbname' => 'name',
'user' => 'user',
'password' => 'password',
'host' => 'localhost',
],
],
// If you want to add a second connection
// Alternative Postgress connection
'orm_custom' => [
'configuration' => 'orm_custom',
'event_manager' => 'orm_custom',
'driver_class_name' => \Doctrine\DBAL\Driver\PDOPgSql\Driver::class,
'params' => [
'dbname' => 'name',
'user' => 'user',
'password' => 'password',
'host' => 'localhost_custom',
],
]
],
```
3. Configure entity|event manager:
```php
'entity_manager' => [
'orm_default' => [
'connection' => 'orm_default',
'configuration' => 'orm_default',
],
'orm_custom' => [
'connection' => 'orm_custom',
'configuration' => 'orm_custom',
]
],
'event_manager' => [
'orm_default' => [
'subscribers' => [],
],
'orm_custom' => [
'subscribers' => [],
]
],
'entity_resolver' => [
'orm_default' => [
'resolvers' => [],
],
'orm_custom' => [
'resolvers' => [],
],
],
```
4. Configure orm driver, for example:
```php
'driver' => [
// If you use single connection
// Annotation driver example
//@see https://www.doctrine-project.org/projects/doctrine-annotations/en/1.6/index.html
'orm_default' => [
'class_name' => \Doctrine\Common\Persistence\Mapping\Driver\MappingDriverChain::class,
'drivers' => [
'Annotation\Entity' => 'Annotation\Entity'
],
],
'Annotation\Entity' => [
'class_name' => \Doctrine\ORM\Mapping\Driver\AnnotationDriver::class,
'paths' => [
__DIR__ . '/Annotation/Entity'
]
],
// If you want to add a second connection
// Php driver for example
'orm_custom' => [
'class_name' => \Doctrine\Common\Persistence\Mapping\Driver\MappingDriverChain::class,
'drivers' => [
'PHPDriver\Entity' => 'PHPDriver\Entity'
],
],
'PHPDriver\Entity' => [
'class_name' => \Doctrine\Common\Persistence\Mapping\Driver\PHPDriver::class,
'paths' => [
__DIR__ . '/PHPDriver/Entity'
]
],
],
```
5. Configure doctrine cache:
```php
//@see https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/caching.html
'cache' => [
'array' => [
'class_name' => Doctrine\Common\Cache\ArrayCache::class,
'namespace' => 'Streamcommon\Doctrine\Manager\Interop',
]
],
]
],
```
6. Configure your project dependencies:
```php
use Streamcommon\Doctrine\Manager\Common\Factory\{
Cache as CacheFactory,
Driver as DriverFactory,
EventManager as EventManagerFactory
};
use Streamcommon\Doctrine\Manager\DBAL\Factory\Connection as ConnectionFactory;
use Streamcommon\Doctrine\Manager\ORM\Factory\{
Configuration as ConfigurationFactory,
EntityManager as EntityManagerFactory,
EntityResolver as EntityResolverFactory,
};
'dependencies' => [
'factories' => [
// If you use single connection
'doctrine.driver.orm_default' => [DriverFactory::class, 'orm_default'],
'doctrine.event_manager.orm_default' => [EventManagerFactory::class, 'orm_default'],
'doctrine.configuration.orm_default' => [ConfigurationFactory::class, 'orm_default'],
'doctrine.connection.orm_default' => [ConnectionFactory::class, 'orm_default'],
'doctrine.entity_resolver.orm_default' => [EntityResolverFactory::class, 'orm_default'],
'doctrine.entity_manager.orm_default' => [EntityManagerFactory::class, 'orm_default'],
'doctrine.cache.array' => [CacheFactory::class, 'orm_default'],
// If you want to add a second connection
'doctrine.driver.orm_custom' => [DriverFactory::class, 'orm_custom'],
'doctrine.event_manager.orm_custom' => [EventManagerFactory::class, 'orm_custom'],
'doctrine.configuration.orm_custom' => [ConfigurationFactory::class, 'orm_custom'],
'doctrine.connection.orm_custom' => [ConnectionFactory::class, 'orm_custom'],
'doctrine.entity_resolver.orm_custom' => [EntityResolverFactory::class, 'orm_custom'],
'doctrine.entity_manager.orm_custom' => [EntityManagerFactory::class, 'orm_custom'],
],
]
```
7. Use in your project:
```php
$em = $container->get('doctrine.entity_manager.orm_default');
$connection = $container->get('doctrine.connection.orm_default');
```
## Example configure container
>Laminas ServiceManager
```php
use Streamcommon\Doctrine\Manager\ConfigProvider;
use Laminas\ServiceManager\ServiceManager;
$config = new ConfigProvider();
$config = $config();
$dependencies = $config['dependencies'];
$dependencies['services']['config'] = $config;
return new ServiceManager($dependencies);
```
>Symfony Container
```php
use JSoumelidis\SymfonyDI\Config\{Config as SymfonyConfig, ContainerFactory as SymfonyContainerFactory};
use Streamcommon\Doctrine\Manager\ConfigProvider;
$config = new ConfigProvider();
$config = $config();
$dependencies = $config['dependencies'];
$dependencies['services']['config'] = $config;
$container = new SymfonyContainerFactory();
return $container(new SymfonyConfig($dependencies))
```
>Etc...
## CLI usage
1) See
- [doctrine orm console tools](https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/tools.html)
- [doctrine migrations console tools](https://www.doctrine-project.org/projects/doctrine-migrations/en/2.1/reference/introduction.html#introduction)
2) For many connections was added a new `--object-manager` argument to `orm` namespace:
```console
Arguments:
--object-manager Doctrine object manager name [default: "orm_default"]
```
[Master branch]: https://github.com/streamcommon/doctrine-manager/tree/master
[Master branch image]: https://img.shields.io/badge/branch-master-blue.svg
[Develop branch]: https://github.com/streamcommon/doctrine-manager/tree/develop
[Develop branch image]: https://img.shields.io/badge/branch-develop-blue.svg
[Master image]: https://travis-ci.org/streamcommon/doctrine-manager.svg?branch=master
[Master]: https://travis-ci.org/streamcommon/doctrine-manager
[Master coverage image]: https://coveralls.io/repos/github/streamcommon/doctrine-manager/badge.svg?branch=master
[Master coverage]: https://coveralls.io/github/streamcommon/doctrine-manager?branch=master
[Develop image]: https://travis-ci.org/streamcommon/doctrine-manager.svg?branch=develop
[Develop]: https://travis-ci.org/streamcommon/doctrine-manager
[Develop coverage image]: https://coveralls.io/repos/github/streamcommon/doctrine-manager/badge.svg?branch=develop
[Develop coverage]: https://coveralls.io/github/streamcommon/doctrine-manager?branch=develop