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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Sonata Project package.
  5.  *
  6.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  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 Sonata\BlockBundle\DependencyInjection\Compiler;
  14. use Sonata\BlockBundle\Naming\ConvertFromFqcn;
  15. use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
  16. use Symfony\Component\DependencyInjection\ContainerBuilder;
  17. use Symfony\Component\DependencyInjection\Definition;
  18. use Symfony\Component\DependencyInjection\Reference;
  20. /**
  21.  * Link the block service to the Page Manager.
  22.  *
  23.  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  24.  */
  25. class TweakCompilerPass implements CompilerPassInterface
  26. {
  27.     /**
  28.      * {@inheritdoc}
  29.      */
  30.     public function process(ContainerBuilder $container)
  31.     {
  32.         $manager = $container->getDefinition('sonata.block.manager');
  33.         $registry = $container->getDefinition('sonata.block.menu.registry');
  35.         $parameters = $container->getParameter('sonata_block.blocks');
  37.         $blockTypes = $container->getParameter('sonata_blocks.block_types');
  39.         foreach ($container->findTaggedServiceIds('sonata.block') as $id => $tags) {
  40.             $definition = $container->getDefinition($id);
  41.             $definition->setPublic(true);
  43.             if (!$definition->isAutowired()) {
  44.                 $this->replaceBlockName($container, $definition, $id);
  45.             }
  47.             $blockId = $id;
  49.             // Only convert class service names
  50.             if (false !== strpos($blockId, '\\')) {
  51.                 $convert = (new ConvertFromFqcn());
  52.                 $blockId = $convert($blockId);
  53.             }
  55.             // Skip manual defined blocks
  56.             if (!isset($blockTypes[$blockId])) {
  57.                 $contexts = $this->getContextFromTags($tags);
  58.                 $blockTypes[$blockId] = [
  59.                     'context' => $contexts,
  60.                 ];
  61.             }
  63.             $manager->addMethodCall('add', [$id, $id, isset($parameters[$id]) ? $parameters[$id]['contexts'] : []]);
  64.         }
  66.         foreach ($container->findTaggedServiceIds('knp_menu.menu') as $id => $tags) {
  67.             foreach ($tags as $attributes) {
  68.                 if (empty($attributes['alias'])) {
  69.                     throw new \InvalidArgumentException(sprintf('The alias is not defined in the "knp_menu.menu" tag for the service "%s"', $id));
  70.                 }
  71.                 $registry->addMethodCall('add', [$attributes['alias']]);
  72.             }
  73.         }
  75.         $services = [];
  76.         foreach ($container->findTaggedServiceIds('sonata.block.loader') as $id => $tags) {
  77.             $services[] = new Reference($id);
  78.         }
  80.         $container->getDefinition('sonata.block.loader.service')->replaceArgument(0, $blockTypes);
  81.         $container->getDefinition('sonata.block.loader.chain')->replaceArgument(0, $services);
  83.         $this->applyContext($container);
  84.     }
  86.     /**
  87.      * Apply configurations to the context manager.
  88.      *
  89.      * @param ContainerBuilder $container
  90.      */
  91.     public function applyContext(ContainerBuilder $container)
  92.     {
  93.         $definition = $container->findDefinition('sonata.block.context_manager');
  95.         foreach ($container->getParameter('sonata_block.blocks') as $service => $settings) {
  96.             if (\count($settings['settings']) > 0) {
  97.                 $definition->addMethodCall('addSettingsByType', [$service, $settings['settings'], true]);
  98.             }
  99.         }
  100.         foreach ($container->getParameter('sonata_block.blocks_by_class') as $class => $settings) {
  101.             if (\count($settings['settings']) > 0) {
  102.                 $definition->addMethodCall('addSettingsByClass', [$class, $settings['settings'], true]);
  103.             }
  104.         }
  105.     }
  107.     /**
  108.      * Replaces the empty service name with the service id.
  109.      */
  110.     private function replaceBlockName(ContainerBuilder $container, Definition $definition, $id)
  111.     {
  112.         $arguments = $definition->getArguments();
  114.         // Replace empty block id with service id
  115.         if (empty($arguments) || 0 == \strlen($arguments[0])) {
  116.             // NEXT_MAJOR: Remove the if block when Symfony 2.8 support will be dropped.
  117.             if (method_exists($definition, 'setArgument')) {
  118.                 $definition->setArgument(0, $id);
  120.                 return;
  121.             }
  123.             $definition->replaceArgument(0, $id);
  125.             return;
  126.         }
  128.         if ($id != $arguments[0] && 0 !== strpos(
  129.             $container->getParameterBag()->resolveValue($definition->getClass()),
  130.             'Sonata\\BlockBundle\\Block\\Service\\'
  131.         )) {
  132.             // NEXT_MAJOR: Remove deprecation notice
  133.             @trigger_error(
  134.                 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]),
  135.                 E_USER_DEPRECATED
  136.             );
  137.         }
  138.     }
  140.     /**
  141.      * @param string[][]
  142.      *
  143.      * @return string[]
  144.      */
  145.     private function getContextFromTags(array $tags)
  146.     {
  147.         return array_filter(array_map(function (array $attribute) {
  148.             if (array_key_exists('context', $attribute) && \is_string($attribute['context'])) {
  149.                 return $attribute['context'];
  150.             }
  152.             return null;
  153.         }, $tags));
  154.     }
  155. }