Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b2df9d6

Browse files
nicolas-grekasnicolas-grekas
committed
[FrameworkBundle] Simplify config for app/system/pool caches
1 parent 9f524b7 commit b2df9d6

17 files changed

Lines changed: 198 additions & 134 deletions

File tree

‎UPGRADE-3.1.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ FrameworkBundle
9090
cache service. If you are using `serializer.mapping.cache.apc`, use
9191
`serializer.mapping.cache.doctrine.apc` instead.
9292

93-
* The `framework.serializer.cache` option has been deprecated. Configure a cache pool
94-
called `serializer` under `framework.cache.pools` instead.
93+
* The `framework.serializer.cache` option has been deprecated. Configure the
94+
`cache.serializer` service under `framework.cache.pools` instead.
9595

9696
Before:
9797

@@ -107,7 +107,7 @@ FrameworkBundle
107107
framework:
108108
cache:
109109
pools:
110-
serializer:
110+
cache.serializer:
111111
adapter: cache.adapter.apcu
112112

113113
HttpKernel

‎UPGRADE-4.0.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ FrameworkBundle
7878
* The service `serializer.mapping.cache.apc` has been removed; use
7979
`serializer.mapping.cache.doctrine.apc` instead.
8080

81-
* The `framework.serializer.cache` option has been removed. Configure a cache pool
82-
called `serializer` under `framework.cache.pools` instead.
81+
* The `framework.serializer.cache` option has been removed. Configure the
82+
`cache.serializer` service under `framework.cache.pools` instead.
8383

8484
Before:
8585

@@ -95,7 +95,7 @@ FrameworkBundle
9595
framework:
9696
cache:
9797
pools:
98-
serializer:
98+
cache.serializer:
9999
adapter: cache.adapter.apcu
100100
```
101101

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/CachePoolPass.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public function process(ContainerBuilder $container)
6060
}
6161
unset($tags[0]['clearer']);
6262

63-
if (isset($tags[0]['provider']) && is_string($tags[0]['provider'])) {
63+
if (isset($tags[0]['provider'])) {
6464
$tags[0]['provider'] = new Reference($tags[0]['provider']);
6565
}
6666
$i = 0;

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php‎

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -557,34 +557,46 @@ private function addCacheSection(ArrayNodeDefinition $rootNode)
557557
->info('Cache configuration')
558558
->addDefaultsIfNotSet()
559559
->fixXmlConfig('pool')
560-
->fixXmlConfig('adapter')
561560
->children()
562-
->arrayNode('adapters')
563-
->useAttributeAsKey('name')
564-
->prototype('array')
565-
->children()
566-
->scalarNode('parent')
567-
->isRequired()
568-
->info('The parent cache adapter service.')
569-
->end()
570-
->integerNode('default_lifetime')->end()
571-
->scalarNode('provider')
572-
->info('The service name to use as provider when the specified parent adapter needs one.')
573-
->end()
574-
->scalarNode('clearer')->defaultValue('cache.default_pools_clearer')->end()
575-
->end()
576-
->end()
561+
->scalarNode('app')
562+
->info('App related cache pools configuration')
563+
->defaultValue('cache.adapter.filesystem')
564+
->end()
565+
->scalarNode('system')
566+
->info('System related cache pools configuration')
567+
->defaultValue('cache.adapter.filesystem')
568+
->end()
569+
->scalarNode('redis_dsn')
570+
->defaultValue('redis://localhost')
577571
->end()
578572
->arrayNode('pools')
579573
->useAttributeAsKey('name')
580574
->prototype('array')
575+
->validate()
576+
->ifTrue(function ($v) { return isset($v['parent'], $v['adapter']); })
577+
->thenInvalid('You cannot configure both "parent" and "adapter" options.')
578+
->end()
579+
->validate()
580+
->ifTrue(function ($v) { return !isset($v['adapter']); })
581+
->then(function ($v) {
582+
$v['adapter'] = 'cache.app';
583+
584+
return $v;
585+
})
586+
->end()
581587
->children()
588+
->scalarNode('parent')
589+
->info('To create a new adapter based on this parent service.')
590+
->end()
582591
->scalarNode('adapter')
583-
->info('The cache adapter service to use as template definition.')
584-
->defaultValue('cache.adapter.shared')
592+
->info('To create a new pool based on this adapter service.')
585593
->end()
586594
->booleanNode('public')->defaultTrue()->end()
595+
->scalarNode('provider')
596+
->info('The service name to use as provider when the specified parent or adapter needs one.')
597+
->end()
587598
->integerNode('default_lifetime')->end()
599+
->scalarNode('clearer')->defaultValue('cache.default_pools_clearer')->end()
588600
->end()
589601
->end()
590602
->end()

‎src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php‎

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public function load(array $configs, ContainerBuilder $container)
7373
$loader->load('property_access.xml');
7474

7575
// Load Cache configuration first as it is used by other components
76-
$loader->load('cache_pools.xml');
76+
$loader->load('cache.xml');
7777

7878
$configuration = $this->getConfiguration($configs, $container);
7979
$config = $this->processConfiguration($configuration, $configs);
@@ -984,7 +984,7 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
984984
$chainLoader->replaceArgument(0, $serializerLoaders);
985985

986986
if (isset($config['cache']) && $config['cache']) {
987-
@trigger_error('The "framework.serializer.cache" option is deprecated since Symfony 3.1 and will be removed in 4.0. You can configure a cache pool called "serializer" under "framework.cache.pools" instead.', E_USER_DEPRECATED);
987+
@trigger_error('The "framework.serializer.cache" option is deprecated since Symfony 3.1 and will be removed in 4.0. Configure the "cache.serializer" service under "framework.cache.pools" instead.', E_USER_DEPRECATED);
988988

989989
$container->setParameter(
990990
'serializer.mapping.cache.prefix',
@@ -999,7 +999,7 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
999999
CacheClassMetadataFactory::class,
10001000
array(
10011001
new Reference('serializer.mapping.cache_class_metadata_factory.inner'),
1002-
new Reference('cache.pool.serializer'),
1002+
new Reference('cache.serializer'),
10031003
)
10041004
);
10051005
$cacheMetadataFactory->setPublic(false);
@@ -1037,22 +1037,30 @@ private function registerPropertyInfoConfiguration(array $config, ContainerBuild
10371037

10381038
private function registerCacheConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
10391039
{
1040-
foreach ($config['adapters'] as $name => $adapterConfig) {
1041-
$adapterDefinition = new DefinitionDecorator($adapterConfig['parent']);
1042-
$adapterDefinition->setAbstract(true);
1043-
unset($adapterConfig['parent']);
1044-
1045-
$adapterDefinition->addTag('cache.pool', $adapterConfig);
1046-
$container->setDefinition('cache.adapter.'.$name, $adapterDefinition);
1047-
}
1048-
1049-
foreach ($config['pools'] as $name => $poolConfig) {
1050-
$poolDefinition = new DefinitionDecorator($poolConfig['adapter']);
1051-
$poolDefinition->setPublic($poolConfig['public']);
1052-
unset($poolConfig['adapter'], $poolConfig['public']);
1040+
$container->setParameter('cache.default_redis_dsn', $config['redis_dsn']);
1041+
1042+
$definition = new DefinitionDecorator($config['app']);
1043+
$definition->setPublic(true);
1044+
$definition->addTag('cache.pool');
1045+
$container->setDefinition('cache.app', $definition);
1046+
1047+
$definition = new DefinitionDecorator($config['system']);
1048+
$definition->setAbstract(true);
1049+
$definition->addTag('cache.pool');
1050+
$container->setDefinition('cache.adapter.system', $definition);
1051+
1052+
foreach ($config['pools'] as $name => $pool) {
1053+
if (isset($pool['parent'])) {
1054+
$definition = new DefinitionDecorator($pool['parent']);
1055+
$definition->setAbstract(true);
1056+
} else {
1057+
$definition = new DefinitionDecorator($pool['adapter']);
1058+
$definition->setPublic($pool['public']);
1059+
}
1060+
unset($pool['parent'], $pool['adapter'], $pool['public']);
10531061

1054-
$poolDefinition->addTag('cache.pool', $poolConfig);
1055-
$container->setDefinition('cache.pool.'.$name, $poolDefinition);
1062+
$definition->addTag('cache.pool', $pool);
1063+
$container->setDefinition($name, $definition);
10561064
}
10571065

10581066
$this->addClassesToCompile(array(

src/Symfony/Bundle/FrameworkBundle/Resources/config/cache_pools.xml renamed to src/Symfony/Bundle/FrameworkBundle/Resources/config/cache.xml

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,24 @@
1010
<tag name="kernel.cache_clearer" />
1111
</service>
1212

13-
<service id="cache.pool.app" parent="cache.adapter.shared">
13+
<service id="cache.default_redis_connection" class="Redis" public="false">
14+
<factory class="Symfony\Component\Cache\Adapter\RedisAdapter" method="createConnection" />
15+
<argument>%cache.default_redis_dsn%</argument>
16+
</service>
17+
18+
<service id="cache.app" parent="cache.adapter.filesystem">
1419
<tag name="cache.pool" />
1520
</service>
1621

17-
<service id="cache.pool.validator" parent="cache.adapter.local" public="false">
22+
<service id="cache.validator" parent="cache.adapter.system" public="false">
1823
<tag name="cache.pool" />
1924
</service>
2025

21-
<service id="cache.pool.serializer" parent="cache.adapter.local" public="false">
26+
<service id="cache.serializer" parent="cache.adapter.system" public="false">
2227
<tag name="cache.pool" />
2328
</service>
2429

25-
<service id="cache.adapter.local" alias="cache.adapter.filesystem" />
26-
<service id="cache.adapter.shared" alias="cache.adapter.filesystem" />
30+
<service id="cache.adapter.system" alias="cache.adapter.filesystem" />
2731

2832
<service id="cache.adapter.apcu" class="Symfony\Component\Cache\Adapter\ApcuAdapter" abstract="true">
2933
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
@@ -65,9 +69,9 @@
6569
</service>
6670

6771
<service id="cache.adapter.redis" class="Symfony\Component\Cache\Adapter\RedisAdapter" abstract="true">
68-
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
72+
<tag name="cache.pool" provider="cache.default_redis_connection" clearer="cache.default_pools_clearer" />
6973
<tag name="monolog.logger" channel="cache" />
70-
<argument /> <!-- Redis connection object -->
74+
<argument /> <!-- Redis connection -->
7175
<argument /> <!-- namespace -->
7276
<argument /> <!-- default lifetime -->
7377
<call method="setLogger">

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -205,24 +205,21 @@
205205
</xsd:complexType>
206206

207207
<xsd:complexType name="cache">
208-
<xsd:choice minOccurs="1" maxOccurs="unbounded">
209-
<xsd:element name="adapter" type="cache_adapter" />
210-
<xsd:element name="pool" type="cache_pool" />
211-
</xsd:choice>
212-
</xsd:complexType>
213-
214-
<xsd:complexType name="cache_adapter">
215-
<xsd:attribute name="name" type="xsd:string" use="required" />
216-
<xsd:attribute name="parent" type="xsd:string" />
217-
<xsd:attribute name="default-lifetime" type="xsd:integer" />
218-
<xsd:attribute name="provider" type="xsd:string" />
219-
<xsd:attribute name="clearer" type="xsd:string" />
208+
<xsd:sequence>
209+
<xsd:element name="app" type="xsd:string" minOccurs="0" maxOccurs="1" />
210+
<xsd:element name="system" type="xsd:string" minOccurs="0" maxOccurs="1" />
211+
<xsd:element name="redis_dsn" type="xsd:string" minOccurs="0" maxOccurs="1" />
212+
<xsd:element name="pool" type="cache_pool" minOccurs="0" maxOccurs="unbounded" />
213+
</xsd:sequence>
220214
</xsd:complexType>
221215

222216
<xsd:complexType name="cache_pool">
223217
<xsd:attribute name="name" type="xsd:string" use="required" />
218+
<xsd:attribute name="parent" type="xsd:string" />
224219
<xsd:attribute name="adapter" type="xsd:string" />
225220
<xsd:attribute name="public" type="xsd:boolean" />
221+
<xsd:attribute name="provider" type="xsd:string" />
226222
<xsd:attribute name="default-lifetime" type="xsd:integer" />
223+
<xsd:attribute name="clearer" type="xsd:string" />
227224
</xsd:complexType>
228225
</xsd:schema>

‎src/Symfony/Bundle/FrameworkBundle/Resources/config/validator.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<service id="validator.mapping.class_metadata_factory" alias="validator" public="false" />
3030

3131
<service id="validator.mapping.cache.symfony" class="Symfony\Component\Validator\Mapping\Cache\Psr6Cache" public="false">
32-
<argument type="service" id="cache.pool.validator" />
32+
<argument type="service" id="cache.validator" />
3333
</service>
3434

3535
<service id="validator.mapping.cache.doctrine.apc" class="Symfony\Component\Validator\Mapping\Cache\DoctrineCache" public="false">

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,8 +267,10 @@ protected static function getBundleDefaultConfig()
267267
'packages' => array(),
268268
),
269269
'cache' => array(
270-
'adapters' => array(),
271270
'pools' => array(),
271+
'app' => 'cache.adapter.filesystem',
272+
'system' => 'cache.adapter.filesystem',
273+
'redis_dsn' => 'redis://localhost',
272274
),
273275
);
274276
}

‎src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/cache.php‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,33 @@
22

33
$container->loadFromExtension('framework', array(
44
'cache' => array(
5-
'adapters' => array(
6-
'foo' => array(
5+
'pools' => array(
6+
'cache.adapter.foo' => array(
77
'parent' => 'cache.adapter.filesystem',
88
'default_lifetime' => 30,
99
),
10-
'app_redis' => array(
10+
'cache.adapter.app_redis' => array(
1111
'parent' => 'cache.adapter.redis',
1212
'provider' => 'app.redis_connection',
1313
'default_lifetime' => 30,
1414
),
15-
),
16-
'pools' => array(
17-
'foo' => array(
15+
'cache.foo' => array(
1816
'adapter' => 'cache.adapter.apcu',
1917
'default_lifetime' => 30,
2018
),
21-
'bar' => array(
19+
'cache.bar' => array(
2220
'adapter' => 'cache.adapter.doctrine',
2321
'default_lifetime' => 5,
2422
),
25-
'baz' => array(
23+
'cache.baz' => array(
2624
'adapter' => 'cache.adapter.filesystem',
2725
'default_lifetime' => 7,
2826
),
29-
'foobar' => array(
27+
'cache.foobar' => array(
3028
'adapter' => 'cache.adapter.psr6',
3129
'default_lifetime' => 10,
3230
),
33-
'def' => array(
31+
'cache.def' => array(
3432
'default_lifetime' => 11,
3533
),
3634
),

0 commit comments

Comments
 (0)