Add a weight system to order items on the same branch

[Maxwell2022]

It would be great to add an optional weight for the items of the menu. This weight would be used when rendering the menu to order the items located in the same level of the tree.

I know that at the moment if I want an item at the end of the list I have to add it last. But it would simplify a lot of logic in the code if we could use a weight system.

ie. you want to display 5 menu items depending of the user role:

without weight system:

$root->addChild('menu.item1', array('route' => '_my_route1'));
$root->addChild('menu.item2', array('route' => '_my_route2'));

if ($security->isGranted('ROLE_A')) {
   $root->addChild('menu.item3', array('route' => '_my_route3'));
}

$root->addChild('menu.item4', array('route' => '_my_route4'));

if ($security->isGranted('ROLE_A')) {
    $root->addChild('menu.item5', array('route' => '_my_route5'));
}

with a weight system:

$root->addChild('menu.item1', array('route' => '_my_route1', 'weight' => 0));
$root->addChild('menu.item2', array('route' => '_my_route2', 'weight' => 10));
$root->addChild('menu.item4', array('route' => '_my_route4', 'weight' => 20));

if ($security->isGranted('ROLE_A')) {
   $root->addChild('menu.item3', array('route' => '_my_route3', 'weight' => 15));
   $root->addChild('menu.item5', array('route' => '_my_route5', 'weight' => 25));
}

I had a look to the options and could not find it so I guess it's not been implemented for now but I'll be happy to know that I'm wrong :)

Cheers,
Maxime

[Maxwell2022]

I'm guessing the tree is rendered recursively which mean we either need to sort the items before redering the branch or when we add the item in the menu directly. Any idea how it would be easier to manage this?

[asentner]

+1. Would like to order when using listeners.

[Nek-]

Oh and, actually i'm 👍 with this.

[franzose]

Hi all! Any news on the issue?

[franzose]

SOLUTION

$item->reorderChildren([
    'child_name_1',
    'child_name_2',
    'child_name_3',
    'child_name_4',
]);

[Maxwell2022]

I was looking for this for the last 4 years...

[franzose]

@Maxwell2022 I found that method occasionally) Array items are names you give to the menu's children.