Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Menu widget active with Closure #19060 #19061

Merged
merged 6 commits into from
Oct 20, 2023
Merged

Menu widget active with Closure #19060 #19061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
126086f
Menu widget active with Closure #19060
atrandafir Dec 4, 2021
de5f689
Merge branch 'yiisoft:master' into master
atrandafir Aug 19, 2023
a022c9e
Adding tests for Menu widget https://github.com/yiisoft/yii2/issues/1…
atrandafir Aug 26, 2023
3145d91
Updating CHANGELOG https://github.com/yiisoft/yii2/issues/19060
atrandafir Aug 26, 2023
9258369
Merge branch 'master' into master
samdark Oct 19, 2023
f034274
Update MenuTest.php
bizley Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions framework/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Yii Framework 2 Change Log
2.0.50 under development
------------------------

- Bug #19060: Fix `yii\widgets\Menu` bug when using Closure for active item and adding additional tests in `tests\framework\widgets\MenuTest` (atrandafir)
- Bug #13920: Fixed erroneous validation for specific cases (tim-fischer-maschinensucher)
- Bug #19927: Fixed `console\controllers\MessageController` when saving translations to database: fixed FK error when adding new string and language at the same time, checking/regenerating all missing messages and dropping messages for unused languages (atrandafir)
- Enh #12743: Added new methods `BaseActiveRecord::loadRelations()` and `BaseActiveRecord::loadRelationsFor()` to eager load related models for existing primary model instances (PowerGamer1)
Expand Down
6 changes: 5 additions & 1 deletion framework/widgets/Menu.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,11 @@
$items[$i]['active'] = false;
}
} elseif ($item['active'] instanceof Closure) {
$active = $items[$i]['active'] = call_user_func($item['active'], $item, $hasActiveChild, $this->isItemActive($item), $this);
if (call_user_func($item['active'], $item, $hasActiveChild, $this->isItemActive($item), $this)) {
$active = $items[$i]['active'] = true;
} else {

Check warning on line 288 in framework/widgets/Menu.php

View check run for this annotation

Codecov / codecov/patch

framework/widgets/Menu.php#L288 

Added line #L288 was not covered by tests
$items[$i]['active'] = false;
}

Check warning on line 290 in framework/widgets/Menu.php

View check run for this annotation

Codecov / codecov/patch

framework/widgets/Menu.php#L290 

Added line #L290 was not covered by tests
} elseif ($item['active']) {
$active = true;
}
Expand Down
181 changes: 177 additions & 4 deletions tests/framework/widgets/MenuTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,14 @@ class MenuTest extends \yiiunit\TestCase
protected function setUp()
{
parent::setUp();
$this->mockApplication();
$this->mockWebApplication([
'components'=>[
'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
],
],
]);
}

public function testEncodeLabel()
Expand Down Expand Up @@ -201,6 +208,149 @@ public function testActiveItemClosure()
$this->assertEqualsWithoutLE($expected, $output);
}

public function testActiveItemClosureWithLogic()
{
$output = Menu::widget([
'route' => 'test/logic',
'params' => [],
'linkTemplate' => '',
'labelTemplate' => '',
'items' => [
[
'label' => 'logic item',
'url' => 'test/logic',
'template' => 'label: {label}; url: {url}',
'active' => function ($item, $hasActiveChild, $isItemActive, $widget) {
return $widget->route === 'test/logic';
},
],
[
'label' => 'another item',
'url' => 'test/another',
'template' => 'label: {label}; url: {url}',
]
],
]);

$expected = <<<'HTML'
<ul><li class="active">label: logic item; url: test/logic</li>
<li>label: another item; url: test/another</li></ul>
HTML;

$this->assertEqualsWithoutLE($expected, $output);
}

public function testActiveItemClosureWithLogicParent()
{
$output = Menu::widget([
'route' => 'test/logic',
'params' => [],
'linkTemplate' => '',
'labelTemplate' => '',
'activateParents' => true,
'items' => [
[
'label' => 'Home',
'url' => 'test/home',
'template' => 'label: {label}; url: {url}',
],
[
'label' => 'About',
'url' => 'test/about',
'template' => 'label: {label}; url: {url}',
],
[
'label' => 'Parent',
'items' => [
[
'label' => 'logic item',
'url' => 'test/logic',
'template' => 'label: {label}; url: {url}',
'active' => function ($item, $hasActiveChild, $isItemActive, $widget) {
return $widget->route === 'test/logic';
},
],
[
'label' => 'another item',
'url' => 'test/another',
'template' => 'label: {label}; url: {url}',
]
],
],
],
]);

$expected = <<<'HTML'
<ul><li>label: Home; url: test/home</li>
<li>label: About; url: test/about</li>
<li class="active">
<ul>
<li class="active">label: logic item; url: test/logic</li>
<li>label: another item; url: test/another</li>
</ul>
</li></ul>
HTML;

$this->assertEqualsWithoutLE($expected, $output);
}

public function testActiveItemClosureParentAnotherItem()
{
/** @see https://github.com/yiisoft/yii2/issues/19060 */
$output = Menu::widget([
'route' => 'test/another',
'params' => [],
'linkTemplate' => '',
'labelTemplate' => '',
'activateParents' => true,
'items' => [
[
'label' => 'Home',
'url' => 'test/home',
'template' => 'label: {label}; url: {url}',
],
[
'label' => 'About',
'url' => 'test/about',
'template' => 'label: {label}; url: {url}',
],
[
'label' => 'Parent',
'items' => [
[
'label' => 'another item',
// use non relative route to avoid error in BaseUrl::normalizeRoute (missing controller)
'url' => ['/test/another'],
'template' => 'label: {label}; url: {url}',
],
[
'label' => 'logic item',
'url' => 'test/logic',
'template' => 'label: {label}; url: {url}',
'active' => function ($item, $hasActiveChild, $isItemActive, $widget) {
return $widget->route === 'test/logic';
},
],

],
],
],
]);

$expected = <<<'HTML'
<ul><li>label: Home; url: test/home</li>
<li>label: About; url: test/about</li>
<li class="active">
<ul>
<li class="active">label: another item; url: /test/another</li>
<li>label: logic item; url: test/logic</li>
</ul>
</li></ul>
HTML;

$this->assertEqualsWithoutLE($expected, $output);
}

public function testItemClassAsArray()
{
$output = Menu::widget([
Expand Down Expand Up @@ -302,8 +452,31 @@ public function testItemClassAsString()
$this->assertEqualsWithoutLE($expected, $output);
}

/*public function testIsItemActive()
public function testIsItemActive()
{
// TODO: implement test of protected method isItemActive()
}*/
$output = Menu::widget([
'route' => 'test/item2',
'params' => [
'page'=>'5',
],
'items' => [
[
'label' => 'item1',
'url' => ['/test/item1']
],
[
'label' => 'item2',
// use non relative route to avoid error in BaseUrl::normalizeRoute (missing controller)
'url' => ['/test/item2','page'=>'5']
],

],
]);

$expected = <<<'HTML'
<ul><li><a href="/test/item1">item1</a></li>
<li class="active"><a href="/test/item2?page=5">item2</a></li></ul>
HTML;
$this->assertEqualsWithoutLE($expected, $output);
}
}
Loading