Add ability to configure default menu options

CHANGELOG.md

@@ -1,3 +1,5 @@
+* Added DefaultOptionsExtension
+
 ## 2.0.0 (2014-08-01)
 
 * Updated to KnpMenu 2 stable 

DependencyInjection/Configuration.php

@@ -24,6 +24,7 @@ public function getConfigTreeBuilder()
 
         $rootNode
             ->fixXmlConfig('provider')
+            ->fixXmlConfig('default_menu_option')
             ->children()
                 ->arrayNode('providers')
                     ->addDefaultsIfNotSet()
@@ -41,6 +42,11 @@ public function getConfigTreeBuilder()
                 ->end()
                 ->booleanNode('templating')->defaultFalse()->end()
                 ->scalarNode('default_renderer')->cannotBeEmpty()->defaultValue('twig')->end()
+                ->arrayNode('default_menu_options')
+                    ->useAttributeAsKey('name')
+                    ->normalizeKeys(false)
+                    ->prototype('scalar')->end()
+                ->end()
             ->end();
 
         return $treeBuilder;

DependencyInjection/KnpMenuExtension.php

@@ -38,6 +38,11 @@ public function load(array $configs, ContainerBuilder $container)
         }
 
         $container->setParameter('knp_menu.default_renderer', $config['default_renderer']);
+
+        if (isset($config['default_menu_options'])) {
+            $loader->load('options_extension.xml');
+            $container->setParameter('knp_menu.default_menu_options', $config['default_menu_options']);
+        }
     }
 
     public function getNamespace()

Extension/DefaultOptionsExtension.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Knp\Bundle\MenuBundle\Extension;
+
+use Knp\Menu\Factory\ExtensionInterface;
+use Knp\Menu\ItemInterface;
+
+/**
+ * An extension to configure the default menu options.
+ *
+ * @author Wouter J <wouter@wouterj.nl>
+ */
+class DefaultOptionsExtension implements ExtensionInterface
+{
+    /**
+     * @var array
+     */
+    private $options;
+
+    public function __construct(array $options)
+    {
+        $this->options = $options;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function buildOptions(array $options = array())
+    {
+        return array_merge($this->options, $options);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function buildItem(ItemInterface $item, array $options)
+    {
+    }
+}

Resources/config/options_extension.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="knp_menu.extension.default_options" class="Knp\Bundle\MenuBundle\Extension\DefaultOptionsExtension">
+            <tag name="knp_menu.factory_extension" />
+            <argument>%knp_menu.default_menu_options%</argument>
+        </service>
+    </services>
+
+</container>

Resources/doc/index.rst

@@ -302,6 +302,7 @@ More Advanced Stuff
 * :doc:`Custom Menu Provider <custom_provider>`
 * :doc:`I18n for your menu labels <i18n>`
 * :doc:`Using events to allow extending the menu <events>`
+* :doc:`Setting Default Menu Options <menu_options>`
 
 .. _`installation chapter`: https://getcomposer.org/doc/00-intro.md
 .. _`KnpMenu documentation`: https://github.com/KnpLabs/KnpMenu/blob/master/doc/01-Basic-Menus.markdown

Resources/doc/menu_options.rst

@@ -0,0 +1,45 @@
+Setting Default Menu Options
+============================
+
+When creating a menu, menu options are set by passing them to ``addChild()``.
+When all menu items need the same option, adding the same options to each child
+can be cumbersome.
+
+In these cases, you can configure the menu options in the configuration file:
+
+.. configuration-block::
+
+    .. code-block:: yaml
+
+        # app/config/config.yml
+        knp_menu:
+            default_menu_options:
+                class: menu-item
+
+    .. code-block:: xml
+
+        <!-- app/config/config.xml -->
+        <?xml version="1.0" encoding="UTF-8" ?>
+        <container xmlns="http://symfony.com/schema/dic/services"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-Instance"
+            xsi:schemaLocation="http://symfony.com/schema/dic/services
+                http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+            <config xmlns="http://knplabs.com/schema/dic/menu">
+                <default-menu-option name="class">menu-item</default-menu-option>
+            </config>
+        </container>
+
+    .. code-block:: php
+
+        // app/config/config.php
+        $container->loadFromExtension('knp_menu', array(
+            'default_menu_options' => array(
+                'class' => 'menu-item',
+            ),
+        ));
+
+These options are overriden by options that are explicitely passed to the menu item::
+
+    // ...
+    $menu->addChild('Home', array('class' => 'menu-item menu-item-home'));

Tests/DependencyInjection/KnpMenuExtensionTest.php

@@ -72,4 +72,13 @@ public function testDisableContainerAwareProvider()
         $this->assertTrue($container->getDefinition('knp_menu.menu_provider.builder_alias')->hasTag('knp_menu.provider'), 'The BuilderAliasProvider is enabled');
         $this->assertFalse($container->getDefinition('knp_menu.menu_provider.container_aware')->hasTag('knp_menu.provider'), 'The ContainerAwareProvider is disabled');
     }
+
+    public function testConfigureDefaultMenuOptions()
+    {
+        $container = new ContainerBuilder();
+        $loader = new KnpMenuExtension();
+        $loader->load(array(array('default_menu_options' => array('displayChildren' => false))), $container);
+        $this->assertEquals(array('displayChildren' => false), $container->getParameter('knp_menu.default_menu_options'));
+        $this->assertTrue($container->hasDefinition('knp_menu.extension.default_options'));
+    }
 }

Tests/Extension/DefaultOptionsExtensionTest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Knp\Bundle\MenuBundle\Tests\Extension;
+
+use Knp\Bundle\MenuBundle\Extension\DefaultOptionsExtension;
+
+class DefaultOptionsExtensionTest extends \PHPUnit_Framework_TestCase
+{
+    public function testSetsDefaultOptions()
+    {
+        $extension = new DefaultOptionsExtension(array(
+            'attributes' => array('class' => 'menu-item'),
+            'displayChildren' => false,
+        ));
+
+        $this->assertEquals(array(
+            'attributes' => array('class' => 'menu-item'),
+            'displayChildren' => false,
+        ), $extension->buildOptions());
+    }
+
+    public function testExplicitelyPassedOptionsOverwriteConfiguredDefaults()
+    {
+        $extension = new DefaultOptionsExtension(array(
+            'attributes' => array('class' => 'menu-item'),
+            'displayChildren' => false,
+        ));
+
+        $this->assertEquals(array(
+            'attributes' => array('class' => 'menu-item'),
+            'displayChildren' => true,
+        ), $extension->buildOptions(array('displayChildren' => true)));
+    }
+}