vendor/pimcore/pimcore/bundles/CoreBundle/DependencyInjection/Compiler/SessionConfiguratorPass.php line 74

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\CoreBundle\DependencyInjection\Compiler;
  18. use Pimcore\Session\SessionConfigurator;
  19. use Pimcore\Session\SessionConfiguratorInterface;
  20. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  21. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  22. use Symfony\Component\DependencyInjection\ContainerBuilder;
  23. use Symfony\Component\DependencyInjection\Reference;
  25. /**
  26.  * @TODO remove in Pimcore 11
  27.  *
  28.  * @internal
  29.  */
  30. final class SessionConfiguratorPass implements CompilerPassInterface
  31. {
  32.     /**
  33.      * {@inheritdoc}
  34.      */
  35.     public function process(ContainerBuilder $container)
  36.     {
  37.         // @phpstan-ignore-next-line
  38.         if (!$container->has('session')) {
  39.             return;
  40.         }
  42.         // @phpstan-ignore-next-line
  43.         if (!$container->has(SessionConfigurator::class)) {
  44.             return;
  45.         }
  47.         // configure the core session through our configurator service (mainly to register custom attribute bags)
  48.         $session = $container->findDefinition('session');
  50.         // just to make sure nobody else (symfony core, other bundle) sets a configurator and we overwrite it here
  51.         if ($session->getConfigurator()) {
  52.             throw new InvalidConfigurationException('The session service already defines a configurator.');
  53.         }
  55.         $session->setConfigurator([new Reference(SessionConfigurator::class), 'configure']);
  57.         $this->addTaggedConfigurators($container);
  58.     }
  60.     /**
  61.      * Finds all configurators tagged as pimcore.session.configurator and adds them to the configurator collection
  62.      *
  63.      * @param ContainerBuilder $container
  64.      */
  65.     protected function addTaggedConfigurators(ContainerBuilder $container)
  66.     {
  67.         $configurator = $container->getDefinition(SessionConfigurator::class);
  68.         $taggedServices = $container->findTaggedServiceIds('pimcore.session.configurator');
  70.         foreach ($taggedServices as $id => $tags) {
  71.             if (($tags[0]['type'] ?? null) !== 'internal') {
  72.                 trigger_deprecation('pimcore/pimcore', '10.5',
  73.                     sprintf('Implementation of %s is deprecated since version 10.5 and will be removed in Pimcore 11.' .
  74.                         'Implement the Event Listener instead.', SessionConfiguratorInterface::class));
  75.             }
  77.             $configurator->addMethodCall('addConfigurator', [new Reference($id)]);
  78.         }
  79.     }
  80. }