vendor/friendsofsymfony/http-cache/src/ProxyClient/Symfony.php line 59

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSHttpCache package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\HttpCache\ProxyClient;
  14. use FOS\HttpCache\ProxyClient\Invalidation\ClearCapable;
  15. use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
  16. use FOS\HttpCache\ProxyClient\Invalidation\RefreshCapable;
  17. use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;
  18. use FOS\HttpCache\SymfonyCache\PurgeListener;
  19. use FOS\HttpCache\SymfonyCache\PurgeTagsListener;
  21. /**
  22.  * Symfony HttpCache invalidator.
  23.  *
  24.  * Additional constructor options:
  25.  * - purge_method:         HTTP method that identifies purge requests.
  26.  *
  27.  * @author David de Boer <david@driebit.nl>
  28.  * @author David Buchmann <mail@davidbu.ch>
  29.  */
  30. class Symfony extends HttpProxyClient implements PurgeCapable, RefreshCapable, TagCapable, ClearCapable
  31. {
  32.     public const HTTP_METHOD_REFRESH = 'GET';
  34.     /**
  35.      * {@inheritdoc}
  36.      */
  37.     public function purge($url, array $headers = [])
  38.     {
  39.         $this->queueRequest($this->options['purge_method'], $url, $headers);
  41.         return $this;
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     public function refresh($url, array $headers = [])
  48.     {
  49.         $headers = array_merge($headers, ['Cache-Control' => 'no-cache']);
  50.         $this->queueRequest(self::HTTP_METHOD_REFRESH, $url, $headers);
  52.         return $this;
  53.     }
  55.     protected function configureOptions()
  56.     {
  57.         $resolver = parent::configureOptions();
  58.         $resolver->setDefaults([
  59.             'purge_method' => PurgeListener::DEFAULT_PURGE_METHOD,
  60.             'clear_cache_header' => PurgeListener::DEFAULT_CLEAR_CACHE_HEADER,
  61.             'tags_method' => PurgeTagsListener::DEFAULT_TAGS_METHOD,
  62.             'tags_header' => PurgeTagsListener::DEFAULT_TAGS_HEADER,
  63.             'tags_invalidate_path' => '/',
  64.             'header_length' => 7500,
  65.         ]);
  66.         $resolver->setAllowedTypes('purge_method', 'string');
  67.         $resolver->setAllowedTypes('clear_cache_header', 'string');
  68.         $resolver->setAllowedTypes('tags_method', 'string');
  69.         $resolver->setAllowedTypes('tags_header', 'string');
  70.         $resolver->setAllowedTypes('tags_invalidate_path', 'string');
  71.         $resolver->setAllowedTypes('header_length', 'int');
  73.         return $resolver;
  74.     }
  76.     /**
  77.      * {@inheritdoc}
  78.      */
  79.     public function invalidateTags(array $tags)
  80.     {
  81.         $escapedTags = $this->escapeTags($tags);
  83.         $chunkSize = $this->determineTagsPerHeader($escapedTags, ',');
  85.         foreach (array_chunk($escapedTags, $chunkSize) as $tagchunk) {
  86.             $this->queueRequest(
  87.                 $this->options['tags_method'],
  88.                 $this->options['tags_invalidate_path'],
  89.                 [$this->options['tags_header'] => implode(',', $tagchunk)],
  90.                 false
  91.             );
  92.         }
  94.         return $this;
  95.     }
  97.     /**
  98.      * {@inheritdoc}
  99.      *
  100.      * Clearing the cache is implemented with a purge request with a special
  101.      * header to indicate that the whole cache should be removed.
  102.      *
  103.      * @return $this
  104.      */
  105.     public function clear()
  106.     {
  107.         $this->queueRequest(
  108.             $this->options['purge_method'],
  109.             '/',
  110.             [$this->options['clear_cache_header'] => 'true'],
  111.             false
  112.         );
  114.         return $this;
  115.     }
  116. }