This is a WIP about #24 meant for discussion.

This implementation uses the getBreadcrumbsArray method, making it easy to append additional stuff at the end of the breadcrumb. However, it means that you are limited when rendering each item as you only have the label and the uri. The other solution would be to build an array of items or to call getParent each time, but it would make it harder to pass additional paths as it would require building items for them (in this regards, an array of items would be easier than calling getParent during the rendering though as we don't need to add the new items in the existing menu tree).

To use it, you need to call the knp_menu_render method with the item corresponding to the end of the breadcrumbs, i.e. the item for which the breadcrumb is rendered (except the additional path of course). This is a good use case to get an item by path in the tree

Currently, the library still uses the behavior coming from KnpMenuBundle:

• an item can be set explicitly as being (or not being) current.
• if the flag is not set, the uri is checked against the current uri set for the item (and if there is no current uri, it is not a current item)

There is some improvements needed here:

• there can be multiple current items in a tree so the getCurrentItem method is lying by giving only the first found (should it be removed entirely ?)
• this part of the library should be more flexible to support other behaviors (for instance matching several uris on the same item)

No matter what level the current page is, I am displaying all the level 1 items across the top of the page, then all the level 2 items in a separate LHS col menu.

This doesn't seem to be straight forward as there is no helper to render a menu at a certain level, and no means to easily return e.g. the level 2 ancestor for the current page, in order to use this to create the menu.

Currently in order to achieve this, I am working up the provided breadCrumb array and testing for the level at each point, only rendering the LHS menu when I find the ancestor with the required level.

This is really messy in twig... clearly not the right way to go about it.

So I am wondering about whether to add methods to the menuItems class to return information regarding ancestors.

e.g. would it be useful to have

/**
 * @param int $level     The level of the ancestor to be returned
 * @return \Knp\Menu\ItemInterface
 */
public function getAncestor($level)
{
}

Any thoughts?

Is there already an accepted way to do this kind of thing?

Before the bundlle system deprecation, I used to do this:

{{ knp_menu_render('AppBundle:Builder:mainMenu') }}

But now that AppBundle doesn't exist anymore, how can I render the menu?

Obviously this syntax doesn't work...

I open this issue to separate the discussion about this point as I originally asked in #2 but it got a bit lost in the other part of the issue.

As mentioned previously in #2, this method is currently lying as it returns the first current item found whereas the tree could contain several item. So I see 3 solutions:

1. Forbid to have more than 1 current item. This would be quite hard to do in an efficient way and most people commenting on it previously thought it is valid to have several one.
2. Remove the method
3. Replace the method by a getCurrentItems method. This method would return an array containing all current items inside the tree of the item.

I personally think that the third option is not necessary. Implementing it using some PHP iterators would be probably more efficient as we would loop over the whole tree only when actually looping over the data instead of doing it first to create the array (and for people wanting an array absolutely, they could still use iterator_to_array).

So my personal vote would be 2

This is a first try to add phpstan. ~~Level is 6 for now, maybe we could increase it eventually. I'm not really happy with baseline, so I'm open to suggestion about it~~

The source Gist: https://gist.github.com/fsevestre/b378606c4fd23814278a

This PR add a new knp_menu_get_current_item(menu) Twig function which returns the current item of the menu provided as argument.

For example, this new Twig function can be used with the knp_menu_get_breadcrumbs_array Twig function to easily display the breadcrumb of the current page:

<ol class="breadcrumb">
{% for breadcrumb_item in knp_menu_get_breadcrumbs_array(knp_menu_get_current_item('main')) %}
    {% if not loop.last %}
    <li><a href="{{ breadcrumb_item.uri }}">{{ breadcrumb_item.label }}</a></li>
    {% else %}
    <li class="active">{{ breadcrumb_item.label }}</li>
    {% endif %}
{% endfor %}
</ol>

Hello!

The CMF project is working hard towards a new release, including support for KnpMenu(Bundle) 2. However, we missed lots of templating functions which were added by #189. This one is not yet included in a release and will be included in the 2.1 release. (https://github.com/KnpLabs/KnpMenuBundle/pull/251 needs to be merged as well)

We wonder if there is anything we can help with to make the 2.1 release a thing. Can you maybe create a list of issues/PRs that should be finished/fixed before you think a 2.1 release is ready? This way, we can help you preparing the release, as it's currently a big blocker for the next CMF release (releasing without KnpMenu 2 support isn't a option because of Sonata).

/cc @dbu @lsmith77

Fatal error: Call to undefined method Knp\Menu\MenuItem::setCurrentUri()

I can't find this method anymore. Something changed? Documentation says nothing. Or am I terribly wrong?

See #97.

Usage:

<?php

$factory = new MenuFactory();

$menu = $factory->createItem('My menu');
$menu->addChild('Home', array('uri' => '/', array('extras' => array('weight' => 10))));
$menu->addChild('Comments', array('uri' => '#comments'));
$menu->addChild('Symfony2', array('uri' => 'http://symfony-reloaded.org/'));
$menu->addChild('Coming soon', array('extras' => array('weight' => 10))));

$renderer = new SortingRenderer(new ListRenderer(new \Knp\Menu\Matcher\Matcher()), new MenuManipulator());
echo $renderer->render($menu);

Now some functions are moved from ItemInterface to utils and other classes, there is no way they can be used inside a template.

This PR adds back some functionality.

As we need this to finish our KnpMenu 2.0 update for the Symfony CMF project, can this please be reviewed and merged quickly and be included in a new minor version?

Currently when creating a RecursiveItemIterator passing a new ArrayIterator, the Iterator is indexed by int.

$treeIterator = new \RecursiveIteratorIterator(
            new RecursiveItemIterator(
                new \ArrayIterator(array($menu))
            ), \RecursiveIteratorIterator::SELF_FIRST
        );

So we got the following error:

Parameter #1 $iterator of class Knp\Menu\Iterator\RecursiveItemIterator constructor expects
Traversable<string, Knp\Menu\ItemInterface>, ArrayIterator<int, Knp\Menu\ItemInterface> given.

I can notice that the typehint in CurrentItemFilterIterator is ok: https://github.com/KnpLabs/KnpMenu/blob/master/src/Knp/Menu/Iterator/CurrentItemFilterIterator.php

Most common thing to do after utilising KnpMenu, is overriding the template, I believe we can overcome this step by providing some config in a yaml file for example

knp_menu:
  menu_class: 'navbar-nav me-auto mb-2 mb-lg-0'
  menu_item_class: 'nav-item'
  menu_item_link_class: 'nav-link'
  current_class: 'active'
  current_class_on_link: true  

I'd be willing to put some time in this effort with some direction, I lack the confidence in providing a solution like this :)

Children items sets by \Knp\Menu\MenuItem::setChildren setter does not have parent properly set. This issue does not occur in \Knp\Menu\MenuItem::addChild.

In every project I use this library, I find myself adding a template of mine to render with Bootstrap 4. I think it could nice to provide here templates for major CSS vendors (Bootstrap, Foundation, etc.), just like Symfony is doing for its form themes.

I am using the ListRenderer to create a table of contents for a webpage (actually I use https://github.com/caseyamcl/toc and th OrderedListRenderer).

Using some CSS pseudo elements, I am able to get hierarical numbering dynamically:

<style>
		ol {
			list-style-type: none;
			counter-reset: item;
			margin: 0;
			padding: 0;
		}
		ol > li {
			display: table;
			counter-increment: item;
			margin-bottom: 0.6em;
		}
		ol > li:before {
			content: counters(item, ".") ". ";
			display: table-cell;
			padding-right: 0.6em;
		}
		li ol > li {
			margin: 0;
		}
		li ol > li:before {
			content: counters(item, ".") " ";
		}

Gives something like:

But would it be possible to compute and render these "addresses" and set them as value attribute in the created list? Like here https://www.w3schools.com/tags/att_li_value.asp

<li value="2.1">Übersicht</li>

Thanks in advance! Stay healty!