vendor/sonata-project/block-bundle/src/DependencyInjection/Compiler/TweakCompilerPass.php line 46

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 <[email protected]>
  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\DependencyInjection\Compiler;
  16. use Sonata\BlockBundle\Naming\ConvertFromFqcn;
  17. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  18. use Symfony\Component\DependencyInjection\ContainerBuilder;
  19. use Symfony\Component\DependencyInjection\Definition;
  20. use Symfony\Component\DependencyInjection\Reference;
  22. /**
  23.  * Link the block service to the Page Manager.
  24.  *
  25.  * @author Thomas Rabaix <[email protected]>
  26.  */
  27. class TweakCompilerPass implements CompilerPassInterface
  28. {
  29.     /**
  30.      * {@inheritdoc}
  31.      */
  32.     public function process(ContainerBuilder $container)
  33.     {
  34.         $manager = $container->getDefinition('sonata.block.manager');
  35.         $registry = $container->getDefinition('sonata.block.menu.registry');
  37.         $parameters = $container->getParameter('sonata_block.blocks');
  39.         $blockTypes = $container->getParameter('sonata_blocks.block_types');
  41.         foreach ($container->findTaggedServiceIds('sonata.block') as $id => $tags) {
  42.             $definition = $container->getDefinition($id);
  43.             $definition->setPublic(true);
  45.             if (!$definition->isAutowired()) {
  46.                 $this->replaceBlockName($container, $definition, $id);
  47.             }
  49.             $blockId = $id;
  51.             // Only convert class service names
  52.             if (false !== strpos($blockId, '\\')) {
  53.                 $convert = (new ConvertFromFqcn());
  54.                 $blockId = $convert($blockId);
  55.             }
  57.             // Skip manual defined blocks
  58.             if (!isset($blockTypes[$blockId])) {
  59.                 $contexts = $this->getContextFromTags($tags);
  60.                 $blockTypes[$blockId] = [
  61.                     'context' => $contexts,
  62.                 ];
  63.             }
  65.             $manager->addMethodCall('add', [$id, $id, isset($parameters[$id]) ? $parameters[$id]['contexts'] : []]);
  66.         }
  68.         foreach ($container->findTaggedServiceIds('knp_menu.menu') as $id => $tags) {
  69.             foreach ($tags as $attributes) {
  70.                 if (empty($attributes['alias'])) {
  71.                     throw new \InvalidArgumentException(sprintf('The alias is not defined in the "knp_menu.menu" tag for the service "%s"', $id));
  72.                 }
  73.                 $registry->addMethodCall('add', [$attributes['alias']]);
  74.             }
  75.         }
  77.         $services = [];
  78.         foreach ($container->findTaggedServiceIds('sonata.block.loader') as $id => $tags) {
  79.             $services[] = new Reference($id);
  80.         }
  82.         $container->getDefinition('sonata.block.loader.service')->replaceArgument(0, $blockTypes);
  83.         $container->getDefinition('sonata.block.loader.chain')->replaceArgument(0, $services);
  85.         $this->applyContext($container);
  86.     }
  88.     /**
  89.      * Apply configurations to the context manager.
  90.      *
  91.      * @param ContainerBuilder $container
  92.      */
  93.     public function applyContext(ContainerBuilder $container)
  94.     {
  95.         $definition = $container->findDefinition('sonata.block.context_manager');
  97.         foreach ($container->getParameter('sonata_block.blocks') as $service => $settings) {
  98.             if (\count($settings['settings']) > 0) {
  99.                 $definition->addMethodCall('addSettingsByType', [$service, $settings['settings'], true]);
  100.             }
  101.         }
  102.         foreach ($container->getParameter('sonata_block.blocks_by_class') as $class => $settings) {
  103.             if (\count($settings['settings']) > 0) {
  104.                 $definition->addMethodCall('addSettingsByClass', [$class, $settings['settings'], true]);
  105.             }
  106.         }
  107.     }
  109.     /**
  110.      * Replaces the empty service name with the service id.
  111.      */
  112.     private function replaceBlockName(ContainerBuilder $container, Definition $definition, $id)
  113.     {
  114.         $arguments = $definition->getArguments();
  116.         // Replace empty block id with service id
  117.         if ($this->serviceDefinitionNeedsFirstArgument($definition)) {
  118.             // NEXT_MAJOR: Remove the if block when Symfony 2.8 support will be dropped.
  119.             if (method_exists($definition, 'setArgument')) {
  120.                 $definition->setArgument(0, $id);
  122.                 return;
  123.             }
  125.             $definition->replaceArgument(0, $id);
  127.             return;
  128.         }
  130.         if ($id !== $arguments[0] && 0 !== strpos(
  131.             (string) $container->getParameterBag()->resolveValue($definition->getClass()),
  132.             'Sonata\\BlockBundle\\Block\\Service\\'
  133.         )) {
  134.             // NEXT_MAJOR: Remove deprecation notice
  135.             @trigger_error(
  136.                 sprintf('Using service id %s different from block id %s is deprecated since 3.3 and will be removed in 4.0.', $id, $arguments[0]),
  137.                 E_USER_DEPRECATED
  138.             );
  139.         }
  140.     }
  142.     private function serviceDefinitionNeedsFirstArgument(Definition $definition): bool
  143.     {
  144.         $arguments = $definition->getArguments();
  146.         return empty($arguments) ||
  147.             null === ($arguments[0]) ||
  148.             \is_string($arguments[0]) && 0 === \strlen($arguments[0]);
  149.     }
  151.     /**
  152.      * @param string[][]
  153.      *
  154.      * @return string[]
  155.      */
  156.     private function getContextFromTags(array $tags)
  157.     {
  158.         return array_filter(array_map(function (array $attribute) {
  159.             if (\array_key_exists('context', $attribute) && \is_string($attribute['context'])) {
  160.                 return $attribute['context'];
  161.             }
  163.             return null;
  164.         }, $tags));
  165.     }
  166. }