Merge pull request #454 from stof/cache_metadata

stof · web-flow · commit b40623da645d · 2023-07-07T17:34:33.000+02:00
Configure the metadata cache for the extensions
diff --git a/composer.json b/composer.json
@@ -13,11 +13,12 @@
     ],
     "require": {
         "php": "^7.2.5 || ^8.0",
+        "symfony/cache": "^5.4 || ^6.0",
         "symfony/config": "^5.4 || ^6.0",
         "symfony/dependency-injection": "^5.4 || ^6.0",
         "symfony/event-dispatcher": "^5.4 || ^6.0",
         "symfony/http-kernel": "^5.4 || ^6.0",
-        "gedmo/doctrine-extensions": "^2.3.12 || ^3.0.0"
+        "gedmo/doctrine-extensions": "^3.5.0"
     },
     "require-dev": {
         "symfony/mime": "^5.4 || ^6.0",
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -26,6 +26,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->booleanNode('translation_fallback')->defaultFalse()->end()
                 ->booleanNode('persist_default_translation')->defaultFalse()->end()
                 ->booleanNode('skip_translation_on_load')->defaultFalse()->end()
+                ->scalarNode('metadata_cache_pool')->defaultNull()->end()
             ->end()
         ;
 
diff --git a/src/DependencyInjection/StofDoctrineExtensionsExtension.php b/src/DependencyInjection/StofDoctrineExtensionsExtension.php
@@ -2,7 +2,9 @@
 
 namespace Stof\DoctrineExtensionsBundle\DependencyInjection;
 
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
@@ -134,6 +136,12 @@ public function load(array $configs, ContainerBuilder $container)
             }
         }
 
+        if (isset($config['metadata_cache_pool'])) {
+            $container->setAlias('stof_doctrine_extensions.metadata_cache', new Alias($config['metadata_cache_pool'], false));
+        } else {
+            $container->register('stof_doctrine_extensions.metadata_cache', ArrayAdapter::class)->setPublic(false);
+        }
+
         foreach ($config['class'] as $listener => $class) {
             $container->setParameter(sprintf('stof_doctrine_extensions.listener.%s.class', $listener), $class);
         }
diff --git a/src/Resources/config/blameable.xml b/src/Resources/config/blameable.xml
@@ -10,6 +10,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.blameable" class="%stof_doctrine_extensions.listener.blameable.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/ip_traceable.xml b/src/Resources/config/ip_traceable.xml
@@ -6,6 +6,9 @@
 
     <services>
         <service id="stof_doctrine_extensions.listener.ip_traceable" class="Gedmo\IpTraceable\IpTraceableListener" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/loggable.xml b/src/Resources/config/loggable.xml
@@ -10,6 +10,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.loggable" class="%stof_doctrine_extensions.listener.loggable.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/reference_integrity.xml b/src/Resources/config/reference_integrity.xml
@@ -9,6 +9,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.reference_integrity" class="%stof_doctrine_extensions.listener.reference_integrity.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/sluggable.xml b/src/Resources/config/sluggable.xml
@@ -9,6 +9,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.sluggable" class="%stof_doctrine_extensions.listener.sluggable.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/softdeleteable.xml b/src/Resources/config/softdeleteable.xml
@@ -9,6 +9,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.softdeleteable" class="%stof_doctrine_extensions.listener.softdeleteable.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/sortable.xml b/src/Resources/config/sortable.xml
@@ -9,6 +9,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.sortable" class="%stof_doctrine_extensions.listener.sortable.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/timestampable.xml b/src/Resources/config/timestampable.xml
@@ -9,6 +9,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.timestampable" class="%stof_doctrine_extensions.listener.timestampable.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/translatable.xml b/src/Resources/config/translatable.xml
@@ -10,6 +10,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.translatable" class="%stof_doctrine_extensions.listener.translatable.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/tree.xml b/src/Resources/config/tree.xml
@@ -9,6 +9,9 @@
     </parameters>
     <services>
         <service id="stof_doctrine_extensions.listener.tree" class="%stof_doctrine_extensions.listener.tree.class%" public="false">
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>
diff --git a/src/Resources/config/uploadable.xml b/src/Resources/config/uploadable.xml
@@ -15,6 +15,9 @@
             <configurator service="stof_doctrine_extensions.uploadable.configurator" method="configure" />
             <argument type="service" id="stof_doctrine_extensions.uploadable.mime_type_guesser" />
 
+            <call method="setCacheItemPool">
+                <argument type="service" id="stof_doctrine_extensions.metadata_cache" />
+            </call>
             <call method="setAnnotationReader">
                 <argument type="service" id="annotation_reader" />
             </call>

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ public function getConfigTreeBuilder(): TreeBuilder`
`26`	`26`	`->booleanNode('translation_fallback')->defaultFalse()->end()`
`27`	`27`	`->booleanNode('persist_default_translation')->defaultFalse()->end()`
`28`	`28`	`->booleanNode('skip_translation_on_load')->defaultFalse()->end()`
	`29`	`+ ->scalarNode('metadata_cache_pool')->defaultNull()->end()`
`29`	`30`	`->end()`
`30`	`31`	`;`
`31`	`32`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace Stof\DoctrineExtensionsBundle\DependencyInjection;`
`4`	`4`
	`5`	`+use Symfony\Component\Cache\Adapter\ArrayAdapter;`
`5`	`6`	`use Symfony\Component\Config\Loader\LoaderInterface;`
	`7`	`+use Symfony\Component\DependencyInjection\Alias;`
`6`	`8`	`use Symfony\Component\HttpKernel\DependencyInjection\Extension;`
`7`	`9`	`use Symfony\Component\Config\Definition\Processor;`
`8`	`10`	`use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;`
`@@ -134,6 +136,12 @@ public function load(array $configs, ContainerBuilder $container)`
`134`	`136`	`}`
`135`	`137`	`}`
`136`	`138`
	`139`	`+ if (isset($config['metadata_cache_pool'])) {`
	`140`	`+ $container->setAlias('stof_doctrine_extensions.metadata_cache', new Alias($config['metadata_cache_pool'], false));`
	`141`	`+ } else {`
	`142`	`+ $container->register('stof_doctrine_extensions.metadata_cache', ArrayAdapter::class)->setPublic(false);`
	`143`	`+ }`
	`144`	`+`
`137`	`145`	`foreach ($config['class'] as $listener => $class) {`
`138`	`146`	`$container->setParameter(sprintf('stof_doctrine_extensions.listener.%s.class', $listener), $class);`
`139`	`147`	`}`