419 lines
16 KiB
PHP
419 lines
16 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of the Doctrine Bundle
|
|
*
|
|
* The code was originally distributed inside the Symfony framework.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
* (c) Doctrine Project, Benjamin Eberlei <kontakt@beberlei.de>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Doctrine\Bundle\DoctrineBundle\DependencyInjection;
|
|
|
|
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
|
|
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
|
|
use Symfony\Component\Config\Definition\ConfigurationInterface;
|
|
|
|
/**
|
|
* This class contains the configuration information for the bundle
|
|
*
|
|
* This information is solely responsible for how the different configuration
|
|
* sections are normalized, and merged.
|
|
*
|
|
* @author Christophe Coevoet <stof@notk.org>
|
|
*/
|
|
class Configuration implements ConfigurationInterface
|
|
{
|
|
private $debug;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param Boolean $debug Whether to use the debug mode
|
|
*/
|
|
public function __construct($debug)
|
|
{
|
|
$this->debug = (Boolean) $debug;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getConfigTreeBuilder()
|
|
{
|
|
$treeBuilder = new TreeBuilder();
|
|
$rootNode = $treeBuilder->root('doctrine');
|
|
|
|
$this->addDbalSection($rootNode);
|
|
$this->addOrmSection($rootNode);
|
|
|
|
return $treeBuilder;
|
|
}
|
|
|
|
/**
|
|
* Add DBAL section to configuration tree
|
|
*
|
|
* @param ArrayNodeDefinition $node
|
|
*/
|
|
private function addDbalSection(ArrayNodeDefinition $node)
|
|
{
|
|
$node
|
|
->children()
|
|
->arrayNode('dbal')
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return is_array($v) && !array_key_exists('connections', $v) && !array_key_exists('connection', $v); })
|
|
->then(function ($v) {
|
|
// Key that should not be rewritten to the connection config
|
|
$excludedKeys = array('default_connection' => true, 'types' => true, 'type' => true);
|
|
$connection = array();
|
|
foreach ($v as $key => $value) {
|
|
if (isset($excludedKeys[$key])) {
|
|
continue;
|
|
}
|
|
$connection[$key] = $v[$key];
|
|
unset($v[$key]);
|
|
}
|
|
$v['default_connection'] = isset($v['default_connection']) ? (string) $v['default_connection'] : 'default';
|
|
$v['connections'] = array($v['default_connection'] => $connection);
|
|
|
|
return $v;
|
|
})
|
|
->end()
|
|
->children()
|
|
->scalarNode('default_connection')->end()
|
|
->end()
|
|
->fixXmlConfig('type')
|
|
->children()
|
|
->arrayNode('types')
|
|
->useAttributeAsKey('name')
|
|
->prototype('array')
|
|
->beforeNormalization()
|
|
->ifString()
|
|
->then(function($v) { return array('class' => $v); })
|
|
->end()
|
|
->children()
|
|
->scalarNode('class')->isRequired()->end()
|
|
->booleanNode('commented')->defaultTrue()->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->fixXmlConfig('connection')
|
|
->append($this->getDbalConnectionsNode())
|
|
->end()
|
|
;
|
|
}
|
|
|
|
/**
|
|
* Return the dbal connections node
|
|
*
|
|
* @return ArrayNodeDefinition
|
|
*/
|
|
private function getDbalConnectionsNode()
|
|
{
|
|
$treeBuilder = new TreeBuilder();
|
|
$node = $treeBuilder->root('connections');
|
|
|
|
/** @var $connectionNode ArrayNodeDefinition */
|
|
$connectionNode = $node
|
|
->requiresAtLeastOneElement()
|
|
->useAttributeAsKey('name')
|
|
->prototype('array')
|
|
;
|
|
|
|
$this->configureDbalDriverNode($connectionNode);
|
|
|
|
$connectionNode
|
|
->fixXmlConfig('option')
|
|
->fixXmlConfig('mapping_type')
|
|
->fixXmlConfig('slave')
|
|
->children()
|
|
->scalarNode('driver')->defaultValue('pdo_mysql')->end()
|
|
->scalarNode('platform_service')->end()
|
|
->booleanNode('logging')->defaultValue($this->debug)->end()
|
|
->booleanNode('profiling')->defaultValue($this->debug)->end()
|
|
->scalarNode('driver_class')->end()
|
|
->scalarNode('wrapper_class')->end()
|
|
->arrayNode('options')
|
|
->useAttributeAsKey('key')
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->arrayNode('mapping_types')
|
|
->useAttributeAsKey('name')
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
|
|
$slaveNode = $connectionNode
|
|
->children()
|
|
->arrayNode('slaves')
|
|
->useAttributeAsKey('name')
|
|
->prototype('array')
|
|
;
|
|
$this->configureDbalDriverNode($slaveNode);
|
|
|
|
return $node;
|
|
}
|
|
|
|
/**
|
|
* Adds config keys related to params processed by the DBAL drivers
|
|
*
|
|
* These keys are available for slave configurations too.
|
|
*
|
|
* @param ArrayNodeDefinition $node
|
|
*/
|
|
private function configureDbalDriverNode(ArrayNodeDefinition $node)
|
|
{
|
|
$node
|
|
->children()
|
|
->scalarNode('dbname')->end()
|
|
->scalarNode('host')->defaultValue('localhost')->end()
|
|
->scalarNode('port')->defaultNull()->end()
|
|
->scalarNode('user')->defaultValue('root')->end()
|
|
->scalarNode('password')->defaultNull()->end()
|
|
->scalarNode('charset')->end()
|
|
->scalarNode('path')->end()
|
|
->booleanNode('memory')->end()
|
|
->scalarNode('unix_socket')->info('The unix socket to use for MySQL')->end()
|
|
->booleanNode('persistent')->info('True to use as persistent connection for the ibm_db2 driver')->end()
|
|
->scalarNode('protocol')->info('The protocol to use for the ibm_db2 driver (default to TCPIP if ommited)')->end()
|
|
->booleanNode('service')->info('True to use dbname as service name instead of SID for Oracle')->end()
|
|
->scalarNode('sessionMode')
|
|
->info('The session mode to use for the oci8 driver')
|
|
->end()
|
|
->booleanNode('pooled')->info('True to use a pooled server with the oci8 driver')->end()
|
|
->booleanNode('MultipleActiveResultSets')->info('Configuring MultipleActiveResultSets for the pdo_sqlsrv driver')->end()
|
|
->end()
|
|
->beforeNormalization()
|
|
->ifTrue(function($v) {return !isset($v['sessionMode']) && isset($v['session_mode']);})
|
|
->then(function($v) {
|
|
$v['sessionMode'] = $v['session_mode'];
|
|
unset($v['session_mode']);
|
|
|
|
return $v;
|
|
})
|
|
->end()
|
|
->beforeNormalization()
|
|
->ifTrue(function($v) {return !isset($v['MultipleActiveResultSets']) && isset($v['multiple_active_result_sets']);})
|
|
->then(function($v) {
|
|
$v['MultipleActiveResultSets'] = $v['multiple_active_result_sets'];
|
|
unset($v['multiple_active_result_sets']);
|
|
|
|
return $v;
|
|
})
|
|
->end()
|
|
;
|
|
}
|
|
|
|
/**
|
|
* Add the ORM section to configuration tree
|
|
*
|
|
* @param ArrayNodeDefinition $node
|
|
*/
|
|
private function addOrmSection(ArrayNodeDefinition $node)
|
|
{
|
|
$node
|
|
->children()
|
|
->arrayNode('orm')
|
|
->beforeNormalization()
|
|
->ifTrue(function ($v) { return null === $v || (is_array($v) && !array_key_exists('entity_managers', $v) && !array_key_exists('entity_manager', $v)); })
|
|
->then(function ($v) {
|
|
$v = (array) $v;
|
|
// Key that should not be rewritten to the connection config
|
|
$excludedKeys = array(
|
|
'default_entity_manager' => true, 'auto_generate_proxy_classes' => true,
|
|
'proxy_dir' => true, 'proxy_namespace' => true, 'resolve_target_entities' => true,
|
|
'resolve_target_entity' => true,
|
|
);
|
|
$entityManager = array();
|
|
foreach ($v as $key => $value) {
|
|
if (isset($excludedKeys[$key])) {
|
|
continue;
|
|
}
|
|
$entityManager[$key] = $v[$key];
|
|
unset($v[$key]);
|
|
}
|
|
$v['default_entity_manager'] = isset($v['default_entity_manager']) ? (string) $v['default_entity_manager'] : 'default';
|
|
$v['entity_managers'] = array($v['default_entity_manager'] => $entityManager);
|
|
|
|
return $v;
|
|
})
|
|
->end()
|
|
->children()
|
|
->scalarNode('default_entity_manager')->end()
|
|
->booleanNode('auto_generate_proxy_classes')->defaultFalse()->end()
|
|
->scalarNode('proxy_dir')->defaultValue('%kernel.cache_dir%/doctrine/orm/Proxies')->end()
|
|
->scalarNode('proxy_namespace')->defaultValue('Proxies')->end()
|
|
->end()
|
|
->fixXmlConfig('entity_manager')
|
|
->append($this->getOrmEntityManagersNode())
|
|
->fixXmlConfig('resolve_target_entity', 'resolve_target_entities')
|
|
->append($this->getOrmTargetEntityResolverNode())
|
|
->end()
|
|
->end()
|
|
;
|
|
}
|
|
|
|
/**
|
|
* Return ORM target entity resolver node
|
|
*
|
|
* @return \Symfony\Component\Config\Definition\Builder\NodeDefinition
|
|
*/
|
|
private function getOrmTargetEntityResolverNode()
|
|
{
|
|
$treeBuilder = new TreeBuilder();
|
|
$node = $treeBuilder->root('resolve_target_entities');
|
|
|
|
$node
|
|
->useAttributeAsKey('interface')
|
|
->prototype('scalar')
|
|
->cannotBeEmpty()
|
|
->end()
|
|
;
|
|
|
|
return $node;
|
|
}
|
|
|
|
/**
|
|
* Return ORM entity manager node
|
|
*
|
|
* @return ArrayNodeDefinition
|
|
*/
|
|
private function getOrmEntityManagersNode()
|
|
{
|
|
$treeBuilder = new TreeBuilder();
|
|
$node = $treeBuilder->root('entity_managers');
|
|
|
|
$node
|
|
->requiresAtLeastOneElement()
|
|
->useAttributeAsKey('name')
|
|
->prototype('array')
|
|
->addDefaultsIfNotSet()
|
|
->append($this->getOrmCacheDriverNode('query_cache_driver'))
|
|
->append($this->getOrmCacheDriverNode('metadata_cache_driver'))
|
|
->append($this->getOrmCacheDriverNode('result_cache_driver'))
|
|
->children()
|
|
->scalarNode('connection')->end()
|
|
->scalarNode('class_metadata_factory_name')->defaultValue('Doctrine\ORM\Mapping\ClassMetadataFactory')->end()
|
|
->scalarNode('default_repository_class')->defaultValue('Doctrine\ORM\EntityRepository')->end()
|
|
->scalarNode('auto_mapping')->defaultFalse()->end()
|
|
->end()
|
|
->fixXmlConfig('hydrator')
|
|
->children()
|
|
->arrayNode('hydrators')
|
|
->useAttributeAsKey('name')
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->fixXmlConfig('mapping')
|
|
->children()
|
|
->arrayNode('mappings')
|
|
->useAttributeAsKey('name')
|
|
->prototype('array')
|
|
->beforeNormalization()
|
|
->ifString()
|
|
->then(function($v) { return array('type' => $v); })
|
|
->end()
|
|
->treatNullLike(array())
|
|
->treatFalseLike(array('mapping' => false))
|
|
->performNoDeepMerging()
|
|
->children()
|
|
->scalarNode('mapping')->defaultValue(true)->end()
|
|
->scalarNode('type')->end()
|
|
->scalarNode('dir')->end()
|
|
->scalarNode('alias')->end()
|
|
->scalarNode('prefix')->end()
|
|
->booleanNode('is_bundle')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->arrayNode('dql')
|
|
->fixXmlConfig('string_function')
|
|
->fixXmlConfig('numeric_function')
|
|
->fixXmlConfig('datetime_function')
|
|
->children()
|
|
->arrayNode('string_functions')
|
|
->useAttributeAsKey('name')
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->arrayNode('numeric_functions')
|
|
->useAttributeAsKey('name')
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->arrayNode('datetime_functions')
|
|
->useAttributeAsKey('name')
|
|
->prototype('scalar')->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->fixXmlConfig('filter')
|
|
->children()
|
|
->arrayNode('filters')
|
|
->info('Register SQL Filters in the entity manager')
|
|
->useAttributeAsKey('name')
|
|
->prototype('array')
|
|
->beforeNormalization()
|
|
->ifString()
|
|
->then(function($v) { return array('class' => $v); })
|
|
->end()
|
|
->beforeNormalization()
|
|
// The content of the XML node is returned as the "value" key so we need to rename it
|
|
->ifTrue(function($v) {return is_array($v) && isset($v['value']); })
|
|
->then(function($v) {
|
|
$v['class'] = $v['value'];
|
|
unset($v['value']);
|
|
|
|
return $v;
|
|
})
|
|
->end()
|
|
->children()
|
|
->scalarNode('class')->isRequired()->end()
|
|
->booleanNode('enabled')->defaultFalse()->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
->end()
|
|
;
|
|
|
|
return $node;
|
|
}
|
|
|
|
/**
|
|
* Return a ORM cache driver node for an given entity manager
|
|
*
|
|
* @param string $name
|
|
*
|
|
* @return ArrayNodeDefinition
|
|
*/
|
|
private function getOrmCacheDriverNode($name)
|
|
{
|
|
$treeBuilder = new TreeBuilder();
|
|
$node = $treeBuilder->root($name);
|
|
|
|
$node
|
|
->addDefaultsIfNotSet()
|
|
->beforeNormalization()
|
|
->ifString()
|
|
->then(function($v) { return array('type' => $v); })
|
|
->end()
|
|
->children()
|
|
->scalarNode('type')->defaultValue('array')->end()
|
|
->scalarNode('host')->end()
|
|
->scalarNode('port')->end()
|
|
->scalarNode('instance_class')->end()
|
|
->scalarNode('class')->end()
|
|
->scalarNode('id')->end()
|
|
->end()
|
|
;
|
|
|
|
return $node;
|
|
}
|
|
}
|