vendor/contao/core-bundle/src/Controller/AbstractController.php line 64

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Controller;
  15. use Contao\CoreBundle\Cache\EntityCacheTags;
  16. use Contao\CoreBundle\Csrf\ContaoCsrfTokenManager;
  17. use Contao\CoreBundle\Framework\Adapter;
  18. use Contao\CoreBundle\Framework\ContaoFramework;
  19. use Contao\Model\Collection as ModelCollection;
  20. use Doctrine\Common\Collections\Collection;
  21. use FOS\HttpCacheBundle\Http\SymfonyResponseTagger;
  22. use Psr\Log\LoggerInterface;
  23. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController as SymfonyAbstractController;
  24. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  26. abstract class AbstractController extends SymfonyAbstractController
  27. {
  28.     public static function getSubscribedServices()/*: array*/
  29.     {
  30.         $services = parent::getSubscribedServices();
  32.         $services['contao.framework'] = ContaoFramework::class;
  33.         $services['event_dispatcher'] = EventDispatcherInterface::class;
  34.         $services['logger'] = '?'.LoggerInterface::class;
  35.         $services['fos_http_cache.http.symfony_response_tagger'] = '?'.SymfonyResponseTagger::class;
  36.         $services['contao.csrf.token_manager'] = ContaoCsrfTokenManager::class;
  37.         $services['contao.cache.entity_tags'] = EntityCacheTags::class;
  39.         return $services;
  40.     }
  42.     protected function initializeContaoFramework(): void
  43.     {
  44.         $this->container->get('contao.framework')->initialize();
  45.     }
  47.     /**
  48.      * @template T
  49.      *
  50.      * @param class-string<T> $class
  51.      *
  52.      * @return T
  53.      *
  54.      * @phpstan-return Adapter<T>
  55.      */
  56.     protected function getContaoAdapter(string $class)
  57.     {
  58.         return $this->container->get('contao.framework')->getAdapter($class);
  59.     }
  61.     /**
  62.      * @param array|Collection|ModelCollection|string|object|null $tags
  63.      */
  64.     protected function tagResponse($tags): void
  65.     {
  66.         $this->container->get('contao.cache.entity_tags')->tagWith($tags);
  67.     }
  69.     /**
  70.      * @return array{csrf_field_name: string, csrf_token_manager: ContaoCsrfTokenManager, csrf_token_id: string}
  71.      */
  72.     protected function getCsrfFormOptions(): array
  73.     {
  74.         return [
  75.             'csrf_field_name' => 'REQUEST_TOKEN',
  76.             'csrf_token_manager' => $this->container->get('contao.csrf.token_manager'),
  77.             'csrf_token_id' => $this->getParameter('contao.csrf_token_name'),
  78.         ];
  79.     }
  80. }