Skip to content

Commit 7a5e617

Browse files
committed
feat: allow to configure header name for reverse_proxy_ttl specific value
1 parent cfb93c3 commit 7a5e617

File tree

4 files changed

+11
-3
lines changed

4 files changed

+11
-3
lines changed

src/DependencyInjection/Configuration.php

+5-1
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,10 @@ private function addCacheControlSection(ArrayNodeDefinition $rootNode): void
277277
->end()
278278
->end()
279279
->end()
280+
->scalarNode('ttl_header')
281+
->default('X-Reverse-Proxy-TTL')
282+
->info('Specify an ttl header name (works with cache_control.reverse_proxy_ttl)')
283+
->end()
280284
->arrayNode('rules')
281285
->prototype('array')
282286
->children();
@@ -330,7 +334,7 @@ private function addCacheControlSection(ArrayNodeDefinition $rootNode): void
330334
->end()
331335
->scalarNode('reverse_proxy_ttl')
332336
->defaultNull()
333-
->info('Specify an X-Reverse-Proxy-TTL header with a time in seconds for a caching proxy under your control.')
337+
->info('Specify an X-Reverse-Proxy-TTL (cache_control.ttl_header) header with a time in seconds for a caching proxy under your control.')
334338
->end()
335339
->arrayNode('vary')
336340
->beforeNormalization()->ifString()->then(function ($v) {

src/DependencyInjection/FOSHttpCacheExtension.php

+2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ public function load(array $configs, ContainerBuilder $container): void
4848

4949
if ($config['debug']['enabled'] || (!empty($config['cache_control']))) {
5050
$debugHeader = $config['debug']['enabled'] ? $config['debug']['header'] : false;
51+
$ttlHeader = $config['cache_control']['ttl_header'] ?? 'X-Reverse-Proxy-TTL';
5152
$container->setParameter('fos_http_cache.debug_header', $debugHeader);
53+
$container->setParameter('fos_http_cache.ttl_header', $ttlHeader);
5254
$loader->load('cache_control_listener.xml');
5355
}
5456

src/EventListener/CacheControlListener.php

+3-2
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ public function __construct(
5656
* @var string|false Name of the header or false to add no header
5757
*/
5858
private readonly string|false $debugHeader = false,
59+
private readonly string $ttlHeader = 'X-Reverse-Proxy-TTL',
5960
) {
6061
}
6162

@@ -115,9 +116,9 @@ public function onKernelResponse(ResponseEvent $event): void
115116

116117
if (array_key_exists('reverse_proxy_ttl', $options)
117118
&& null !== $options['reverse_proxy_ttl']
118-
&& !$response->headers->has('X-Reverse-Proxy-TTL')
119+
&& !$response->headers->has($this->ttlHeader)
119120
) {
120-
$response->headers->set('X-Reverse-Proxy-TTL', $options['reverse_proxy_ttl'], false);
121+
$response->headers->set($this->ttlHeader, $options['reverse_proxy_ttl'], false);
121122
}
122123

123124
if (!empty($options['vary'])) {

src/Resources/config/cache_control_listener.xml

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
class="FOS\HttpCacheBundle\EventListener\CacheControlListener"
1010
public="true">
1111
<argument>%fos_http_cache.debug_header%</argument>
12+
<argument>%fos_http_cache.ttl_header%</argument>
1213
<tag name="kernel.event_subscriber" />
1314
</service>
1415
<service id="FOS\HttpCacheBundle\EventListener\CacheControlListener" alias="fos_http_cache.event_listener.cache_control" public="true"/>

0 commit comments

Comments
 (0)