vendor/sonata-project/block-bundle/src/Block/Service/AbstractBlockService.php line 36

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\BlockBundle\Block\Service;
  16. use Sonata\BlockBundle\Block\BlockContextInterface;
  17. use Sonata\BlockBundle\Model\BlockInterface;
  18. use Symfony\Component\HttpFoundation\Response;
  19. use Symfony\Component\OptionsResolver\OptionsResolver;
  20. use Twig\Environment;
  22. /**
  23.  * @author Sullivan Senechal <soullivaneuh@gmail.com>
  24.  */
  25. abstract class AbstractBlockService implements BlockServiceInterface
  26. {
  27.     public function __construct(private Environment $twig)
  28.     {
  29.     }
  31.     /**
  32.      * Returns a Response object than can be cacheable.
  33.      *
  34.      * @param array<string, mixed> $parameters
  35.      */
  36.     public function renderResponse(string $view, array $parameters = [], ?Response $response = null): Response
  37.     {
  38.         $response ??= new Response();
  40.         $response->setContent($this->twig->render($view, $parameters));
  42.         return $response;
  43.     }
  45.     /**
  46.      * Returns a Response object that cannot be cacheable, this must be used if the Response is related to the user.
  47.      * A good solution to make the page cacheable is to configure the block to be cached with javascript ...
  48.      *
  49.      * @deprecated since sonata-project/block-bundle 4.12 and will be removed in 5.0.
  50.      *
  51.      * NEXT_MAJOR: remove
  52.      *
  53.      * @param array<string, mixed> $parameters
  54.      */
  55.     public function renderPrivateResponse(string $view, array $parameters = [], ?Response $response = null): Response
  56.     {
  57.         @trigger_error(
  58.             sprintf(
  59.                 'Method "%s" is deprecated since sonata-project/block-bundle 4.12 and will be removed in 5.0.',
  60.                 __METHOD__
  61.             ),
  62.             \E_USER_DEPRECATED
  63.         );
  65.         return $this->renderResponse($view, $parameters, $response)
  66.             ->setTtl(0)
  67.             ->setPrivate();
  68.     }
  70.     /**
  71.      * Define the default options for the block.
  72.      */
  73.     public function configureSettings(OptionsResolver $resolver): void
  74.     {
  75.     }
  77.     public function getCacheKeys(BlockInterface $block): array
  78.     {
  79.         $updatedAt = $block->getUpdatedAt();
  81.         return [
  82.             'block_id' => $block->getId(),
  83.             'updated_at' => null !== $updatedAt ? $updatedAt->format('U') : null,
  84.         ];
  85.     }
  87.     public function load(BlockInterface $block): void
  88.     {
  89.     }
  91.     public function execute(BlockContextInterface $blockContext, ?Response $response = null): Response
  92.     {
  93.         $template = $blockContext->getTemplate();
  94.         \assert(null !== $template);
  96.         return $this->renderResponse($template, [
  97.             'block_context' => $blockContext,
  98.             'block' => $blockContext->getBlock(),
  99.         ], $response);
  100.     }
  102.     public function getTwig(): Environment
  103.     {
  104.         return $this->twig;
  105.     }
  106. }