README

在 Laravel 6 中快速轻松地创建菜单

对于 Laravel 4.x，请查看版本 1.5.0

文档

安装
入门
路由
- URLs
- 命名路由
- 控制器操作
- HTTPS
子项
手动设置项目的 ID
手动设置项目的昵称
引用项目
- 通过标题获取项目
- 通过 ID 获取项目
- 获取所有项目
- 获取第一个项目
- 获取最后一个项目
- 获取活动项目
- 获取项目的子项
- 获取项目的父项
- 魔法 Where 方法
引用菜单对象
HTML 属性
操作链接
- 链接的 Href 属性
活动项目
- RESTful URL
- URL 通配符
- 禁用激活
插入分隔符
追加和预置
在前后添加
原始项目
菜单组
URL 前缀
嵌套组
元数据
过滤项目
排序项目
渲染方法
- 菜单作为无序列表
- 菜单作为有序列表
- 菜单作为 Div
- 菜单作为 Bootstrap 3 Navbar
- 为子项添加类属性
子集菜单
- 顶部菜单
- 子菜单
- 同级菜单
- 面包屑菜单
高级用法
- 基本示例
- Blade 控制结构
  - @lm_attrs
- 项目的属性和回调函数
配置
如需帮助
贡献
许可证

安装

composer require lavary/laravel-menu

如果你在 Laravel 5.5 中，你不需要编辑你的 config/app.php，如果你在 Laravel 的早期版本中，请按照以下步骤操作

将 Laravel Menu 服务提供者添加到 providers 数组中的 config/app.php。

'providers' => [

        /*
         * Laravel Framework Service Providers...
         */
        Illuminate\Foundation\Providers\ArtisanServiceProvider::class,
        Illuminate\Auth\AuthServiceProvider::class,
        Illuminate\Broadcasting\BroadcastServiceProvider::class,

    ...

        Lavary\Menu\ServiceProvider::class,

        ...

],

在 config/app.php 的末尾添加 'Menu' => Lavary\Menu\Facade::class 到 $aliases 数组

'aliases' => [

    'App'       => Illuminate\Support\Facades\App::class,
    'Artisan'   => Illuminate\Support\Facades\Artisan::class,
    ...
    'Menu'      => Lavary\Menu\Facade::class,

],

这将在 Laravel 中注册包并创建一个名为 Menu 的别名。

要使用自己的设置，请发布配置。

php artisan vendor:publish --provider="Lavary\Menu\ServiceProvider"

入门

您可以在 laravel 中间件内定义菜单定义。结果，每次请求击中您的应用程序时，菜单对象都将可用于所有视图。

php artisan make:middleware GenerateMenus

请确保还将中间件添加到 app\Http\Kernel.php

    protected $middlewareGroups = [
        'web' => [
            //...
            \App\Http\Middleware\GenerateMenus::class,
        ],
        //...
    ];

打开您刚刚创建的中间件 app\Http\Middleware\GenerateMenus.php

然后添加一个基本的菜单声明。例如

public function handle($request, Closure $next)
{
    \Menu::make('MyNavBar', function ($menu) {
        $menu->add('Home');
        $menu->add('About', 'about');
        $menu->add('Services', 'services');
        $menu->add('Contact', 'contact');
    });

    return $next($request);
}

最后，打开一个视图并添加

{!! $MyNavBar->asUl() !!}

您的菜单将被创建并在页面上显示。

注意： $MyNavBar 是这些示例中使用的假设名称；您可以为菜单命名任何您想要的。

在上面的示例中，Menu::make() 创建了一个名为 MyNavBar 的菜单，将菜单实例添加到 Menu::collection 中，最终使 $myNavBar 对象可用于所有应用视图。

此方法接受一个可调用的函数，您可以在其中定义菜单项。 add 方法定义了一个新项目。它接收两个参数，第一个是项目标题，第二个是选项。

第二个参数，options，可以是一个表示URL的简单字符串，或者是一个包含选项和HTML属性的关联数组，我们将在稍后讨论。

您可以使用Menu::exists()来检查菜单是否已存在。

Menu::exists('primary'); // returns false
Menu::make('primary', function(){});
Menu::exists('primary'); // returns true

您可以使用Menu::makeOnce()来确保仅在给定的菜单名称不存在时调用创建回调。这在您需要在多个位置有条件地创建相同的菜单，且不确定其他条件是否已导致菜单创建的情况下非常有用。

Menu::makeOnce('primary', function(){}); // Creates primary, and executes callback.
Menu::makeOnce('primary', function(){}); // No operation.

要在视图中渲染菜单

Laravel-menu提供了三种内置渲染方法。然而，您可以使用正确的方法和属性创建自己的渲染方法。

如前所述，laravel-menu提供了三种内置渲染格式，asUl()、asOl()和asDiv()。您可以在此处了解详细信息这里。

{!! $MyNavBar->asUl() !!}

您还可以通过菜单集合访问菜单对象

{!! Menu::get('MyNavBar')->asUl() !!}

这将按如下方式渲染您的菜单

<ul>
  <li><a href="http://yourdomain.com">Home</a></li>
  <li><a href="http://yourdomain.com/about">About</a></li>
  <li><a href="http://yourdomain.com/services">Services</a></li>
  <li><a href="http://yourdomain.com/contact">Contact</a></li>
</ul>

这就全部了！

路由

URLs

您可以通过将URL作为add方法的第二个参数传递，简单地分配一个URL给菜单项

$menu->add('About Us', 'about-us');

命名路由

laravel-menu也支持命名路由

这次，我们不是将简单字符串传递给add()，而是传递一个包含键route和命名路由作为值的关联数组

// Suppose we have these routes defined in our app/routes.php file

//...
Route::get('/',        ['as' => 'home.page',  function(){...}]);
Route::get('about',    ['as' => 'page.about', function(){...}]);
//...

// Now we make the menu:

Menu::make('MyNavBar', function($menu){

  $menu->add('Home',     ['route'  => 'home.page']);
  $menu->add('About',    ['route'  => 'page.about']);

});

控制器操作

Laravel菜单也支持控制器操作。

您只需将选项数组的action键设置为控制器操作即可

假设我们已在routes/web.php或较老的app/Http/routes.php文件中定义了以下路由

Route::get('services', 'ServiceController@index');

然后，为了引用此路由，我们可以将操作传递到选项数组中。

$menu->add('services', ['action' => 'ServicesController@index']);

此外：如果您需要将某些参数作为查询字符串发送到路由、URL或控制器操作，您只需将它们包含在一个数组中，并与路由、操作或URL值一起传递即可

Menu::make('MyNavBar', function($menu){

  $menu->add('Home',     ['route'  => 'home.page']);
  $menu->add('About',    ['route'  => ['page.about', 'template' => 1]]);
  $menu->add('services', ['action' => ['ServicesController@index', 'id' => 12]]);

  $menu->add('Contact',  'contact');

});

HTTPS

默认情况下，HTTP与HTTPS将由Laravel的UrlGenerator确定，以匹配页面的当前模式。

如果您需要覆盖此行为，请在项目的link属性上调用secure()以强制使用https。或者，将secure键添加到选项数组中，并将其设置为true

$menu->add('Members', 'members')->link->secure();


// or alternatively use the following method

$menu->add('Members', ['url' => 'members', 'secure' => true]);

输出为<ul>将如下

<ul>
    ...
    <li><a href="https://yourdomain.com/members">Members</a></li>
    ...
</ul>

子项

项也可以有子项

Menu::make('MyNavBar', function($menu){

  //...

  $menu->add('About',    ['route'  => 'page.about']);

  // these items will go under Item 'About'

  // refer to about as a property of $menu object then call `add()` on it
  $menu->about->add('Who We are', 'who-we-are');

  // or

  $menu->get('about')->add('What We Do', 'what-we-do');

  // or

  $menu->item('about')->add('Our Goals', 'our-goals');

  //...

});

您也可以链式调用项定义，并深入到您想要的程度

  $menu->add('About', ['route'  => 'page.about'])
       ->add('Level2', 'link address')
       ->add('level3', 'Link address')
       ->add('level4', 'Link address');

您可以使用parent属性直接添加子项

$menu->add('About',    ['route'  => 'page.about']);
$menu->add('Level2', ['url' => 'Link address', 'parent' => $menu->about->id]);

手动设置项的ID

当您添加一个新项时，会自动分配一个唯一的ID给该项。然而，有时您从数据库加载数据并必须手动设置ID。为了处理这种情况，您可以对项的对象调用id()方法并传递您想要的ID

$menu->add('About', ['route' => 'page.about'])
     ->id('74398247329487')

或者，您可以在添加菜单项时将ID作为选项数组的元素传递

$menu->add('About', ['route' => 'page.about', 'id' => 74398247329487]);

手动设置项的昵称

当您添加一个新项时，会自动分配一个昵称供进一步引用。此昵称是项标题的驼峰式形式。例如，标题为About Us的项将具有昵称：aboutUs。然而，有时您需要显式定义您的菜单项，因为您正在使用特殊字符集。为此，您可以使用项的对象的nickname()方法并将您想要的昵称传递给它

$menu->add('About', ['route' => 'page.about'])
     ->nickname('about_menu_nickname');

// And use it like you normally would
$menu->item('about_menu_nickname');

或者，您可以将昵称作为选项数组的元素传递

$menu->add('About', ['route' => 'page.about', 'nickname' => 'about_menu_nickname']);

// And use it like you normally would
$menu->item('about_menu_nickname');

引用项目

您可以使用下面描述的方法在您的代码中访问定义的项。

通过标题获取项目

使用$menu后跟项的标题（驼峰式）

$menu->itemTitleInCamelCase

// or

$menu->get('itemTitleInCamelCase')

// or

$menu->item('itemTitleInCamelCase')

例如，让我们在定义了About us项之后，在该项后插入一个分隔符

$menu->add('About us', 'about-us')

$menu->aboutUs->divide();

// or

$menu->get('aboutUs')->divide();

// or

$menu->item('aboutUs')->divide();

如果您不熟悉上述方法，您可以将项的对象引用存储在变量中以供进一步引用

$about = $menu->add('About', 'about');
$about->add('Who We Are', 'who-we-are');
$about->add('What We Do', 'what-we-do');

通过ID获取项

如果需要，您也可以通过ID获取项

$menu->add('About', ['url' => 'about', 'id' => 12]);

$about = $menu->find(12)

获取所有项目

$menu->all();

// or outside of the builder context

Menu::get('MyNavBar')->all();

all() 方法返回一个 Laravel 集合。

获取第一个项目

$menu->first();

// or outside of the builder context

Menu::get('MyNavBar')->first();

获取最后一个项目

$menu->last();

// or outside of the builder context

Menu::get('MyNavBar')->last();

获取活动项目

$menu->active()

// or outside of the builder content

Menu::get('MyNavBar')->active();

获取项目的子项

首先，您需要使用上述方法之一获取项目，然后调用它的 children()。

获取 关于 项目的子项

$aboutSubs = $menu->about->children();

// or outside of the builder context

$aboutSubs = Menu::get('MyNavBar')->about->children();

// or

$aboutSubs = Menu::get('MyNavBar')->item('about')->children();

children() 返回一个 Laravel 集合。

要检查一个项目是否有子项，可以使用 hasChildren()

if( $menu->about->hasChildren() ) {
    // Do something
}

// or outside of the builder context

Menu::get('MyNavBar')->about->hasChildren();

// Or

Menu::get('MyNavBar')->item('about')->hasChildren();

要获取一个项目的所有后代，可以使用 all

$aboutSubs = $menu->about->all();

获取项目的父项

首先使用上述方法之一获取项目，然后调用它的 parent()。

获取 关于 项目的父项

$aboutParent = $menu->about->parent();

// or outside of the builder context

$aboutParent = Menu::get('MyNavBar')->about->parent();

// Or

$aboutParent = Menu::get('MyNavBar')->item('about')->parent();

要检查一个项目是否有父项，可以使用 hasParent()

if( $menu->about->hasParent() ) {
    // Do something
}

// or outside of the builder context

Menu::get('MyNavBar')->about->hasParent();

// Or

Menu::get('MyNavBar')->item('about')->hasParent();

魔法 Where 方法

您还可以通过魔法位置方法搜索项目集合。这些方法是由一个 where 与属性（对象属性或元数据）连接而成的

例如，要获取父项等于 12 的项目，可以这样使用它

$subs = $menu->whereParent(12);

或者要获取具有特定元数据的项目

$menu->add('Home',     '#')->data('color', 'red');
$menu->add('About',    '#')->data('color', 'blue');
$menu->add('Services', '#')->data('color', 'red');
$menu->add('Contact',  '#')->data('color', 'green');

// Fetch all the items with color set to red:
$reds = $menu->whereColor('red');

此方法返回一个 Laravel 集合。

如果您还需要获取匹配项的后代，只需将第二个参数设置为 true。

$reds = $menu->whereColor('red', true);

这将给出所有具有红色颜色及其后代的项目。

引用菜单实例

您可能会遇到需要在不处于构建器上下文的情况下引用菜单实例的情况。

通过名称获取特定菜单

$menu = Menu::get('MyNavBar');

或者获取所有菜单实例

$menus = Menu::all();

您还可以调用 getCollection() 来获取相同的结果

$menus = Menu::getCollection();

这两种方法都返回一个 Laravel 集合

HTML 属性

由于所有菜单项都将被渲染为 HTML 实体，如列表项或 div，因此您可以为每个项目定义所需数量的 HTML 属性

Menu::make('MyNavBar', function($menu){

  // As you see, you need to pass the second parameter as an associative array:
  $menu->add('Home',     ['route'  => 'home.page',  'class' => 'navbar navbar-home', 'id' => 'home']);
  $menu->add('About',    ['route'  => 'page.about', 'class' => 'navbar navbar-about dropdown']);
  $menu->add('services', ['action' => 'ServicesController@index']);
  $menu->add('Contact',  'contact');

});

如果我们选择 HTML 列表作为我们的渲染格式（如 ul），则结果将类似于以下内容

<ul>
  <li class="navbar navbar-home" id="home"><a href="http://yourdomain.com">Home</a></li>
  <li class="navbar navbar-about dropdown"><a href="http://yourdomain.com/about">About</a></li>
  <li><a href="http://yourdomain.com/services">Services</a></li>
  <li><a href="http://yourdomain.com/contact">Contact</a></li>
</ul>

您还可以使用 attr() 方法在定义项目之后设置或获取 HTML 属性。

如果您用单个参数调用 attr()，它将为您返回属性值。如果您用两个参数调用它，它将考虑第一个和第二个参数作为键/值对并设置属性。如果您需要一次性添加一组 HTML 属性，也可以传递一个关联数组；最后，如果您不带任何参数调用它，它将返回一个包含所有属性的数组。

//...
$menu->add('About', ['url' => 'about', 'class' => 'about-item']);

echo $menu->about->attr('class');  // output:  about-item

$menu->about->attr('class', 'another-class');
echo $menu->about->attr('class');  // output:  about-item another-class

$menu->about->attr(['class' => 'yet-another', 'id' => 'about']);

echo $menu->about->attr('class');  // output:  about-item another-class yet-another
echo $menu->about->attr('id');  // output:  id

print_r($menu->about->attr());

/* Output
Array
(
    [class] => about-item another-class yet-another
    [id] => id
)
*/

//...

您可以在集合上使用 attr，如果您需要针对一组项目

$menu->add('About', 'about');

$menu->about->add('Who we are', 'about/whoweare');
$menu->about->add('What we do', 'about/whatwedo');

// add a class to children of About
$menu->about->children()->attr('class', 'about-item');

操作链接

所有 HTML 属性都将应用于包装标签（li、div 等）；您可能会遇到需要将一些 HTML 属性添加到 <a> 标签上的情况。

每个 Item 实例都有一个属性，它存储了一个 Link 对象的实例。此对象为您提供操作 <a> 标签的途径。

就像每个项目一样，Link 也有一个与项目相同的 attr() 方法

Menu::make('MyNavBar', function($menu){

  $about = $menu->add('About',    ['route'  => 'page.about', 'class' => 'navbar navbar-about dropdown']);

  $about->link->attr(['class' => 'dropdown-toggle', 'data-toggle' => 'dropdown']);

});

链接的 Href 属性

如果您不想使用 laravel-menu 的路由功能，或者您不希望构建器将任何内容（例如，您的宿主地址）作为前缀添加到您的 URL 上，您可以显式设置您的链接的 href 属性

$menu->add('About')->link->href('#');

活动项目

您可以使用 active() 在该项目上标记一个项目为激活状态

$menu->add('Home', '#')->active();

/* Output
 *
 * <li class="active"><a href="#">#</a></li>
 *
 */

您还可以将类 active 添加到锚点元素而不是包装元素（div 或 li）

$menu->add('Home', '#')->link->active();

/* Output
 *
 * <li><a class="active" href="#">#</a></li>
 *
 */

Laravel 菜单会根据您注册项目时的当前 URI 自动执行此操作。

您还可以在配置目录中的 settings.php 文件中 config 选择要激活的元素（项目或链接）

'active_element' => 'item',    // item|link

RESTful URL

只要在 config/settings.php 文件中将 restful 选项设置为 true，就支持 RESTful URL。例如，具有 URL 的菜单项 resource 将由 resource/slug 或 resource/slug/edit 激活。

您可能会遇到应用程序位于子目录而不是根目录，或者资源具有公共前缀的情况；在这种情况下，您需要将 rest_base 选项设置为适当的前缀，以获得更好的RESTful激活支持。rest_base 可以接受简单的字符串、字符串数组或函数调用的值。

URL 通配符

laravel-menu 允许您为特定项定义一个模式，如果自动激活不起作用。

$menu->add('Articles', 'articles')->active('this-is-another-url/*');

因此，this-is-another-url 和 this-is-another-url/and-another 都将激活 Articles 项。

禁用激活

有时您可能需要禁用单个项的自动激活。您可以在选项中传递 disableActivationByURL，如下所示

$menu->add('Anchor', ['disableActivationByURL' => true, 'url' => '#']);

这通过匹配URL来防止自动激活。但具有活动子项的项的激活仍然有效。

插入分隔符

您可以使用 divide() 方法在每个项之后插入一个分隔符

//...
$menu->add('Separated Item', 'item-url')->divide()

// You can also use it this way:

$menu->('Another Separated Item', 'another-item-url');

// This line will insert a divider after the last defined item
$menu->divide()

//...

/*
 * Output as <ul>:
 *
 *    <ul>
 *        ...
 *        <li><a href="item-url">Separated Item</a></li>
 *        <li class="divider"></li>
 *
 *        <li><a href="another-item-url">Another Separated Item</a></li>
 *        <li class="divider"></li>
 *        ...
 *    </ul>
 *
 */

divide() 也可以获取关联数组属性

//...
$menu->add('Separated Item', 'item-url')->divide( ['class' => 'my-divider'] );
//...

/*
 * Output as <ul>:
 *
 *    <ul>
 *        ...
 *        <li><a href="item-url">Separated Item</a></li>
 *        <li class="my-divider divider"></li>
 *
 *        ...
 *    </ul>
 *
 */

追加和预置

您可以在定义后使用 append 或 prepend 方法将HTML或纯文本添加到每个项的标题中

Menu::make('MyNavBar', function($menu){


  $about = $menu->add('About',    ['route'  => 'page.about', 'class' => 'navbar navbar-about dropdown']);

  $menu->about->attr(['class' => 'dropdown-toggle', 'data-toggle' => 'dropdown'])
              ->append(' <b class="caret"></b>')
              ->prepend('<span class="glyphicon glyphicon-user"></span> ');

  // ...            

});

上面的代码将产生以下结果

<ul>
  ...

  <li class="navbar navbar-about dropdown">
   <a href="about" class="dropdown-toggle" data-toggle="dropdown">
     <span class="glyphicon glyphicon-user"></span> About <b class="caret"></b>
   </a>
  </li>
</ul>

您还可以在集合上调用 prepend 和 append。

在前后添加

允许您添加任意HTML块而不是下拉列表。还有许多其他可能性。与 append 和 prepend 不同，before 和 after 将任意HTML添加到标签 li 的根处。

Menu::make('MyNavBar', function($menu){


  $menu->add('User', ['title' => Auth::user()->name, 'class' => 'nav-item'])
      ->after(view('layouts.pattern.menu.user_info'))
      ->link->attr([
          'class'         => 'nav-link dropdown-toggle',
          'data-toggle'   => 'dropdown',
          'role'          => 'button',
          'aria-expanded' => 'false',
      ]);

  // ...            

});

视图资源，模式：layouts.pattern.menu.user_info

<div class="dropdown-menu" role="menu">    
    <div class="user-info-header">
        <?php echo Auth::user()->name; ?><br>
    </div>
    <div class="pull-left">
        <a href="<?php echo url('tools/profile'); ?>" class="btn btn-primary btn-flat">Profile</a>
    </div>
    <div class="pull-right">
        <a onclick="event.preventDefault(); document.getElementById('logout-form').submit();" class="btn btn-primary btn-flat">
            <i class="fa fa-power-off"></i>&nbsp;Exit
        </a>
        <form id="logout-form" action="<?php echo route('logout'); ?>" method="POST" style="display: none;">
            <?php echo csrf_field(); ?>
        </form>
    </div>
</div>

上面的代码将产生以下结果

<li title="Username" class="nav-item">
    <a class="nav-link dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
        User
    </a>
    <div class="dropdown-menu" role="menu">    
        <div class="user-info-header">
            <?php echo Auth::user()->name; ?>
        </div>
        <div class="pull-left">
            <a href="<?php echo url('tools/profile'); ?>" class="btn btn-primary btn-flat">Profile</a>
        </div>
        <div class="pull-right">
            <a onclick="event.preventDefault(); document.getElementById('logout-form').submit();" class="btn btn-primary btn-flat">
                <i class="fa fa-power-off"></i>&nbsp;Exit
            </a>
            <form id="logout-form" action="<?php echo route('logout'); ?>" method="POST" style="display: none;">
                <?php echo csrf_field(); ?>
            </form>
        </div>
    </div>
</li>

原始项目

要使用纯文本而不是超链接插入项，可以使用 raw()

$menu->raw('Item Title', ['class' => 'some-class']);  

$menu->add('About', 'about');
$menu->About->raw('Another Plain Text Item')

/* Output as an unordered list:
 * <ul>
 *   ...
 *   <li class="some-class">Item's Title</li>
 *   <li>
 *     About
 *     <ul>
 *       <li>Another Plain Text Item</li>
 *     </ul>
 *   </li>
 *   ...
 * </ul>
 */

菜单组

有时您可能需要在多个项之间共享属性。而不是为每个项指定属性和选项，您可以使用菜单组功能

PS：此功能与Laravel分组路由的功能完全相同。

Menu::make('MyNavBar', function($menu){

  $menu->add('Home',     ['route'  => 'home.page', 'class' => 'navbar navbar-home', 'id' => 'home']);

  $menu->group(['style' => 'padding: 0', 'data-role' => 'navigation'], function($m){

        $m->add('About',    ['route'  => 'page.about', 'class' => 'navbar navbar-about dropdown']);
        $m->add('services', ['action' => 'ServicesController@index']);
  }

  $menu->add('Contact',  'contact');

});

属性 style 和 data-role 将应用于 About 和 Services 项

<ul>
    <li class="navbar navbar-home" id="home"><a href="http://yourdomain.com">Home</a></li>
    <li style="padding: 0" data-role="navigation" class="navbar navbar-about dropdown"><a href="http://yourdomain.com/about"About</a></li>
    <li style="padding: 0" data-role="navigation"><a href="http://yourdomain.com/services">Services</a></li>
</ul>

URL 前缀

就像Laravel路由前缀功能一样，可以通过将 prefix 选项传递给组中传递的数组来为菜单项组添加前缀。

注意：前缀仅在带有 url 的菜单项上起作用，但不适用于 route 或 action。

Menu::make('MyNavBar', function($menu){

  $menu->add('Home',     ['route'  => 'home.page', 'class' => 'navbar navbar-home', 'id' => 'home']);

  $menu->add('About', ['url'  => 'about', 'class' => 'navbar navbar-about dropdown']);  // URL: /about

  $menu->group(['prefix' => 'about'], function($m){

    $about->add('Who we are?', 'who-we-are');   // URL: about/who-we-are
    $about->add('What we do?', 'what-we-do');   // URL: about/what-we-do

  });

  $menu->add('Contact',  'contact');

});

这将生成以下内容

<ul>
    <li class="navbar navbar-home" id="home"><a href="/">Home</a></li>

    <li data-role="navigation" class="navbar navbar-about dropdown"><a href="http://yourdomain.com/about/summary"About</a>
        <ul>
           <li><a href="http://yourdomain.com/about/who-we-are">Who we are?</a></li>
           <li><a href="http://yourdomain.com/about/who-we-are">What we do?</a></li>
        </ul>
    </li>

    <li><a href="services">Services</a></li>
    <li><a href="contact">Contact</a></li>
</ul>

嵌套组

Laravel Menu 还支持嵌套分组功能。菜单组将其自己的属性与其父组合并，然后与包装项共享它们

Menu::make('MyNavBar', function($menu){


    $menu->group(['prefix' => 'pages', 'data-info' => 'test'], function($m){

        $m->add('About', 'about');

        $m->group(['prefix' => 'about', 'data-role' => 'navigation'], function($a){

            $a->add('Who we are', 'who-we-are?');
            $a->add('What we do?', 'what-we-do');
            $a->add('Our Goals', 'our-goals');
        });
    });

});

如果我们将其渲染为 ul

<ul>
    ...
    <li data-info="test">
        <a href="http://yourdomain.com/pages/about">About</a>
        <ul>
            <li data-info="test" data-role="navigation"><a href="http://yourdomain.com/pages/about/who-we-are"></a></li>
            <li data-info="test" data-role="navigation"><a href="http://yourdomain.com/pages/about/what-we-do"></a></li>
            <li data-info="test" data-role="navigation"><a href="http://yourdomain.com/pages/about/our-goals"></a></li>
        </ul>
    </li>
</ul>

元数据

您可能会遇到需要将某些元数据附加到每个项的情况；这些数据可以是任何从项放置顺序到访问项所需权限的内容；您可以通过使用 data() 方法来实现这一点。

data() 方法与 attr() 方法的工作方式完全相同

如果您用单个参数调用 data()，它将返回数据值。如果您用两个参数调用它，它将第一个和第二个参数视为键/值对并设置数据。如果需要一次添加一组键/值对，您还可以传递数据关联数组；最后，如果您不带任何参数调用它，它将返回所有数据作为数组。

Menu::make('MyNavBar', function($menu){


$menu->add('Users', ['route'  => 'admin.users'])
      ->data('permission', 'manage_users');

});

您也可以像属性一样访问数据

//...

$menu->add('Users', '#')->data('placement', 12);

// you can refer to placement as if it's a public property of the item object
echo $menu->users->placement;    // Output : 12

//...
?>

元数据不会对项执行任何操作，也不会在HTML中渲染。开发者将决定如何使用它们。

如果您需要针对一组项，可以在集合上使用 data

$menu->add('Users', 'users');

$menu->users->add('New User', 'users/new');
$menu->users->add('Uses', 'users');

// add a meta data to children of Users
$menu->users->children()->data('anything', 'value');

过滤项目

我们可以使用 filter() 方法过滤菜单项。 Filter 接收您定义的闭包。然后它遍历项并在每个项上运行您的闭包。

对于您想要排除的项，必须返回 false；对于您想要保留的项，返回 true。

让我们用一个实际的场景继续前进

我假设您的 User 模型可以检查用户是否具有特定的权限

Menu::make('MyNavBar', function($menu){


  $menu->add('Users', ['route'  => 'admin.users'])
       ->data('permission', 'manage_users');

})->filter(function($item){
  if(User::get()->can( $item->data('permission'))) {
      return true;
  }
  return false;
});

如您可能已经注意到的，我们使用 data() 为每个项目附加了所需的权限。

因此，具有 manage_users 权限的人将可以看到 Users 项目。

排序项目

laravel-menu 可以根据用户定义的函数或键对项目进行排序，这些键可以是项目属性，例如 id、parent 等，也可以是每个项目存储的元数据。

要根据属性和/或元数据对项目进行排序

Menu::make('main', function($m){

    $m->add('About', '#')     ->data('order', 2);
    $m->add('Home', '#')      ->data('order', 1);
    $m->add('Services', '#')  ->data('order', 3);
    $m->add('Contact', '#')   ->data('order', 5);
    $m->add('Portfolio', '#') ->data('order', 4);

})->sortBy('order');

sortBy() 还接受第二个参数，指定排序方向：升序（asc）和降序（dsc）。

默认值是 asc。

要以降序对 Id 进行排序

Menu::make('main', function($m){

    $m->add('About');
    $m->add('Home');
    $m->add('Services');
    $m->add('Contact');
    $m->add('Portfolio');

})->sortBy('id', 'desc');

通过传递闭包对项目进行排序

Menu::make('main', function($m){

    $m->add('About')     ->data('order', 2);
    $m->add('Home')      ->data('order', 1);
    $m->add('Services')  ->data('order', 3);
    $m->add('Contact')   ->data('order', 5);
    $m->add('Portfolio') ->data('order', 4);

})->sortBy(function($items) {
    // Your sorting algorithm here...
});

闭包将项目集合作为参数。

渲染方法

提供多种渲染格式

菜单作为无序列表

  {!! $MenuName->asUl() !!}

asUl() 将您的菜单渲染为无序列表。它还接受一个可选参数来定义 <ul> 标签的属性

{!! $MenuName->asUl( ['class' => 'awesome-ul'] ) !!}

结果

<ul class="awesome-ul">
  <li><a href="http://yourdomain.com">Home</a></li>
  <li><a href="http://yourdomain.com/about">About</a></li>
  <li><a href="http://yourdomain.com/services">Services</a></li>
  <li><a href="http://yourdomain.com/contact">Contact</a></li>
</ul>

菜单作为有序列表

{!! $MenuName->asOl() !!}

asOl() 方法将您的菜单渲染为有序列表。它还接受一个可选参数来定义 <ol> 标签的属性

{!! $MenuName->asOl( ['class' => 'awesome-ol'] ) !!}

结果

<ol class="awesome-ol">
  <li><a href="http://yourdomain.com">Home</a></li>
  <li><a href="http://yourdomain.com/about">About</a></li>
  <li><a href="http://yourdomain.com/services">Services</a></li>
  <li><a href="http://yourdomain.com/contact">Contact</a></li>
</ol>

菜单作为 Div

{!! $MenuName->asDiv() !!}

asDiv() 方法将您的菜单作为嵌套 HTML div 渲染。它还接受一个可选参数来定义父 <div> 标签的属性

{!! $MenuName->asDiv( ['class' => 'awesome-div'] ) !!}

结果

<div class="awesome-div">
  <div><a href="http://yourdomain.com">Home</a></div>
  <div><a href="http://yourdomain.com/about">About</a></div>
  <div><a href="http://yourdomain.com/services">Services</a></div>
  <div><a href="http://yourdomain.com/contact">Contact</a></div>
</div>

菜单作为 Bootstrap 3 Navbar

Laravel Menu 提供了一个部分视图，可以直接生成具有 Bootstrap 风格的菜单项，您可以将其包含在基于 Bootstrap 的导航栏中

您可以通过 config('laravel-menu.views.bootstrap-items') 访问部分视图。

您需要做的只是包含部分视图，并将顶级项目传递给它

...

@include(config('laravel-menu.views.bootstrap-items'), ['items' => $mainNav->roots()])

...

这是您的 Bootstrap 代码将看起来像什么

<nav class="navbar navbar-default" role="navigation">
  <div class="container-fluid">
    <!-- Brand and toggle get grouped for better mobile display -->
    <div class="navbar-header">
      <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <a class="navbar-brand" href="#">Brand</a>
    </div>

    <!-- Collect the nav links, forms, and other content for toggling -->
    <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
      <ul class="nav navbar-nav">

       @include(config('laravel-menu.views.bootstrap-items'), ['items' => $mainNav->roots()])

      </ul>
      <form class="navbar-form navbar-right" role="search">
        <div class="form-group">
          <input type="text" class="form-control" placeholder="Search">
        </div>
        <button type="submit" class="btn btn-default">Submit</button>
      </form>
      <ul class="nav navbar-nav navbar-right">

        @include(config('laravel-menu.views.bootstrap-items'), ['items' => $loginNav->roots()])

      </ul>
    </div><!-- /.navbar-collapse -->
  </div><!-- /.container-fluid -->
</nav>

为子项添加类属性

除了给菜单 ul 和 ol 添加类之外，还可以给子菜单添加类。向 asUl 传递的三个参数都是数组，如下所示

第一个数组是列表的属性：例如，ul
第二个是子列表的属性，例如，ul>li>ul
第三个数组是添加到 li 元素属性的属性

有了这个，您可以像这样给子菜单（子菜单）添加一个类

{!! $menu->asUl( ['class' => 'first-level-ul'], ['class' => 'second-level-ul'] ) !!}

子集菜单

在构建完您的菜单后，您可以调用我们的任何子菜单函数来获取一个新的 Builder，以快速生成额外的菜单。

顶部菜单

这生成一个顶级项目的 Builder，没有父项的项目。

{!! Menu::get('primary')->topMenu()->asUl() !!}

子菜单

这生成活动项的直接子项的 Builder。

{!! Menu::get('primary')->subMenu()->asUl() !!}

同级菜单

这生成活动项的兄弟项的 Builder。

{!! Menu::get('primary')->siblingMenu()->asUl() !!}

面包屑菜单

这通过递归获取活动项的所有父项（包括活动项）来生成一个 Builder。

{!! Menu::get('primary')->crumbMenu()->asUl() !!}

高级用法

如前所述，您可以创建自己的渲染格式。

基本示例

如果您想根据您的设计渲染菜单，您应该创建两个视图。

View-1 这个视图包含所有 HTML 代码，如 nav 或 ul 或 div 标签，用于包装菜单项。
View-2 这个视图实际上是一个部分视图，负责渲染菜单项（它将被包含在 View-1 中。）

我们在这里使用两个视图文件的原因是 View-2 调用自身以递归方式渲染到多级菜单所需的最低级别。

让我们用一个例子来说明这一点

Menu::make('MyNavBar', function($menu){

  $menu->add('Home');

  $menu->add('About',    ['route'  => 'page.about']);

  $menu->about->add('Who are we?', 'who-we-are');
  $menu->about->add('What we do?', 'what-we-do');

  $menu->add('Services', 'services');
  $menu->add('Contact',  'contact');

});

在这个例子中，我们命名 View-1 为 custom-menu.blade.php 和 View-2 为 custom-menu-items.blade.php。

custom-menu.blade.php

<nav class="navbar">
  <ul class="horizontal-navbar">
    @include('custom-menu-items', ['items' => $MyNavBar->roots()])
  </ul>
</nav><!--/nav-->

custom-menu-items.blade.php

@foreach($items as $item)
  <li @if($item->hasChildren()) class="dropdown" @endif>
      <a href="{!! $item->url() !!}">{!! $item->title !!} </a>
      @if($item->hasChildren())
        <ul class="dropdown-menu">
              @include('custom-menu-items', ['items' => $item->children()])
        </ul>
      @endif
  </li>
@endforeach

让我们描述一下上面做了什么，在custom-menus.blade.php中，我们根据设计放置了所有的HTML模板代码，然后包含了custom-menu-items.blade.php，并将根级菜单项传递给custom-menu-items.blade.php

...
@include('custom-menu-items', ['items' => $menu->roots()])
...

在custom-menu-items.blade.php中，我们运行了一个foreach循环，如果当前项有子项，则会递归调用文件。

要将渲染后的菜单放入您的应用程序模板中，您只需在主布局中包含custom-menu视图。

Blade的控制结构

Laravel菜单扩展Blade以处理特殊布局。

@lm_attrs

您可能会遇到一些HTML属性在视图中明确编写，而不是在添加项时动态定义的情况；然而，您需要将这些静态属性与项的属性合并。

@foreach($items as $item)
  <li @if($item->hasChildren()) class="dropdown" @endif data-test="test">
      <a href="{!! $item->url() !!}">{!! $item->title !!} </a>
      @if($item->hasChildren())
        <ul class="dropdown-menu">
              @include('custom-menu-items', ['items' => $item->children()])
        </ul>
      @endif
  </li>
@endforeach

在上面的代码片段中，li标签具有类dropdown和data-test属性在视图中明确定义；Laravel菜单提供了一个控制结构，负责处理这个问题。

假设项也有在添加时动态定义的几个属性

$menu->add('Dropdown', ['class' => 'item item-1', 'id' => 'my-item']);

视图

@foreach($items as $item)
  <li @lm_attrs($item) @if($item->hasChildren()) class="dropdown" @endif data-test="test" @lm_endattrs>
      <a href="{!! $item->url !!}">{!! $item->title !!} </a>
      @if($item->hasChildren())
        <ul class="dropdown-menu">
              @include('custom-menu-items', ['items' => $item->children()])
        </ul>
      @endif
  </li>
@endforeach

这个控制结构会自动将静态HTML属性与动态定义的属性合并。

这就是结果

...
<li class="item item-1 dropdown" id="my-item" data-test="test">...</li>
...

项目的属性和回调函数

当打印列表时，您可以：设置列表元素的属性；设置回调函数，为每个链接添加前缀或条件（"?id={$id}")等等。

将菜单转换为移动端下拉列表的示例

控制器

$items=[
    'copy'=>[
        'icon'=>'fa-copy',
        'title'=>'Copy',
        'text'=>'Copy',
        'link_attribute'=>[
            'class'=>'nav-link',
            'href'=> url(Request::capture()->path()."/copy"),
        ]
    ],
];

$controlItem = Menu::make('controlItem', function($menu) use ($items){
    foreach ($items as $key => $item) if(!isset($item['visible']) || $item['visible']){
        $menu->add($item['text'],['title'=>$item['title']])
            ->append('</span>')
            ->prepend('<i class="fa '.$item['icon'].'"></i> <span>')
            ->link->attr($item['link_attribute']);
    }
});

return view('layouts.table.view',[
    'controlItem' => $controlItem
]);

视图：布局.table.view

<ul class="control-items-min">
    <li title="Menu">
        <a data-toggle="dropdown" aria-expanded="true"><i class="fa fa-bars"></i> <span></span></a>
    <!-- The first array is the attributes for the list: for example, `ul`;
         The second is the attributes for the child lists, for example, `ul>li>ul`;
         The third array is attributes that are added to the attributes of the `li` element. -->
        <?php echo $controlItem->asUl(['class'=>'dropdown-menu', 'role'=>'menu'],[],['class'=>'dropdown-item']); ?>
    </li>
</ul>
<?php echo $controlItem->asUl(['class'=>'control-items'],[],['class'=>'nav-item']); ?>

打印记录管理菜单的示例

控制器

$items=[
    'copy'=>[
        'icon'=>'fa-copy',
        'title'=>'Copy',
        'text'=>'Copy',
        'link_attribute'=>[
            'class'=>'nav-link',
            'href'=> url(Request::capture()->path()."/copy"),
        ]
    ],
];

$controlItem = Menu::make('controlItem', function($menu) use ($items){
    foreach ($items as $key => $item) if(!isset($item['visible']) || $item['visible']){
        $menu->add($item['text'],['title'=>$item['title']])
            ->append('</span>')
            ->prepend('<i class="fa '.$item['icon'].'"></i> <span>')
            ->link->attr($item['link_attribute']);
    }
});

return view('layouts.table.view',[
    'controlItem' => $controlItem
]);

视图：布局.table.view（用于具有不同ID的循环中）

echo (isset($controlItem)) ? $controlItem->asUl(
    ['class'=>'dropdown-menu control-item'],
    [],
    ['class'=>'nav-item'],
    function($item, &$children_attributes, &$item_attributes, &$link_attr, &$id){
        $link_attr['href'] .= "/".(int)$id;
    },
    $id):'';

配置

您可以在config/settings.php文件中调整菜单构建器的行为。目前它提供了一些开箱即用的选项

auto_activate 根据当前URI自动激活菜单项
activate_parents 激活活动项的父项
active_class 活动项的默认CSS类名
restful 激活RESTful URLS。例如，resource/slug将激活具有resource URL的项。
cascade_data 如果需要项的后代继承其父项的元数据，请确保此选项已启用。
rest_base 所有RESTful资源可能以该基础URL前缀。
active_element 您可以选择要添加激活类的HTML元素（锚点或包装元素）。

您还可以覆盖每个菜单的默认设置。要覆盖菜单的设置，只需将小写的菜单名作为键添加到设置数组中，并添加您需要覆盖的选项

return [
    'default' => [
        'auto_activate'    => true,
        'activate_parents' => true,
        'active_class'     => 'active',
        'active_element'   => 'item',    // item|link
        'restful'          => true,
    ],
    'yourmenuname' => [
        'auto_activate'    => false
    ],
];

如需帮助

请使用GitHub问题提交所有问题和疑问，我将尽力帮助您。

贡献

如果您能改进或添加任何功能，请随时提交拉取请求。

我们目前正在使用PSR-2+Symfony格式。这是易于实现和检查的，可以使用PHP编码标准修复器。

一旦您已安装php-cs-fixer并将其添加到您的路径中，只需在提交之前在laravel-menu文件夹中运行以下命令。

$ php-cs-fixer fix . --rules=@Symfony

虽然每个人都有不同的意见，但这个工具将有助于提供方便的一致性。

鸣谢

许可证

Laravel-Menu是免费软件，根据MIT许可条款分发。

ssntpl / laravel-menu

维护者

详细信息