README

Laravel Breadcrumbs

一种简单的 Laravel 风格创建面包屑的方法。

兼容性图表

入门指南

注意：如果您使用的是旧版本，请在上面的表中单击它以查看该版本的文档。

注意 2：如果您认为可以以任何方式改进此文档，请编辑此文件并提交一个拉取请求。

1. 安装 Laravel Breadcrumbs

在命令行中运行以下命令

composer require davejamesmiller/laravel-breadcrumbs:5.x

这将更新 composer.json 并将包安装到 vendor/ 目录中。

2. 定义您的面包屑

创建一个名为 routes/breadcrumbs.php 的文件，其外观如下

<?php

// Home
Breadcrumbs::for('home', function ($trail) {
    $trail->push('Home', route('home'));
});

// Home > About
Breadcrumbs::for('about', function ($trail) {
    $trail->parent('home');
    $trail->push('About', route('about'));
});

// Home > Blog
Breadcrumbs::for('blog', function ($trail) {
    $trail->parent('home');
    $trail->push('Blog', route('blog'));
});

// Home > Blog > [Category]
Breadcrumbs::for('category', function ($trail, $category) {
    $trail->parent('blog');
    $trail->push($category->title, route('category', $category->id));
});

// Home > Blog > [Category] > [Post]
Breadcrumbs::for('post', function ($trail, $post) {
    $trail->parent('category', $post->category);
    $trail->push($post->title, route('post', $post->id));
});

有关更多详细信息，请参阅定义面包屑部分。

3. 选择一个模板

默认情况下将渲染一个兼容 Bootstrap 的有序列表，因此如果您使用 Bootstrap 4，则可以跳过此步骤。

首先运行以下命令初始化配置文件

php artisan vendor:publish --tag=breadcrumbs-config

然后打开 config/breadcrumbs.php 并编辑此行

    'view' => 'breadcrumbs::bootstrap4',

可能的值包括

breadcrumbs::bootstrap4 – Bootstrap 4
breadcrumbs::bootstrap3 – Bootstrap 3
breadcrumbs::bootstrap2 – Bootstrap 2
breadcrumbs::bulma – Bulma
breadcrumbs::foundation6 – Foundation 6
breadcrumbs::materialize – Materialize
breadcrumbs::uikit – UIkit
breadcrumbs::json-ld – JSON-LD 结构化数据 (<script> 标签，无可见输出)
自定义视图的路径：例如 partials.breadcrumbs

有关更多详细信息，请参阅自定义模板部分。

4. 输出面包屑

最后，在视图的每个页面中调用 Breadcrumbs::render()，传入要使用的面包屑名称以及任何其他参数 - 例如

{{ Breadcrumbs::render('home') }}

{{ Breadcrumbs::render('category', $category) }}

有关其他输出选项，请参阅输出面包屑部分，有关将面包屑名称自动链接到路由名称的方法，请参阅与路由绑定的面包屑。

定义面包屑

面包屑通常对应于动作或页面类型。对于您指定的每个面包屑，您需要提供一个名称、面包屑标题和链接的URL。由于这些内容可能会动态变化，您需要在闭包中完成此操作，并将您需要的任何变量传递给闭包。

以下示例应该能清楚地说明

静态页面

最简单的面包屑可能是您的首页，其外观可能如下所示

Breadcrumbs::for('home', function ($trail) {
     $trail->push('Home', route('home'));
});

如你所见，您只需在闭包中调用$trail->push($title, $url)。

对于生成URL，您可以使用任何标准的Laravel URL生成方法，包括

url('path/to/route') (URL::to())
secure_url('path/to/route')
route('routename')或route('routename', 'param')或route('routename', ['param1', 'param2']) (URL::route())
action('controller@action') (URL::action())
或者直接传递一个字符串URL ('http://www.example.com/')

这个示例将渲染为以下内容

{{ Breadcrumbs::render('home') }}

并产生以下输出

首页

父链接

这是一个静态页面，但在它之前有一个父链接

Breadcrumbs::for('blog', function ($trail) {
    $trail->parent('home');
    $trail->push('Blog', route('blog'));
});

它是通过调用上面定义的home面包屑的闭包来实现的。

其渲染结果如下

{{ Breadcrumbs::render('blog') }}

并产生以下输出

首页 / 博客

注意，默认模板不会为最后一个面包屑（当前页面的面包屑）创建链接，即使指定了URL。您可以通过创建自己的模板来覆盖此功能 - 请参阅自定义模板以获取更多详细信息。

动态标题和链接

这是一个从数据库动态生成的页面

Breadcrumbs::for('post', function ($trail, $post) {
    $trail->parent('blog');
    $trail->push($post->title, route('post', $post));
});

从视图传递给$post对象（可能是Eloquent模型，也可能是任何其他对象）

{{ Breadcrumbs::render('post', $post) }}

其输出结果如下

首页 / 博客 / 文章标题

提示：如有必要，您可以传递多个参数。

嵌套分类

最后，如果您有嵌套分类或其他特殊要求，您可以多次调用$trail->push()

Breadcrumbs::for('category', function ($trail, $category) {
    $trail->parent('blog');

    foreach ($category->ancestors as $ancestor) {
        $trail->push($ancestor->title, route('category', $ancestor->id));
    }

    $trail->push($category->title, route('category', $category->id));
});

或者您也可以创建一个递归函数，如下所示

Breadcrumbs::for('category', function ($trail, $category) {
    if ($category->parent) {
        $trail->parent('category', $category->parent);
    } else {
        $trail->parent('blog');
    }

    $trail->push($category->title, route('category', $category->slug));
});

两者都将渲染为以下内容

{{ Breadcrumbs::render('category', $category) }}

并产生以下结果

首页 / 博客 / 祖父分类 / 父分类 / 分类标题

自定义模板

创建一个视图

为了自定义HTML，创建自己的视图文件（例如resources/views/partials/breadcrumbs.blade.php），如下所示

@if (count($breadcrumbs))

    <ol class="breadcrumb">
        @foreach ($breadcrumbs as $breadcrumb)

            @if ($breadcrumb->url && !$loop->last)
                <li class="breadcrumb-item"><a href="{{ $breadcrumb->url }}">{{ $breadcrumb->title }}</a></li>
            @else
                <li class="breadcrumb-item active">{{ $breadcrumb->title }}</li>
            @endif

        @endforeach
    </ol>

@endif

（请参阅views/目录以获取内置模板。）

视图数据

视图将接收到一个名为$breadcrumbs的数组。

每个面包屑是一个具有以下键的对象

title - 面包屑标题
url - 面包屑URL，如果没有提供则为null
以及$data中每个项目的其他键（请参阅自定义数据）

更新配置

然后更新您的配置文件（config/breadcrumbs.php），例如

    'view' => 'partials.breadcrumbs', #--> resources/views/partials/breadcrumbs.blade.php

跳过视图

或者您可以选择跳过自定义视图，并调用Breadcrumbs::generate()以直接获取面包屑集合

@foreach (Breadcrumbs::generate('post', $post) as $breadcrumb)
    {{-- ... --}}
@endforeach

输出面包屑

在每个页面视图中调用Breadcrumbs::render()，并传递要使用的面包屑名称和任何附加参数。

使用Blade模板

在页面中（例如resources/views/home.blade.php）

{{ Breadcrumbs::render('home') }}

或者使用参数

{{ Breadcrumbs::render('category', $category) }}

使用Blade布局和@section

在页面中（例如resources/views/home.blade.php）

@extends('layout.name')

@section('breadcrumbs')
    {{ Breadcrumbs::render('home') }}
@endsection

或者使用缩写语法

@extends('layout.name')

@section('breadcrumbs', Breadcrumbs::render('home'))

并且在布局文件中（例如 resources/views/layout/name.blade.php）

@yield('breadcrumbs')

纯PHP（没有Blade）

在页面中（例如 resources/views/home.php）

<?= Breadcrumbs::render('home') ?>

如果你更喜欢长语法，可以使用

<?php echo Breadcrumbs::render('home') ?>

结构化数据

要将面包屑作为JSON-LD 结构化数据渲染（通常出于SEO原因），除了正常的模板外，使用 Breadcrumbs::view() 来渲染 breadcrumbs::json-ld 模板。例如

<html>
    <head>
        ...
        {{ Breadcrumbs::view('breadcrumbs::json-ld', 'category', $category) }}
        ...
    </head>
    <body>
        ...
        {{ Breadcrumbs::render('category', $category) }}
        ...
    </body>
</html>

（注意：如果你使用 Laravel Page Speed，你可能需要禁用 TrimUrls 中间件。）

要指定一个图片，将其添加到 push() 的 $data 参数中

Breadcrumbs::for('post', function ($trail, $post) {
    $trail->parent('home');
    $trail->push($post->title, route('post', $post), ['image' => asset($post->image)]);
});

（如果你更喜欢使用Microdata或RDFa，你需要创建一个自定义模板。）

与路由绑定的面包屑

在正常使用中，你必须调用 Breadcrumbs::render($name, $params...) 在每个页面渲染面包屑。如果你愿意，你可以将你的面包屑命名为与你的路由相同，以避免这种重复...

命名你的路由

确保你的每个路由都有一个名称。例如（《routes/web.php》）

// Home
Route::name('home')->get('/', 'HomeController@index');

// Home > [Post]
Route::name('post')->get('/post/{id}', 'PostController@show');

有关更多详细信息，请参阅Laravel文档中的命名路由。

命名你的面包屑以匹配

对于每个路由，创建一个具有相同名称和参数的面包屑。例如（《routes/breadcrumbs.php》）

// Home
Breadcrumbs::for('home', function ($trail) {
     $trail->push('Home', route('home'));
});

// Home > [Post]
Breadcrumbs::for('post', function ($trail, $id) {
    $post = Post::findOrFail($id);
    $trail->parent('home');
    $trail->push($post->title, route('post', $post));
});

要将面包屑添加到自定义的404 Not Found页面，使用名称 errors.404

// Error 404
Breadcrumbs::for('errors.404', function ($trail) {
    $trail->parent('home');
    $trail->push('Page Not Found');
});

在布局中输出面包屑

在你的布局文件中（例如 resources/views/app.blade.php）调用 Breadcrumbs::render() 不带参数

{{ Breadcrumbs::render() }}

这会自动输出与当前路由对应的面包屑。同样适用于 Breadcrumbs::generate()

$breadcrumbs = Breadcrumbs::generate();

以及 Breadcrumbs::view()

{{ Breadcrumbs::view('breadcrumbs::json-ld') }}

路由绑定异常

如果面包屑不存在，它将抛出 InvalidBreadcrumbException 异常，以提醒你创建一个。要禁用此功能（例如，如果你有一些没有面包屑的页面），首先初始化配置文件，如果你还没有这样做的话

php artisan vendor:publish --tag=breadcrumbs-config

然后打开 config/breadcrumbs.php 并设置此值

    'missing-route-bound-breadcrumb-exception' => false,

类似地，为了防止它抛出 UnnamedRouteException 异常，如果当前路由没有名称，设置此值

    'unnamed-route-exception' => false,

路由模型绑定

Laravel面包屑使用与控制器相同的模型绑定。例如

// routes/web.php
Route::name('post')->get('/post/{post}', 'PostController@show');

// app/Http/Controllers/PostController.php
use App\Post;

class PostController extends Controller
{
    public function show(Post $post) // <-- Implicit model binding happens here
    {
        return view('post/show', ['post' => $post]);
    }
}

// routes/breadcrumbs.php
Breadcrumbs::for('post', function ($trail, $post) { // <-- The same Post model is injected here
    $trail->parent('home');
    $trail->push($post->title, route('post', $post));
});

这通过只从数据库中加载一次文章来使你的代码更简洁、更高效。

有关更多详细信息，请参阅Laravel文档中的路由模型绑定。

资源控制器

Laravel自动为资源控制器创建路由名称，例如 photo.index，你可以在定义你的面包屑时使用它。例如

// routes/web.php
Route::resource('photo', PhotoController::class);

$ php artisan route:list
+--------+----------+--------------------+---------------+-------------------------+------------+
| Domain | Method   | URI                | Name          | Action                  | Middleware |
+--------+----------+--------------------+---------------+-------------------------+------------+
|        | GET|HEAD | photo              | photo.index   | PhotoController@index   |            |
|        | GET|HEAD | photo/create       | photo.create  | PhotoController@create  |            |
|        | POST     | photo              | photo.store   | PhotoController@store   |            |
|        | GET|HEAD | photo/{photo}      | photo.show    | PhotoController@show    |            |
|        | GET|HEAD | photo/{photo}/edit | photo.edit    | PhotoController@edit    |            |
|        | PUT      | photo/{photo}      | photo.update  | PhotoController@update  |            |
|        | PATCH    | photo/{photo}      |               | PhotoController@update  |            |
|        | DELETE   | photo/{photo}      | photo.destroy | PhotoController@destroy |            |
+--------+----------+--------------------+---------------+-------------------------+------------+

// routes/breadcrumbs.php

// Photos
Breadcrumbs::for('photo.index', function ($trail) {
    $trail->parent('home');
    $trail->push('Photos', route('photo.index'));
});

// Photos > Upload Photo
Breadcrumbs::for('photo.create', function ($trail) {
    $trail->parent('photo.index');
    $trail->push('Upload Photo', route('photo.create'));
});

// Photos > [Photo Name]
Breadcrumbs::for('photo.show', function ($trail, $photo) {
    $trail->parent('photo.index');
    $trail->push($photo->title, route('photo.show', $photo->id));
});

// Photos > [Photo Name] > Edit Photo
Breadcrumbs::for('photo.edit', function ($trail, $photo) {
    $trail->parent('photo.show', $photo);
    $trail->push('Edit Photo', route('photo.edit', $photo->id));
});

有关更多详细信息，请参阅Laravel文档中的资源控制器。

（相关常见问题：为什么没有Breadcrumbs::resource()方法？。）

高级使用

无URL的面包屑

push() 的第二个参数是可选的，所以如果你想有一个没有URL的面包屑，你可以这样做

$trail->push('Sample');

$breadcrumb->url 的值将是 null。

默认的Bootstrap模板会将其渲染为具有"active"CSS类的样式，这与最后一个面包屑相同，因为否则它们默认为黑色文本而不是灰色，这样看起来不合适。

自定义数据

push()方法接受一个可选的第三个参数$data——一个要传递给面包屑的任意数据数组，您可以在自定义模板中使用它。例如，如果您想要每个面包屑都有一个图标，您可以这样做

$trail->push('Home', '/', ['icon' => 'home.png']);

$data数组的条目将作为属性合并到面包屑中，因此您可以在模板中使用$breadcrumb->icon来访问图标，如下所示

<li><a href="{{ $breadcrumb->url }}">
    <img src="/images/icons/{{ $breadcrumb->icon }}">
    {{ $breadcrumb->title }}
</a></li>

不要使用title或url键，因为它们将被覆盖。

前后回调

您可以注册“before”和“after”回调来在路径的开始/结束处添加面包屑。例如，要自动在末尾添加当前页码

Breadcrumbs::after(function ($trail) {
    $page = (int) request('page', 1);
    if ($page > 1) {
        $trail->push("Page $page");
    }
});

获取当前页面包屑

要获取当前页的最后一个面包屑，使用Breadcrumb::current()。例如，您可以使用此方法输出当前页标题

<title>{{ ($breadcrumb = Breadcrumbs::current()) ? $breadcrumb->title : 'Fallback Title' }}</title>

要忽略一个面包屑，将'current' => false添加到push()中的$data参数。这可以用来忽略分页面包屑

Breadcrumbs::after(function ($trail) {
    $page = (int) request('page', 1);
    if ($page > 1) {
        $trail->push("Page $page", null, ['current' => false]);
    }
});

<title>
    {{ ($breadcrumb = Breadcrumbs::current()) ? "$breadcrumb->title –" : '' }}
    {{ ($page = (int) request('page')) > 1 ? "Page $page –" : '' }}
    Demo App
</title>

对于更高级的过滤，请使用Breadcrumbs::generate()和Laravel的集合类方法

$current = Breadcrumbs::generate()->where('current', '!==', 'false)->last();

运行时切换视图

您可以使用Breadcrumbs::view()代替Breadcrumbs::render()来渲染除默认模板之外的其他模板

{{ Breadcrumbs::view('partials.breadcrumbs2', 'category', $category) }}

或覆盖配置设置以影响所有未来的render()调用

Config::set('breadcrumbs.view', 'partials.breadcrumbs2');

{{ Breadcrumbs::render('category', $category) }}

或调用Breadcrumbs::generate()以获取面包屑集合并手动加载视图

@include('partials.breadcrumbs2', ['breadcrumbs' => Breadcrumbs::generate('category', $category)])

覆盖“当前”路由

如果您不带参数调用Breadcrumbs::render()或Breadcrumbs::generate()，它将默认使用当前路由名称和参数（由Laravel的Route::current()方法返回）。

您可以通过调用Breadcrumbs::setCurrentRoute($name, $param1, $param2...)来覆盖此设置。

检查面包屑是否存在

要检查具有给定名称的面包屑是否存在，请调用Breadcrumbs::exists('name')，它返回一个布尔值。

在不同的文件中定义面包屑

如果您不想使用routes/breadcrumbs.php，您可以在配置文件中更改它。首先，如果您还没有，初始化配置文件

php artisan vendor:publish --tag=breadcrumbs-config

然后打开 config/breadcrumbs.php 并编辑此行

    'files' => base_path('routes/breadcrumbs.php'),

它可以是一个绝对路径，如上所示，也可以是一个数组

    'files' => [
        base_path('breadcrumbs/admin.php'),
        base_path('breadcrumbs/frontend.php'),
    ],

因此，您可以使用glob()自动使用通配符查找文件

    'files' => glob(base_path('breadcrumbs/*.php')),

或返回一个空数组[]以禁用加载。

在另一个包中定义/使用面包屑

如果您正在创建自己的包，只需从服务提供者的boot()方法中加载您的面包屑文件即可

use Illuminate\Support\ServiceProvider;

class MyServiceProvider extends ServiceProvider
{
    public function register() {}

    public function boot()
    {
        if (class_exists('Breadcrumbs')) {
            require __DIR__ . '/breadcrumbs.php';
        }
    }
}

依赖注入

如果您愿意，可以使用依赖注入来访问BreadcrumbsManager实例，而不是使用Breadcrumbs::外观

use DaveJamesMiller\Breadcrumbs\BreadcrumbsManager;
use Illuminate\Support\ServiceProvider;

class MyServiceProvider extends ServiceProvider
{
    public function register() {}

    public function boot(BreadcrumbsManager $breadcrumbs)
    {
        $breadcrumbs->register(...);
    }
}

宏

BreadcrumbsManager类是宏可用的，因此您可以添加自己的方法。例如

Breadcrumbs::macro('pageTitle', function () {
    $title = ($breadcrumb = Breadcrumbs::current()) ? "{$breadcrumb->title} – " : '';

    if (($page = (int) request('page')) > 1) {
        $title .= "Page $page – ";
    }

    return $title . 'Demo App';
});

<title>{{ Breadcrumbs::pageTitle() }}</title>

高级自定义

对于更高级的自定义，您可以创建BreadcrumbsManager和/或BreadcrumbsGenerator的子类，然后使用新的类名更新配置文件

    // Manager
    'manager-class' => DaveJamesMiller\Breadcrumbs\BreadcrumbsManager::class,

    // Generator
    'generator-class' => DaveJamesMiller\Breadcrumbs\BreadcrumbsGenerator::class,

(注意：任何不是公开API部分（见下文）的内容都可能在不同版本之间发生变化，因此我建议您编写单元测试以确保在升级时不会中断。

API 参考

`Breadcrumbs`外观

源代码

定义面包屑

use App\Models\Post;
use DaveJamesMiller\Breadcrumbs\BreadcrumbsGenerator;

Breadcrumbs::before(function (BreadcrumbsGenerator $trail) {
    // ...
});

Breadcrumbs::for('name', function (BreadcrumbsGenerator $trail, Post $post) {
    // ...
});

Breadcrumbs::after(function (BreadcrumbsGenerator $trail) {
    // ...
});

源代码

在视图中（模板）

@foreach ($breadcrumbs as $breadcrumb)
    {{-- ... --}}
@endforeach

源代码

配置文件

config/breadcrumbs.php

源代码

常见问题解答

有一个新的Laravel版本 - 你能添加对其的支持吗？

从5.3.2版本开始，在composer.json中没有指定Laravel的最大版本，所以大多数情况下它会正常工作。

如果由于任何原因出现问题，它将在以下情况之一发生时得到修复：(1)有人提交pull request来修复它，或者(2)我决定升级我的应用程序 - 取决于哪个先发生。实际上，通常是因为我不一般在第一天升级。

为什么没有Breadcrumbs::resource()方法？

一些人建议添加Breadcrumbs::resource()来匹配Route::resource()，但没有人提出一个既能灵活处理翻译、嵌套资源等，又不会因此过于复杂的良好实现。

我个人认为没有好的全面解决方案，所以建议使用Breadcrumbs::macro()添加自己的。以下是一个起点

Breadcrumbs::macro('resource', function ($name, $title) {
    // Home > Blog
    Breadcrumbs::for("$name.index", function ($trail) use ($name, $title) {
        $trail->parent('home');
        $trail->push($title, route("$name.index"));
    });

    // Home > Blog > New
    Breadcrumbs::for("$name.create", function ($trail) use ($name) {
        $trail->parent("$name.index");
        $trail->push('New', route("$name.create"));
    });

    // Home > Blog > Post 123
    Breadcrumbs::for("$name.show", function ($trail, $model) use ($name) {
        $trail->parent("$name.index");
        $trail->push($model->title, route("$name.show", $model));
    });

    // Home > Blog > Post 123 > Edit
    Breadcrumbs::for("$name.edit", function ($trail, $model) use ($name) {
        $trail->parent("$name.show", $model);
        $trail->push('Edit', route("$name.edit", $model));
    });
});

Breadcrumbs::resource('blog', 'Blog');
Breadcrumbs::resource('photos', 'Photos');
Breadcrumbs::resource('users', 'Users');

请注意，这不处理翻译或嵌套资源，并且它假设所有模型都有一个title属性（这可能是用户不想要的）。根据你的需求进行适应。

故障排除

一般

重新阅读说明，并确保你已正确执行。
从简单选项开始，只有当你理解它是如何工作的时候才使用高级选项（例如，Route-Bound Breadcrumbs）。

找不到类'Breadcrumbs'

尝试运行composer update davejamesmiller/laravel-breadcrumbs进行升级。
尝试运行php artisan package:discover以确保服务提供程序被Laravel检测到。

找不到名为...的面包屑

确保你在正确的位置注册了面包屑（默认为routes/breadcrumbs.php）。
- 尝试在该文件中放置dd(__FILE__)以确保它已加载。
- 尝试在BreadcrumbsServiceProvider::registerBreadcrumbs()中放置dd($files)以检查路径是否正确。
- 如果不正确，尝试运行php artisan config:clear（或手动删除bootstrap/cache/config.php）或更新config/breadcrumbs.php中的路径。
确保面包屑名称正确。
- 如果使用Route-Bound Breadcrumbs，确保它与路由名称完全匹配。
要抑制使用Route-Bound Breadcrumbs时这些错误（如果你不希望在某些页面上显示面包屑），可以：
- 使用空闭包（没有push/parent调用）注册它们，或者
- 在配置文件中将missing-route-bound-breadcrumb-exception设置为false以禁用检查（但如果你错过任何页面，不会得到警告）。

BreadcrumbsServiceProvider::registerBreadcrumbs(): 无法打开所需...

确保路径正确。
如果是这样，检查文件的所有权和权限是否正确。
如果不正确，尝试运行php artisan config:clear（或手动删除bootstrap/cache/config.php）或更新config/breadcrumbs.php中的路径。

未定义变量: breadcrumbs

确保使用{{ Breadcrumbs::render() }}或{{ Breadcrumbs::view() }}，而不是@include()。

方法不存在

你可能在5.1版本以下 - 使用Breadcrumbs::register()代替Breadcrumbs::for()（或升级）。

其他

很抱歉这次没能帮到你，但一旦你解决了问题，请编辑此文件并提供解决方案，以帮助下一个人！

贡献

文档：如果你认为文档的任何方面都可以改进，请编辑此文件并提交pull request。

错误修复：请修复它并提交一个pull request。(见下文以获取更详细的说明。) 如果您添加了一个单元测试来确保不会再次发生，将获得加分！

新功能：只有具有明确用例和经过良好考虑的API的功能才会被接受。它们必须有文档，并包含单元测试。如果有疑问，请制作一个概念证明（可以是代码或文档），并提交一个pull request以讨论细节。(提示：如果您想要包含默认设置的功能太具体，请参阅宏或高级定制以了解如何添加它们。)

创建 pull request

在 Laravel Breadcrumbs 上工作的最简单方法是告诉 Composer 使用 --prefer-source 标志从源（Git）安装它

rm -rf vendor/davejamesmiller/laravel-breadcrumbs
composer install --prefer-source

然后检出 master 分支，并创建自己的本地分支以进行工作

cd vendor/davejamesmiller/laravel-breadcrumbs
git checkout -t origin/master
git checkout -b YOUR_BRANCH

现在进行您的更改，包括单元测试和文档（如果适用）。运行单元测试以确保一切仍然正常工作

scripts/test.sh

然后提交更改。如果您还没有，请先在 GitHub 上分叉仓库，并将您的更改推送到它

git remote add YOUR_USERNAME git@github.com:YOUR_USERNAME/laravel-breadcrumbs.git
git push -u YOUR_USERNAME YOUR_BRANCH

最后，浏览到 GitHub 上的仓库并创建一个 pull request。

(另外，您可以使用测试应用。)

在项目中使用您的分叉

要在项目中使用您自己的分叉，请按以下方式更新主项目中的 composer.json

{
    // ADD THIS:
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/YOUR_USERNAME/laravel-breadcrumbs.git"
        }
    ],
    "require": {
        // UPDATE THIS:
        "davejamesmiller/laravel-breadcrumbs": "dev-YOUR_BRANCH"
    }
}

将 YOUR_USERNAME 替换为您的 GitHub 用户名，将 YOUR_BRANCH 替换为分支名称（例如 develop）。这告诉 Composer 使用您的仓库而不是默认仓库。

单元测试

要运行单元测试

scripts/test.sh

要检查代码覆盖率

scripts/test-coverage.sh

然后打开 test-coverage/index.html 来查看结果。注意 PHPUnit 中的边缘情况，这些情况可能导致结果不够准确。

Laravel 的新版本

在composer.json中没有指定最大版本，因此不需要每 6 个月发布一个新的 Laravel Breadcrumbs 版本。但是，此文件需要更新以运行针对新版本的测试

.travis.yml
- matrix (Laravel 版本)
- php (PHP 版本)
- exclude (不支持的组合)

如果需要，请更新

README.md
- 兼容性图表
- 变更日志

如果向后不兼容的更改导致 Laravel 或 PHP 的最低支持版本发生变化，请更新

composer.json
- php/*
- illuminate/*

发布新版本

本节仅适用于维护者。

确保单元测试已更新且覆盖率为 100%
如果适用，更新测试应用并手动测试它
确保README是最新的，包括
- 记录任何新功能
- 兼容性图表
- 变更日志
将更改合并到 master 分支（如果需要）
将代码更改推送到 GitHub (git push)
确保所有测试都通过
标记发布 (git tag 1.2.3)
推送标签 (git push --tag)

无技术支持

很抱歉，我无法提供任何技术支持，并且GitHub Issues已被禁用。这意味着我不会找出为什么它不适合您的原因，我不会为您修复错误，也不会根据您的请求编写新功能——毕竟，这还是一款免费软件。

但是开源的美丽之处在于您可以随心所欲地使用它！您可以将其分支出来，修复它，改进它并扩展它。如果您不想维护自己的分支，并且认为其他人的变化会从中受益，您可以提交一个pull request，以便您的更改包含在下一个版本中。

如果您真的遇到了难题，我建议您

阅读并反复阅读此文件和Laravel 文档，看看是否有什么遗漏。
深入源代码，花些时间弄清楚它应该如何工作以及实际上发生了什么。
尝试在全新的Laravel项目上重现问题，以防它是与其他包或您的其他代码不兼容。
如果您的团队中有人，请他们帮助您调试。
请更有经验的人帮助您（或者如果您在公司工作，请您的老板支付他们）。
尝试在Stack Overflow、Laravel.io 论坛或Laracasts 论坛上发布（但我不能保证有人会回答——他们也没有报酬）。
使用不同的包。
自己编写。

变更日志

Laravel Breadcrumbs 使用语义化版本控制。

v5.3.2 (2019年12月30日星期一)

从composer.json中删除最大Laravel版本约束，以支持Laravel 7+，无需每6个月发布新版本。

v5.3.1 (2019年10月20日星期日)

为Breadcrumbs外观添加docblock（IDE Helper的替代品 – 感谢Alexandr Chernyaev）

v5.3.0 (2019年9月3日星期二)

添加Laravel 6.x支持
添加Laravel Ignition建议的解决方案
将vendor:publish标签从config更改为breadcrumbs-config，以匹配Horizon & Telescope并简化命令

v5.2.1 (2019年2月27日星期三)

添加Laravel 5.8支持（感谢Andrew Dabich）

v5.2.0 (2018年10月30日星期二)

添加UIkit模板（breadcrumbs::uikit）（由PieterHollevoet在#198中提出）

v5.1.2 (2018年9月14日星期五)

更新默认配置文件，其中包含可用视图的完整列表

v5.1.1 (周三 5 月 9 日 2018)

添加 Laravel 5.7 支持

v5.1.0 (周六 5 月 5 日 2018)

将 Breadcrumbs::for($name, $callback) 作为 Breadcrumbs::register($name, $callback) 的别名添加
在文档中将 $breadcrumbs 重命名为 $trail（这不会影响代码）

这些更改受到（或者说直接来自）Dwight Watson 的 Breadcrumbs 包的启发。

从 5.0.0 升级到 5.1.0

不需要进行任何更改，但建议更新您的 routes/breadcrumbs.php 以匹配新的文档

将 Breadcrumbs::register 替换为 Breadcrumbs::for
将 $breadcrumbs 替换为 $trail

v5.0.0 (周六 2 月 10 日 2018)

添加 Laravel 5.6 支持，并停止对 Laravel 5.5 的支持
停止对 PHP 7.0 的支持（添加 void 返回类型提示，并使用 [] 替代 list()）
在启用 IDE Helper 时修复 Breadcrumbs 门面中的类名

从 4.x 升级到 5.x

升级到 Laravel 5.6（需要 PHP 7.1.3+）
如果您扩展了任何类，请根据需要添加 : void 返回类型提示。

旧版本

许可

MIT 许可证

在此特此授予任何人获取此软件及其相关文档文件（“软件”）副本的权利，免费使用该软件不受限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，并允许向软件提供副本的个人从事上述活动，前提是遵守以下条件

baravak / lumen-breadcrumbs

维护者

详细信息

README

Laravel Breadcrumbs

目录

兼容性图表

入门指南

1. 安装 Laravel Breadcrumbs

2. 定义您的面包屑

3. 选择一个模板

4. 输出面包屑

定义面包屑

静态页面

父链接

动态标题和链接

嵌套分类

自定义模板

创建一个视图

视图数据

更新配置

跳过视图

输出面包屑

使用Blade模板

使用Blade布局和@section

纯PHP（没有Blade）

结构化数据

与路由绑定的面包屑

命名你的路由

命名你的面包屑以匹配

在布局中输出面包屑

路由绑定异常

路由模型绑定

资源控制器

高级使用

无URL的面包屑

自定义数据

前后回调

获取当前页面包屑

运行时切换视图

覆盖“当前”路由

检查面包屑是否存在

在不同的文件中定义面包屑

在另一个包中定义/使用面包屑

依赖注入

宏

高级自定义

API 参考

Breadcrumbs外观

定义面包屑

在视图中（模板）

配置文件

常见问题解答

有一个新的Laravel版本 - 你能添加对其的支持吗？

为什么没有Breadcrumbs::resource()方法？

故障排除

一般

找不到类'Breadcrumbs'

找不到名为...的面包屑

BreadcrumbsServiceProvider::registerBreadcrumbs(): 无法打开所需...

未定义变量: breadcrumbs

方法不存在

其他

贡献

创建 pull request

在项目中使用您的分叉

单元测试

Laravel 的新版本

发布新版本

无技术支持

变更日志

v5.3.2 (2019年12月30日星期一)

v5.3.1 (2019年10月20日星期日)

v5.3.0 (2019年9月3日星期二)

v5.2.1 (2019年2月27日星期三)

v5.2.0 (2018年10月30日星期二)

v5.1.2 (2018年9月14日星期五)

v5.1.1 (周三 5 月 9 日 2018)

v5.1.0 (周六 5 月 5 日 2018)

从 5.0.0 升级到 5.1.0

`Breadcrumbs`外观