Advanced Configuration

Proxy Directory

1
<?php
$config->setProxyDir($dir);
2

Sets the directory where Doctrine generates any proxy classes. For a detailed explanation on proxy classes and how they are used in Doctrine, refer to the "Proxy Objects" section further down.

Setting the proxy target directory will also implicitly cause a call to Doctrine\ORM\Configuration#setAutoGenerateProxyClasses() with a value of Doctrine\Common\Proxy\ProxyFactory::AUTOGENERATE_FILE_NOT_EXISTS.

Proxy Namespace

1
<?php
$config->setProxyNamespace($namespace);
2

Sets the namespace to use for generated proxy classes. For a detailed explanation on proxy classes and how they are used in Doctrine, refer to the "Proxy Objects" section further down.

Metadata Driver (REQUIRED)

1
<?php
$config->setMetadataDriverImpl($driver);
$config->getMetadataDriverImpl();
2
3

Gets or sets the metadata driver implementation that is used by Doctrine to acquire the object-relational metadata for your classes.

There are currently 4 available implementations:

• Doctrine\ORM\Mapping\Driver\AnnotationDriver
• Doctrine\ORM\Mapping\Driver\XmlDriver
• Doctrine\ORM\Mapping\Driver\DriverChain

Throughout the most part of this manual the AnnotationDriver is used in the examples. For information on the usage of the XmlDriver please refer to the dedicated chapters XML Mapping.

The annotation driver can be configured with a factory method on the Doctrine\ORM\Configuration:

1
<?php
$driverImpl = $config->newDefaultAnnotationDriver('/path/to/lib/MyProject/Entities');
$config->setMetadataDriverImpl($driverImpl);
2
3

The path information to the entities is required for the annotation driver, because otherwise mass-operations on all entities through the console could not work correctly. All of metadata drivers accept either a single directory as a string or an array of directories. With this feature a single driver can support multiple directories of Entities.

Metadata Cache (RECOMMENDED)

1
<?php
$config->setMetadataCacheImpl($cache);
$config->getMetadataCacheImpl();
2
3

Gets or sets the cache implementation to use for caching metadata information, that is, all the information you supply via annotations or xml, so that they do not need to be parsed and loaded from scratch on every single request which is a waste of resources. The cache implementation must implement the Doctrine\Common\Cache\Cache interface.

Usage of a metadata cache is highly recommended.

The recommended implementations for production are:

• Doctrine\Common\Cache\ApcuCache
• Doctrine\Common\Cache\MemcacheCache
• Doctrine\Common\Cache\XcacheCache
• Doctrine\Common\Cache\RedisCache

For development you should use the Doctrine\Common\Cache\ArrayCache which only caches data on a per-request basis.

Query Cache (RECOMMENDED)

1
<?php
$config->setQueryCacheImpl($cache);
$config->getQueryCacheImpl();
2
3

Gets or sets the cache implementation to use for caching DQL queries, that is, the result of a DQL parsing process that includes the final SQL as well as meta information about how to process the SQL result set of a query. Note that the query cache does not affect query results. You do not get stale data. This is a pure optimization cache without any negative side-effects (except some minimal memory usage in your cache).

Usage of a query cache is highly recommended.

The recommended implementations for production are:

• Doctrine\Common\Cache\ApcuCache
• Doctrine\Common\Cache\MemcacheCache
• Doctrine\Common\Cache\XcacheCache
• Doctrine\Common\Cache\RedisCache

For development you should use the Doctrine\Common\Cache\ArrayCache which only caches data on a per-request basis.

SQL Logger (Optional)

1
<?php
$config->setSQLLogger($logger);
$config->getSQLLogger();
2
3

Gets or sets the logger to use for logging all SQL statements executed by Doctrine. The logger class must implement the Doctrine\DBAL\Logging\SQLLogger interface. A simple default implementation that logs to the standard output using echo and var_dump can be found at Doctrine\DBAL\Logging\EchoSQLLogger.

Auto-generating Proxy Classes

Proxy classes can either be generated manually through the Doctrine Console or automatically at runtime by Doctrine. The configuration option that controls this behavior is:

1
<?php
$config->setAutoGenerateProxyClasses($mode);
2

Possible values for $mode are:

• Doctrine\Common\Proxy\ProxyFactory::AUTOGENERATE_FILE_NOT_EXISTS

Generate the proxy class when the proxy file does not exist. This strategy can potentially cause disk access. Note that autoloading will be attempted before falling back to generating a proxy class: if an already existing proxy class is found, then no file write operations will be performed.

• Doctrine\Common\Proxy\ProxyFactory::AUTOGENERATE_EVAL

Generate the proxy classes and evaluate them on the fly via eval(), avoiding writing the proxies to disk. This strategy is only sane for development and long running processes.

• Doctrine\Common\Proxy\ProxyFactory::AUTOGENERATE_NEVER

This flag is deprecated, and is an alias of Doctrine\Common\Proxy\ProxyFactory::AUTOGENERATE_EVAL

• Doctrine\Common\Proxy\ProxyFactory::AUTOGENERATE_ALWAYS

This flag is deprecated, and is an alias of Doctrine\Common\Proxy\ProxyFactory::AUTOGENERATE_FILE_NOT_EXISTS

Before v2.4, setAutoGenerateProxyClasses would accept a boolean value. This is still possible, FALSE being equivalent to AUTOGENERATE_NEVER and TRUE to AUTOGENERATE_ALWAYS.

Manually generating Proxy Classes for performance

While the ORM can generate proxy classes when required, it is suggested to not let this happen for production environments, as it has a major impact on your application's performance.

In a production environment, it is highly recommended to use Doctrine\Common\Proxy\ProxyFactory::AUTOGENERATE_FILE_NOT_EXISTS in combination with a well-configured composer class autoloader.

Here is an example of such setup:

1
{
    "autoload": {
        "psr-4": {
            "MyProject\\": "path/to/project/sources/",
            "GeneratedProxies\\": "path/to/generated/proxies/"
        }
    }
}
2
3
4
5
6
7
8

You would then configure the ORM to use the "GeneratedProxies" and the "path/to/generated/proxies/" for the proxy classes:

1
<?php
$config->setProxyDir('path/to/generated/proxies/');
$config->setProxyNamespace('GeneratedProxies');
2
3

To make sure proxies are never generated by Doctrine, you'd forcefully generate them during deployment operations:

$ ./vendor/bin/doctrine orm:generate-proxies
$ composer dump-autoload