vendor/sonata-project/block-bundle/src/DependencyInjection/Configuration.php line 71

  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\DependencyInjection;
  16. use Symfony\Component\Config\Definition\BaseNode;
  17. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  18. use Symfony\Component\Config\Definition\ConfigurationInterface;
  19. use Symfony\Component\DependencyInjection\ContainerBuilder;
  21. /**
  22.  * This is the class that validates and merges configuration from your app/config files.
  23.  *
  24.  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html#cookbook-bundles-extension-config-class}
  25.  */
  26. final class Configuration implements ConfigurationInterface
  27. {
  28.     /**
  29.      * @var array<string, string>
  30.      */
  31.     private $defaultContainerTemplates;
  33.     /**
  34.      * NEXT_MAJOR: remove this member.
  35.      *
  36.      * @var bool
  37.      */
  38.     private $httpCacheDisabled = false;
  40.     /**
  41.      * @param array<string, string> $defaultContainerTemplates
  42.      */
  43.     public function __construct(array $defaultContainerTemplates)
  44.     {
  45.         $this->defaultContainerTemplates = $defaultContainerTemplates;
  46.     }
  48.     public function getConfigTreeBuilder(): TreeBuilder
  49.     {
  50.         $treeBuilder = new TreeBuilder('sonata_block');
  52.         $node = $treeBuilder->getRootNode();
  54.         $node
  55.             ->fixXmlConfig('default_context')
  56.             ->fixXmlConfig('template')
  57.             ->fixXmlConfig('block')
  58.             ->fixXmlConfig('block_by_class')
  59.             ->validate()
  60.                 ->always(function (&$value) {
  61.                     foreach ($value['blocks'] as &$block) {
  62.                         if (0 === \count($block['contexts'])) {
  63.                             $block['contexts'] = $value['default_contexts'];
  64.                         }
  65.                     }
  67.                     // NEXT_MAJOR: remove this block
  68.                     if (true !== $this->httpCacheDisabled) {
  69.                         @trigger_error(
  70.                             'Not setting the "sonata_block.http_cache" config option to false is deprecated since sonata-project/block-bundle 4.11 and will fail in 5.0.',
  71.                             \E_USER_DEPRECATED
  72.                         );
  73.                     } else {
  74.                         $value['http_cache'] = false;
  75.                     }
  77.                     return $value;
  78.                 })
  79.             ->end()
  80.             ->children()
  81.                 ->arrayNode('profiler')
  82.                     ->addDefaultsIfNotSet()
  83.                     ->children()
  84.                         ->scalarNode('enabled')->defaultValue('%kernel.debug%')->end()
  85.                         ->scalarNode('template')->defaultValue('@SonataBlock/Profiler/block.html.twig')->end()
  86.                     ->end()
  87.                 ->end()
  89.                 ->arrayNode('default_contexts')
  90.                     ->prototype('scalar')->end()
  91.                 ->end()
  93.                 ->scalarNode('context_manager')->defaultValue('sonata.block.context_manager.default')->end()
  94.                 // NEXT_MAJOR: deprecate option and only allow setting it to false
  95.                 ->arrayNode('http_cache')
  96.                     ->addDefaultsIfNotSet()
  97.                     ->beforeNormalization()
  98.                         ->always(function ($v) {
  99.                             if (false === $v) {
  100.                                 $this->httpCacheDisabled = true;
  102.                                 return [];
  103.                             }
  105.                             return $v;
  106.                         })
  107.                     ->end()
  108.                     ->children()
  109.                         // NEXT_MAJOR: remove option
  110.                         ->scalarNode('handler')->defaultValue('sonata.block.cache.handler.default')->end()
  111.                         // NEXT_MAJOR: remove option
  112.                         ->booleanNode('listener')->defaultTrue()->end()
  113.                     ->end()
  114.                 ->end()
  115.                 ->arrayNode('templates')
  116.                     ->addDefaultsIfNotSet()
  117.                     ->children()
  118.                         ->scalarNode('block_base')->defaultNull()->end()
  119.                         ->scalarNode('block_container')->defaultNull()->end()
  120.                     ->end()
  121.                 ->end()
  123.                 ->arrayNode('container')
  124.                     ->info('block container configuration')
  125.                     ->addDefaultsIfNotSet()
  126.                     ->fixXmlConfig('type', 'types')
  127.                     ->fixXmlConfig('template', 'templates')
  128.                     ->children()
  129.                         ->arrayNode('types')
  130.                             ->info('container service ids')
  131.                             ->isRequired()
  132.                             // add default value to well know users of BlockBundle
  133.                             ->defaultValue(['sonata.block.service.container', 'sonata.page.block.container', 'sonata.dashboard.block.container', 'cmf.block.container', 'cmf.block.slideshow'])
  134.                             ->prototype('scalar')->end()
  135.                         ->end()
  136.                         ->arrayNode('templates')
  137.                             ->info('container templates')
  138.                             ->isRequired()
  139.                             ->defaultValue($this->defaultContainerTemplates)
  140.                             ->prototype('scalar')->end()
  141.                         ->end()
  143.                     ->end()
  144.                 ->end()
  146.                 ->arrayNode('blocks')
  147.                     ->info('configuration per block service')
  148.                     ->useAttributeAsKey('id')
  149.                     ->prototype('array')
  150.                         ->fixXmlConfig('context')
  151.                         ->fixXmlConfig('template')
  152.                         ->fixXmlConfig('setting')
  153.                         ->children()
  154.                             ->arrayNode('contexts')
  155.                                 ->prototype('scalar')->end()
  156.                             ->end()
  157.                             ->arrayNode('templates')
  158.                                 ->prototype('array')
  159.                                     ->children()
  160.                                         ->scalarNode('name')->cannotBeEmpty()->end()
  161.                                         ->scalarNode('template')->cannotBeEmpty()->end()
  162.                                     ->end()
  163.                                 ->end()
  164.                             ->end()
  165.                             // NEXT_MAJOR: remove cache option
  166.                             ->scalarNode('cache')
  167.                                 ->defaultValue('sonata.cache.noop')
  168.                                 ->setDeprecated(
  169.                                     ...$this->getDeprecationMessage(
  170.                                         'The "cache" option for configuring blocks is deprecated since sonata-project/block-bundle 4.11 and will be removed in 5.0.',
  171.                                         '4.11'
  172.                                     )
  173.                                 )
  174.                             ->end()
  175.                             ->arrayNode('settings')
  176.                                 ->info('default settings')
  177.                                 ->useAttributeAsKey('id')
  178.                                 ->prototype('scalar')->end()
  179.                             ->end()
  180.                             ->arrayNode('exception')
  181.                                 ->children()
  182.                                     ->scalarNode('filter')->defaultNull()->end()
  183.                                     ->scalarNode('renderer')->defaultNull()->end()
  184.                                 ->end()
  185.                             ->end()
  186.                         ->end()
  187.                     ->end()
  188.                 ->end()
  190.                 ->arrayNode('blocks_by_class')
  191.                     ->info('configuration per block class')
  192.                     ->useAttributeAsKey('class')
  193.                     ->prototype('array')
  194.                         ->fixXmlConfig('setting')
  195.                         ->children()
  196.                             ->scalarNode('cache')
  197.                                 ->defaultValue('sonata.cache.noop')
  198.                                 ->setDeprecated(
  199.                                     ...$this->getDeprecationMessage(
  200.                                         'The "cache" option for configuring blocks_by_class is deprecated since sonata-project/block-bundle 4.11 and will be removed in 5.0.',
  201.                                         '4.11'
  202.                                     )
  203.                                 )
  204.                             ->end()
  205.                             ->arrayNode('settings')
  206.                                 ->info('default settings')
  207.                                 ->useAttributeAsKey('id')
  208.                                 ->prototype('scalar')->end()
  209.                             ->end()
  210.                         ->end()
  211.                     ->end()
  212.                 ->end()
  214.                 ->arrayNode('exception')
  215.                     ->addDefaultsIfNotSet()
  216.                     ->fixXmlConfig('filter')
  217.                     ->fixXmlConfig('renderer')
  218.                     ->children()
  219.                         ->arrayNode('default')
  220.                             ->addDefaultsIfNotSet()
  221.                             ->children()
  222.                                 ->scalarNode('filter')->defaultValue('debug_only')->end()
  223.                                 ->scalarNode('renderer')->defaultValue('throw')->end()
  224.                             ->end()
  225.                         ->end()
  227.                         ->arrayNode('filters')
  228.                             ->useAttributeAsKey('id')
  229.                             ->prototype('scalar')->end()
  230.                             ->defaultValue([
  231.                                 'debug_only' => 'sonata.block.exception.filter.debug_only',
  232.                                 'ignore_block_exception' => 'sonata.block.exception.filter.ignore_block_exception',
  233.                                 'keep_all' => 'sonata.block.exception.filter.keep_all',
  234.                                 'keep_none' => 'sonata.block.exception.filter.keep_none',
  235.                             ])
  236.                         ->end()
  237.                         ->arrayNode('renderers')
  238.                             ->useAttributeAsKey('id')
  239.                             ->prototype('scalar')->end()
  240.                             ->defaultValue([
  241.                                 'inline' => 'sonata.block.exception.renderer.inline',
  242.                                 'inline_debug' => 'sonata.block.exception.renderer.inline_debug',
  243.                                 'throw' => 'sonata.block.exception.renderer.throw',
  244.                             ])
  245.                         ->end()
  246.                     ->end()
  247.                 ->end()
  248.             ->end();
  250.         return $treeBuilder;
  251.     }
  253.     /**
  254.      * @param array<string, mixed> $config
  255.      *
  256.      * @return Configuration
  257.      */
  258.     public function getConfiguration(array $config, ContainerBuilder $container)
  259.     {
  260.         return new self([]);
  261.     }
  263.     /**
  264.      * @return string[]
  265.      */
  266.     private function getDeprecationMessage(string $message, string $version): array
  267.     {
  268.         // @phpstan-ignore-next-line
  269.         if (method_exists(BaseNode::class, 'getDeprecation')) {
  270.             return [
  271.                 'sonata-project/block-bundle',
  272.                 $version,
  273.                 $message,
  274.             ];
  275.         }
  277.         return [$message];
  278.     }
  279. }