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

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