Doctrine Service Provider
, (*1)
This provider is a complete solution for using Doctrine in Pimple. You can use the
full ORM or just the DBAL. This project began as a fork of the dflydev/doctrine-orm-service-provider,
which itself is based heavily on both the core Doctrine Service Provider and the
work done by @docteurklein on the docteurklein/silex-doctrine-service-providers project., (*2)
Some inspiration was also taken from Doctrine Bundle and Doctrine Bridge., (*3)
Changelog
- 05-03-2019
- Updated PHP >=7.1
- Updated Doctrine cache types
- 20-01-2015
- Implemented second level cache
- Compatibility with Doctrine 2.5
Install
The recommended way to install through composer., (*4)
$ composer require linio/doctrine-service-provider
Tests
To run the test suite, you need install the dependencies via composer, then
run PHPUnit., (*5)
$ composer install
$ composer test
Usage
To start, you just need to register the OrmServiceProvider. This provider expects
two services to be registered, dbs and dbs.event_manager. You can register
those services yourself, or, use the included DbalServiceProvider., (*6)
In each of these examples an Entity Manager that is bound to the default database
connection will be provided. It will be accessible via orm.em., (*7)
<?php
use Linio\Doctrine\Provider\OrmServiceProvider;
use Linio\Doctrine\Provider\DbalServiceProvider;
use Pimple\Container;
$container = new Container();
$container->register(new DbalServiceProvider, [
'db.options' => [
'driver' => 'pdo_sqlite',
'path' => '/path/to/sqlite.db',
],
]);
$container->register(new OrmServiceProvider, [
'orm.proxies_dir' => '/path/to/proxies',
'orm.em.options' => [
'mappings' => [
// Using actual filesystem paths
[
'type' => 'annotation',
'namespace' => 'Foo\Entities',
'path' => __DIR__.'/src/Foo/Entities',
],
[
'type' => 'xml',
'namespace' => 'Bat\Entities',
'path' => __DIR__.'/src/Bat/Resources/mappings',
],
],
'resolve_target_entities' => [
'Rocket\Auth\Model\User' => 'MyProject\Model\Customer',
'Rocket\Auth\Model\Session' => 'MyProject\Model\Session',
'Rocket\Auth\Model\OAuthCredentials' => 'MyProject\Model\OAuthCredentials',
'Rocket\Auth\Model\SessionContext' => 'MyProject\Model\SessionContext',
],
],
]);
Configuration
Parameters
-
orm.em.options:
Array of Entity Manager options., (*8)
These options are available:, (*9)
-
connection (Default: default):
String defining which database connection to use. Used when using
named databases via dbs., (*10)
-
resolve_target_entities:
Array of resolutions from abstract classes or interfaces to concrete entities., (*11)
Example configuration:, (*12)
<?php
$app['orm.ems.default'] = 'sqlite';
$app['orm.ems.options'] = array(
'resolve_target_entities' => array(
'Rocket\Auth\Model\User' => 'MyProject\Model\Customer',
'Rocket\Auth\Model\Session' => 'MyProject\Model\Session',
'Rocket\Auth\Model\OAuthCredentials' => 'MyProject\Model\OAuthCredentials',
'Rocket\Auth\Model\SessionContext' => 'MyProject\Model\SessionContext',
),
);
-
mappings:
Array of mapping definitions., (*13)
Each mapping definition should be an array with the following
options:, (*14)
-
type: Mapping driver type, one of annotation, xml, yml, simple_xml, simple_yml or php., (*15)
-
namespace: Namespace in which the entities reside., (*16)
New: the simple_xml and simple_yml driver types were added in v1.1 and provide support for the simplified XML driver and [simplified YAML driver][9] of Doctrine., (*17)
Additionally, each mapping definition should contain one of the
following options:, (*18)
-
path: Path to where the mapping files are located. This should
be an actual filesystem path. For the php driver it can be an array
of paths, (*19)
-
resources_namespace: A namespaceish path to where the mapping
files are located. Example: Path\To\Foo\Resources\mappings, (*20)
Each mapping definition can have the following optional options:, (*21)
-
alias (Default: null): Set the alias for the entity namespace.
Each annotation mapping may also specify the following options:, (*22)
-
use_simple_annotation_reader (Default: true):
If
true, only simple notations like @Entity will work.
If false, more advanced notations and aliasing via use will
work. (Example: use Doctrine\ORM\Mapping AS ORM, @ORM\Entity)
Note that if set to false, the AnnotationRegistry will probably
need to be configured correctly so that it can load your Annotations
classes. See this FAQ:
Why aren't my Annotations classes being found?
-
query_cache (Default: setting specified by orm.default_cache):
String or array describing query cache implementation., (*23)
-
metadata_cache (Default: setting specified by orm.default_cache):
String or array describing metadata cache implementation., (*24)
-
result_cache (Default: setting specified by orm.default_cache):
String or array describing result cache implementation., (*25)
-
hydration_cache (Default: setting specified by orm.default_cache):
String or array describing hydration cache implementation., (*26)
-
types
An array of custom types in the format of 'typeName' => 'Namespace\To\Type\Class', (*27)
-
orm.ems.options:
Array of Entity Manager configuration sets indexed by each Entity Manager's
name. Each value should look like orm.em.options., (*28)
Example configuration:, (*29)
<?php
$app['orm.ems.default'] = 'sqlite';
$app['orm.ems.options'] = array(
'mysql' => array(
'connection' => 'mysql',
'mappings' => array(),
),
'sqlite' => array(
'connection' => 'sqlite',
'mappings' => array(),
),
);
Example usage:, (*30)
<?php
$emMysql = $app['orm.ems']['mysql'];
$emSqlite = $app['orm.ems']['sqlite'];, (*31)
-
orm.ems.default (Default: first Entity Manager processed):
String defining the name of the default Entity Manager., (*32)
-
orm.proxies_dir:
String defining path to where Doctrine generated proxies should be located., (*33)
-
orm.proxies_namespace (Default: DoctrineProxy):
String defining namespace in which Doctrine generated proxies should reside., (*34)
-
orm.auto_generate_proxies:
Boolean defining whether or not proxies should be generated automatically., (*35)
-
orm.class_metadata_factory_name: Class name of class metadata factory.
Class implements Doctrine\Common\Persistence\Mapping\ClassMetadataFactory., (*36)
-
orm.default_repository_class: Class name of default repository.
Class implements Doctrine\Common\Persistence\ObjectRepository., (*37)
-
orm.repository_factory: Repository factory, instance Doctrine\ORM\Repository\RepositoryFactory., (*38)
-
orm.entity_listener_resolver: Entity listener resolver, instance
Doctrine\ORM\Mapping\EntityListenerResolver., (*39)
-
orm.default_cache:
String or array describing default cache implementation., (*40)
-
orm.add_mapping_driver:
Function providing the ability to add a mapping driver to an Entity Manager., (*41)
These params are available:, (*42)
-
$mappingDriver:
Mapping driver to be added,
instance Doctrine\Common\Persistence\Mapping\Driver\MappingDriver., (*43)
-
$namespace:
Namespace to be mapped by $mappingDriver, string., (*44)
-
$name:
Name of Entity Manager to add mapping to, string, default null., (*45)
-
orm.em_name_from_param:
Function providing the ability to retrieve an entity manager's name from
a param., (*46)
This is useful for being able to optionally allow users to specify which
entity manager should be configured for a 3rd party service provider
but fallback to the default entity manager if not explitely specified., (*47)
For example:, (*48)
<?php
$emName = $app['orm.em_name_from_param']('3rdparty.provider.em');
$em = $app['orm.ems'][$emName];
This code should be able to be used inside of a 3rd party service provider
safely, whether the user has defined 3rdparty.provider.em or not., (*49)
-
orm.strategy:, (*50)
-
naming: Naming strategy, instance Doctrine\ORM\Mapping\NamingStrategy., (*51)
-
quote: Quote strategy, instance Doctrine\ORM\Mapping\QuoteStrategy., (*52)
-
orm.custom.functions:, (*53)
-
string, numeric, datetime: Custom DQL functions, array of class names indexed by DQL function name.
Classes are subclasses of Doctrine\ORM\Query\AST\Functions\FunctionNode., (*54)
-
hydration_modes: Hydrator class names, indexed by hydration mode name.
Classes are subclasses of Doctrine\ORM\Internal\Hydration\AbstractHydrator., (*55)
Wallogit.com
