Julio Montoya ae4afdabd6 Updating vendors | 11 tahun lalu | |
---|---|---|
.. | ||
src | 11 tahun lalu | |
tests | 11 tahun lalu | |
.travis.yml | 11 tahun lalu | |
LICENSE | 11 tahun lalu | |
README.md | 11 tahun lalu | |
composer.json | 11 tahun lalu | |
phpunit.xml.dist | 11 tahun lalu |
Provides Doctrine ORM Entity Managers as services to Pimple applications.
Currently requires both dbs and dbs.event_manager services in order to work. These can be provided by a Doctrine Service Provider like the Silex or Cilex service providers. If you can or want to fake it, go for it. :)
An implementation of dflydev/psr0-resource-locator-service-provider is required if using namespaceish resource mapping. See documentation for orm.generate_psr0_mapping for more information.
Through Composer as dflydev/doctrine-orm-service-provider.
To get up and running, register DoctrineOrmServiceProvider
and
manually specify the directory that will contain the proxies along
with at least one mapping.
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.
<?php
// Default entity manager.
$em = $app['orm.em'];
<?php
use Dflydev\Pimple\Provider\DoctrineOrm\DoctrineOrmServiceProvider;
$container = new \Pimple;
$container["db.options"] = array(
"driver" => "pdo_sqlite",
"path" => "/path/to/sqlite.db",
);
// ensure that $container['dbs'] and $container['dbs.event_manager']
// are available, most likely by way of a core service provider.
$container["orm.proxies_dir"] = "/path/to/proxies";
$container["orm.em.options"] = array(
"mappings" => array(
// Using actual filesystem paths
array(
"type" => "annotation",
"namespace" => "Foo\Entities",
"path" => __DIR__."/src/Foo/Entities",
),
array(
"type" => "xml",
"namespace" => "Bat\Entities",
"path" => __DIR__."/src/Bat/Resources/mappings",
),
// Using PSR-0 namespaceish embedded resources
// (requires registering a PSR-0 Resource Locator
// Service Provider)
array(
"type" => "annotation",
"namespace" => "Baz\Entities",
"resources_namespace" => "Baz\Entities",
),
array(
"type" => "xml",
"namespace" => "Bar\Entities",
"resources_namespace" => "Bar\Resources\mappings",
),
),
);
$doctrineOrmServiceProvider = new DoctrineOrmServiceProvider;
$doctrineormServiceProvider->register($container);
<?php
use Dflydev\Silex\Provider\DoctrineOrm\DoctrineOrmServiceProvider;
use Silex\Application;
use Silex\Provider\DoctrineServiceProvider;
$app = new Application;
$app->register(new DoctrineServiceProvider, array(
"db.options" => array(
"driver" => "pdo_sqlite",
"path" => "/path/to/sqlite.db",
),
));
$app->register(new DoctrineOrmServiceProvider, array(
"orm.proxies_dir" => "/path/to/proxies",
"orm.em.options" => array(
"mappings" => array(
// Using actual filesystem paths
array(
"type" => "annotation",
"namespace" => "Foo\Entities",
"path" => __DIR__."/src/Foo/Entities",
),
array(
"type" => "xml",
"namespace" => "Bat\Entities",
"path" => __DIR__."/src/Bat/Resources/mappings",
),
// Using PSR-0 namespaceish embedded resources
// (requires registering a PSR-0 Resource Locator
// Service Provider)
array(
"type" => "annotation",
"namespace" => "Baz\Entities",
"resources_namespace" => "Baz\Entities",
),
array(
"type" => "xml",
"namespace" => "Bar\Entities",
"resources_namespace" => "Bar\Resources\mappings",
),
),
),
));
<?php
use Dflydev\Cilex\Provider\DoctrineOrm\DoctrineOrmServiceProvider;
use Cilex\Application;
use Cilex\Provider\DoctrineServiceProvider;
$app = new Application('My Application');
$app->register(new DoctrineServiceProvider, array(
/** same as the Silex example **/
));
$app->register(new DoctrineOrmServiceProvider, array(
/** same as the Silex example **/
));
These options are available:
mappings: Array of mapping definitions.
Each mapping definition should be an array with the following options:
annotation
, xml
, yml
or php
.Additionally, each mapping definition should contain one of the following options:
Path\To\Foo\Resources\mappings
Each annotation mapping may also specify the following options:
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.
metadata_cache (Default: setting specified by orm.default_cache): String or array describing metadata cache implementation.
result_cache (Default: setting specified by orm.default_cache): String or array describing result cache implementation.
orm.ems.options: Array of Entity Manager configuration sets indexed by each Entity Manager's name. Each value should look like orm.em.options.
Example configuration:
<?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:
<?php
$emMysql = $app['orm.ems']['mysql'];
$emSqlite = $app['orm.ems']['sqlite'];
These params are available:
* **$mappingDriver**:
Mapping driver to be added,
instance `Doctrine\Common\Persistence\Mapping\Driver\MappingDriver`.
* **$namespace**:
Namespace to be mapped by `$mappingDriver`, string.
* **$name**:
Name of Entity Manager to add mapping to, string, default `null`.
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.
For example:
<?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.
Example usage:
<?php
$app['orm.ems.config'] = $app->share($app->extend('orm.ems.config', function ($config, $app) {
$mapping = $app['orm.generate_psr0_mapping'](array(
'Foo\Resources\mappings' => 'Foo\Entities',
'Bar\Resources\mappings' => 'Bar\Entities',
));
$chain = $app['orm.mapping_driver_chain.locator']();
foreach ($mapping as $directory => $namespace) {
$driver = new XmlDriver($directory);
$chain->addDriver($driver, $namespace);
}
return $config;
}));
Doctrine\ORM\EntityManager
.Doctrine\ORM\EntityManager
indexed by name.When use_simple_annotation_reader is set to False
for an entity,
the AnnotationRegistry
needs to have the project's autoloader added
to it.
Example:
<?php
$loader = require __DIR__ . '/../vendor/autoload.php';
\Doctrine\Common\Annotations\AnnotationRegistry::registerLoader(array($loader, 'loadClass'));
MIT, see LICENSE.
If you have questions or want to help out, join us in the #dflydev or #silex-php channels on irc.freenode.net.
This project is based heavily on both the core Doctrine Service Provider and the work done by @docteurklein on the docteurklein/silex-doctrine-service-providers project. Some inspiration was also taken from Doctrine Bundle and Doctrine Bridge.