Merge pull request #414 from garak/deprecate-option

deprecate "container_aware" option
KnpLabs · Sep 19, 2019 · cd22849 · cd22849
2 parents 791e803 + 66d54e1
commit cd22849
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -34,8 +34,8 @@ public function getConfigTreeBuilder()
                     ->addDefaultsIfNotSet()
                     ->children()
                         ->booleanNode('builder_alias')->defaultTrue()->end()
-                        ->booleanNode('container_aware')->defaultTrue()->end()
-                        ->booleanNode('builder_service')->defaultTrue()->end()
+                        ->booleanNode('container_aware')->setDeprecated('The "%node%" option is deprecated and will be removed in version 3.')->defaultTrue()->end()
+                        ->booleanNode('builder_service')->setDeprecated('The "%node%" option is deprecated and will be removed in version 3.')->defaultTrue()->end()
                     ->end()
                 ->end()
                 ->arrayNode('twig')

diff --git a/src/Resources/doc/disabling_providers.rst b/src/Resources/doc/disabling_providers.rst
@@ -14,8 +14,8 @@ configuration:
     knp_menu:
         providers:
             builder_alias: false    # disable the builder-alias-based provider
-            builder_service: false
-            container_aware: true   # keep this one enabled. Can be omitted as it is the default
+            builder_service: false  # this option is deprecated
+            container_aware: true   # this option is deprecated
 
 .. note::
 

diff --git a/tests/DependencyInjection/KnpMenuExtensionTest.php b/tests/DependencyInjection/KnpMenuExtensionTest.php
@@ -65,6 +65,9 @@ public function testDisableBuilderAliasProvider()
         $this->assertTrue($container->getDefinition('knp_menu.menu_provider.container_aware')->hasTag('knp_menu.provider'), 'The ContainerAwareProvider is enabled');
     }
 
+    /**
+     * @group legacy
+     */
     public function testDisableContainerAwareProvider()
     {
         $container = new ContainerBuilder();