vendor/symfony/http-kernel/Fragment/AbstractSurrogateFragmentRenderer.php line 60

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.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 Symfony\Component\HttpKernel\Fragment;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\Response;
  16. use Symfony\Component\HttpKernel\Controller\ControllerReference;
  17. use Symfony\Component\HttpKernel\HttpCache\SurrogateInterface;
  18. use Symfony\Component\HttpKernel\UriSigner;
  20. /**
  21.  * Implements Surrogate rendering strategy.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  */
  25. abstract class AbstractSurrogateFragmentRenderer extends RoutableFragmentRenderer
  26. {
  27.     private $surrogate;
  28.     private $inlineStrategy;
  29.     private $signer;
  31.     /**
  32.      * The "fallback" strategy when surrogate is not available should always be an
  33.      * instance of InlineFragmentRenderer.
  34.      *
  35.      * @param FragmentRendererInterface $inlineStrategy The inline strategy to use when the surrogate is not supported
  36.      */
  37.     public function __construct(SurrogateInterface $surrogate = null, FragmentRendererInterface $inlineStrategy, UriSigner $signer = null)
  38.     {
  39.         $this->surrogate = $surrogate;
  40.         $this->inlineStrategy = $inlineStrategy;
  41.         $this->signer = $signer;
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      *
  47.      * Note that if the current Request has no surrogate capability, this method
  48.      * falls back to use the inline rendering strategy.
  49.      *
  50.      * Additional available options:
  51.      *
  52.      *  * alt: an alternative URI to render in case of an error
  53.      *  * comment: a comment to add when returning the surrogate tag
  54.      *
  55.      * Note, that not all surrogate strategies support all options. For now
  56.      * 'alt' and 'comment' are only supported by ESI.
  57.      *
  58.      * @see Symfony\Component\HttpKernel\HttpCache\SurrogateInterface
  59.      */
  60.     public function render($uri, Request $request, array $options = [])
  61.     {
  62.         if (!$this->surrogate || !$this->surrogate->hasSurrogateCapability($request)) {
  63.             if ($uri instanceof ControllerReference && $this->containsNonScalars($uri->attributes)) {
  64.                 throw new \InvalidArgumentException('Passing non-scalar values as part of URI attributes to the ESI and SSI rendering strategies is not supported. Use a different rendering strategy or pass scalar values.');
  65.             }
  67.             return $this->inlineStrategy->render($uri, $request, $options);
  68.         }
  70.         if ($uri instanceof ControllerReference) {
  71.             $uri = $this->generateSignedFragmentUri($uri, $request);
  72.         }
  74.         $alt = $options['alt'] ?? null;
  75.         if ($alt instanceof ControllerReference) {
  76.             $alt = $this->generateSignedFragmentUri($alt, $request);
  77.         }
  79.         $tag = $this->surrogate->renderIncludeTag($uri, $alt, $options['ignore_errors'] ?? false, $options['comment'] ?? '');
  81.         return new Response($tag);
  82.     }
  84.     private function generateSignedFragmentUri(ControllerReference $uri, Request $request): string
  85.     {
  86.         if (null === $this->signer) {
  87.             throw new \LogicException('You must use a URI when using the ESI rendering strategy or set a URL signer.');
  88.         }
  90.         // we need to sign the absolute URI, but want to return the path only.
  91.         $fragmentUri = $this->signer->sign($this->generateFragmentUri($uri, $request, true));
  93.         return substr($fragmentUri, \strlen($request->getSchemeAndHttpHost()));
  94.     }
  96.     private function containsNonScalars(array $values): bool
  97.     {
  98.         foreach ($values as $value) {
  99.             if (\is_array($value)) {
  100.                 return $this->containsNonScalars($value);
  101.             } elseif (!is_scalar($value) && null !== $value) {
  102.                 return true;
  103.             }
  104.         }
  106.         return false;
  107.     }
  108. }