Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

[FrameworkBundle] Add cache adapters in semantic configuration #18625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[FrameworkBundle] Add cache adapters in semantic configuration #18625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion 4 src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/CachePoolPass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,9 @@ public function process(ContainerBuilder $container)
if ($pool->isAbstract()) {
continue;
}
$tags[0]['namespace'] = $this->getNamespace($namespaceSuffix, isset($tags[0]['namespace']) ? $tags[0]['namespace'] : $id);
if (!isset($tags[0]['namespace'])) {
$tags[0]['namespace'] = $this->getNamespace($namespaceSuffix, $id);
}
while ($adapter instanceof DefinitionDecorator) {
$adapter = $container->findDefinition($adapter->getParent());
if ($t = $adapter->getTag('cache.pool')) {
Expand Down
28 changes: 19 additions & 9 deletions 28 src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -557,27 +557,37 @@ private function addCacheSection(ArrayNodeDefinition $rootNode)
->info('Cache configuration')
->addDefaultsIfNotSet()
->fixXmlConfig('pool')
->fixXmlConfig('adapter')
->children()
->arrayNode('pools')
->arrayNode('adapters')
->useAttributeAsKey('name')
->prototype('array')
->children()
->scalarNode('adapter')
->info('The cache pool adapter service to use as template definition.')
->defaultValue('cache.adapter.shared')
->scalarNode('parent')
->isRequired()
->info('The parent cache adapter service.')
->end()
->booleanNode('public')->defaultFalse()->end()
->integerNode('default_lifetime')->end()
->scalarNode('provider')
->info('The service name to use as provider when the specified adapter needs one.')
->end()
->scalarNode('namespace')
->info('The namespace where cached items are stored. Auto-generated by default. Set to false to disable namespacing.')
->info('The service name to use as provider when the specified parent adapter needs one.')
->end()
->scalarNode('clearer')->defaultValue('cache.default_pools_clearer')->end()
->end()
->end()
->end()
->arrayNode('pools')
->useAttributeAsKey('name')
->prototype('array')
->children()
->scalarNode('adapter')
->info('The cache adapter service to use as template definition.')
->defaultValue('cache.adapter.shared')
->end()
->booleanNode('public')->defaultTrue()->end()
->integerNode('default_lifetime')->end()
->end()
->end()
->end()
->end()
->end()
->end()
Expand Down
9 changes: 9 additions & 0 deletions 9 src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1022,6 +1022,15 @@ private function registerPropertyInfoConfiguration(array $config, ContainerBuild

private function registerCacheConfiguration(array $config, ContainerBuilder $container, XmlFileLoader $loader)
{
foreach ($config['adapters'] as $name => $adapterConfig) {
$adapterDefinition = new DefinitionDecorator($adapterConfig['parent']);
$adapterDefinition->setAbstract(true);
unset($adapterConfig['parent']);

$adapterDefinition->addTag('cache.pool', $adapterConfig);
$container->setDefinition('cache.adapter.'.$name, $adapterDefinition);
}

foreach ($config['pools'] as $name => $poolConfig) {
$poolDefinition = new DefinitionDecorator($poolConfig['adapter']);
$poolDefinition->setPublic($poolConfig['public']);
Expand Down
44 changes: 25 additions & 19 deletions 44 src/Symfony/Bundle/FrameworkBundle/Resources/config/cache_pools.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,52 +10,58 @@
<tag name="kernel.cache_clearer" />
</service>

<service id="cache.adapter.shared" alias="cache.adapter.filesystem" />
<service id="cache.adapter.local" alias="cache.adapter.filesystem" />

<service id="cache.pool.shared" parent="cache.adapter.shared">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.pool.local" parent="cache.adapter.local">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.pool.validator" parent="cache.adapter.local" public="false">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.pool.serializer" parent="cache.adapter.local" public="false">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.adapter.apcu" class="Symfony\Component\Cache\Adapter\ApcuAdapter" abstract="true">
<argument /> <!-- namespace -->
<argument /> <!-- default lifetime -->
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.adapter.doctrine" class="Symfony\Component\Cache\Adapter\DoctrineAdapter" abstract="true">
<argument /> <!-- Doctrine provider service -->
<argument /> <!-- namespace -->
<argument /> <!-- default lifetime -->
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.adapter.filesystem" class="Symfony\Component\Cache\Adapter\FilesystemAdapter" abstract="true">
<argument /> <!-- namespace -->
<argument /> <!-- default lifetime -->
<argument>%kernel.cache_dir%/pools</argument>
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.adapter.psr6" class="Symfony\Component\Cache\Adapter\ProxyAdapter" abstract="true">
<argument /> <!-- PSR-6 provider service -->
<argument /> <!-- namespace -->
<argument /> <!-- default lifetime -->
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.adapter.redis" class="Symfony\Component\Cache\Adapter\RedisAdapter" abstract="true">
<argument /> <!-- Redis connection object -->
<argument /> <!-- namespace -->
<argument /> <!-- default lifetime -->
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.adapter.shared" alias="cache.adapter.filesystem">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.adapter.local" alias="cache.adapter.filesystem">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.pool.app" parent="cache.adapter.shared">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.pool.validator" parent="cache.adapter.local" public="false">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

<service id="cache.pool.serializer" parent="cache.adapter.local" public="false">
<tag name="cache.pool" clearer="cache.default_pools_clearer" />
</service>

</services>
Expand Down
12 changes: 10 additions & 2 deletions 12 src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,16 +206,24 @@

<xsd:complexType name="cache">
<xsd:choice minOccurs="1" maxOccurs="unbounded">
<xsd:element name="adapter" type="cache_adapter" />
<xsd:element name="pool" type="cache_pool" />
</xsd:choice>
</xsd:complexType>

<xsd:complexType name="cache_adapter">
<xsd:attribute name="name" type="xsd:string" use="required" />
<xsd:attribute name="parent" type="xsd:string" />
<xsd:attribute name="default-lifetime" type="xsd:integer" />
<xsd:attribute name="provider" type="xsd:string" />
<xsd:attribute name="clearer" type="xsd:string" />
</xsd:complexType>

<xsd:complexType name="cache_pool">
<xsd:attribute name="name" type="xsd:string" use="required" />
<xsd:attribute name="adapter" type="xsd:string" />
<xsd:attribute name="public" type="xsd:boolean" />
<xsd:attribute name="default-lifetime" type="xsd:integer" />
<xsd:attribute name="provider" type="xsd:string" />
<xsd:attribute name="clearer" type="xsd:string" />
<xsd:attribute name="namespace" type="xsd:string" />
</xsd:complexType>
</xsd:schema>
1 change: 1 addition & 0 deletions 1 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@ protected static function getBundleDefaultConfig()
'packages' => array(),
),
'cache' => array(
'adapters' => array(),
'pools' => array(),
),
);
Expand Down
13 changes: 11 additions & 2 deletions 13 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/cache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

$container->loadFromExtension('framework', array(
'cache' => array(
'adapters' => array(
'foo' => array(
'parent' => 'cache.adapter.filesystem',
'default_lifetime' => 30,
),
'app_redis' => array(
'parent' => 'cache.adapter.redis',
'provider' => 'app.redis_connection',
'default_lifetime' => 30,
),
),
'pools' => array(
'foo' => array(
'adapter' => 'cache.adapter.apcu',
Expand All @@ -10,7 +21,6 @@
'bar' => array(
'adapter' => 'cache.adapter.doctrine',
'default_lifetime' => 5,
'provider' => 'app.doctrine_cache_provider',
),
'baz' => array(
'adapter' => 'cache.adapter.filesystem',
Expand All @@ -19,7 +29,6 @@
'foobar' => array(
'adapter' => 'cache.adapter.psr6',
'default_lifetime' => 10,
'provider' => 'app.cache_pool',
),
'def' => array(
'default_lifetime' => 11,
Expand Down
6 changes: 4 additions & 2 deletions 6 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/cache.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@

<framework:config>
<framework:cache>
<framework:adapter name="foo" parent="cache.adapter.filesystem" default-lifetime="30" />
<framework:adapter name="app_redis" parent="cache.adapter.redis" provider="app.redis_connection" default-lifetime="30" />
<framework:pool name="foo" adapter="cache.adapter.apcu" default-lifetime="30" />
<framework:pool name="bar" adapter="cache.adapter.doctrine" default-lifetime="5" provider="app.doctrine_cache_provider" />
<framework:pool name="bar" adapter="cache.adapter.doctrine" default-lifetime="5" />
<framework:pool name="baz" adapter="cache.adapter.filesystem" default-lifetime="7" />
<framework:pool name="foobar" adapter="cache.adapter.psr6" default-lifetime="10" provider="app.cache_pool" />
<framework:pool name="foobar" adapter="cache.adapter.psr6" default-lifetime="10" />
<framework:pool name="def" default-lifetime="11" />
</framework:cache>
</framework:config>
Expand Down
10 changes: 8 additions & 2 deletions 10 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/cache.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
framework:
cache:
adapters:
foo:
parent: cache.adapter.filesystem
default_lifetime: 30
app_redis:
parent: cache.adapter.redis
provider: app.redis_connection
default_lifetime: 30
pools:
foo:
adapter: cache.adapter.apcu
default_lifetime: 30
bar:
adapter: cache.adapter.doctrine
default_lifetime: 5
provider: app.doctrine_cache_provider
baz:
adapter: cache.adapter.filesystem
default_lifetime: 7
foobar:
adapter: cache.adapter.psr6
default_lifetime: 10
provider: app.cache_pool
def:
default_lifetime: 11
50 changes: 48 additions & 2 deletions 50 src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,6 +577,14 @@ public function testPropertyInfoEnabled()
$this->assertTrue($container->has('property_info'));
}

public function testCacheAdapterServices()
{
$container = $this->createContainerFromFile('cache');

$this->assertCacheAdaptersServiceDefinitionIsCreated($container, 'foo', 'cache.adapter.foo', null, 30);
$this->assertCacheAdaptersServiceDefinitionIsCreated($container, 'app_redis', 'cache.adapter.redis', 'app.redis_connection', 30);
}

public function testCachePoolServices()
{
$container = $this->createContainerFromFile('cache');
Expand Down Expand Up @@ -659,6 +667,46 @@ private function assertVersionStrategy(ContainerBuilder $container, Reference $r
}
}

private function assertCacheAdaptersServiceDefinitionIsCreated(ContainerBuilder $container, $name, $parent, $provider, $defaultLifetime)
{
$id = 'cache.adapter.'.$name;

$this->assertTrue($container->has($id), sprintf('Service definition "%s" for cache adapter "%s" is registered', $id, $name));

$adapterDefinition = $container->getDefinition($id);

$this->assertTrue($adapterDefinition->hasTag('cache.pool'), sprintf('Service definition "%s" is tagged with the "cache.pool" tag.', $id));
$this->assertTrue($adapterDefinition->isAbstract(), sprintf('Service definition "%s" is abstract.', $id));

$tag = $adapterDefinition->getTag('cache.pool');
$this->assertTrue(isset($tag[0]['default_lifetime']), 'The default lifetime is stored as an attribute of the "cache.pool" tag.');
$this->assertSame($defaultLifetime, $tag[0]['default_lifetime'], 'The default lifetime is stored as an attribute of the "cache.pool" tag.');

if ($provider) {
$this->assertTrue(isset($tag[0]['provider']), 'The provider is stored as an attribute of the "cache.pool" tag.');
$this->assertSame($provider, $tag[0]['provider'], 'The provider is stored as an attribute of the "cache.pool" tag.');
} else {
$this->assertFalse(isset($tag[0]['provider']), 'No provider is stored as an attribute of the "cache.pool" tag.');
}

$this->assertInstanceOf(DefinitionDecorator::class, $adapterDefinition, sprintf('Cache adapter "%s" is based on a parent.', $name));

$adapterId = $adapterDefinition->getParent();
$adapterDefinition = $container->findDefinition($adapterId);

switch ($parent) {
case 'cache.adapter.apcu':
$this->assertSame(ApcuAdapter::class, $adapterDefinition->getClass());
break;
case 'cache.adapter.doctrine':
$this->assertSame(DoctrineAdapter::class, $adapterDefinition->getClass());
break;
case 'cache.adapter.filesystem':
$this->assertSame(FilesystemAdapter::class, $adapterDefinition->getClass());
break;
}
}

private function assertCachePoolServiceDefinitionIsCreated(ContainerBuilder $container, $name, $adapter, $defaultLifetime)
{
$id = 'cache.pool.'.$name;
Expand Down Expand Up @@ -690,7 +738,5 @@ private function assertCachePoolServiceDefinitionIsCreated(ContainerBuilder $con
$this->assertSame(FilesystemAdapter::class, $adapterDefinition->getClass());
break;
}

$this->assertTrue($adapterDefinition->isAbstract(), sprintf('Service definition "%s" is abstract.', $adapterId));
}
}
Morty Proxy This is a proxified and sanitized view of the page, visit original site.