README

截至2020年4月18日，Laravel Breadcrumbs 已停止维护。

它可能会继续工作一段时间 - 我已在 composer.json 中移除了版本限制，因此它将一直工作，直到Laravel的下一个版本进行破坏性更改。

感谢过去7年帮助维护和添加功能的贡献者 - 我已经没有2013年维护开源项目（或撰写博客文章、社交媒体）的能量了，我决定是时候专注于新的项目了。

— Dave

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未找到页面，请使用名称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 Breadcrumbs使用与控制器相同的模型绑定。例如

// 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文档中的资源控制器。

（相关FAQ：为什么没有Breadcrumbs::resource()方法？。）

高级用法

无URL的面包屑

push()的第二个参数是可选的，因此如果您想要一个没有URL的面包屑，可以这样做：

$trail->push('Sample');

$breadcrumb->url的值将是null。

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

自定义数据

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”回调

您可以注册“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>

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

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)])

覆盖“current”路由

如果您不带参数调用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)有人提交了修复此问题的拉取请求，或(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'

尝试运行 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 面包屑，请确保它与路由名称完全匹配。
在以下情况下使用 Route-Bound 面包屑时抑制这些错误（如果您不希望某些页面上有面包屑），则
- 使用空闭包（没有 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请求。

错误修复：请修复错误并打开一个pull请求。（见下文获取更详细的说明。）如果您添加了一个单元测试以确保问题不再发生，则可以获得额外分数！

新功能：只有具有明确用例和经过良好考虑的API的功能才会被接受。它们必须经过文档记录并包含单元测试。如有疑问，请创建一个原型（可以是代码或文档）并提交一个pull请求以讨论细节。（提示：如果您想添加一个默认情况下无法包含的特定功能，请参阅宏或高级自定义以了解添加方法。）

创建pull请求

在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请求。

（或者，您可以使用测试应用。）

在项目中使用您的叉出

要使用自己的叉出在项目中使用，请按以下方式更新主项目中的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已禁用。这意味着我不会找出为什么它对你不起作用，我不会为你修复错误，也不会根据请求编写新功能——毕竟这是免费软件。

但是开源的美好之处在于你可以随意使用它！你可以将其分叉、修复、改进和扩展。如果你不想维护自己的分叉，并且认为其他人可以从你的更改中受益，你可以提交一个拉取请求，以便你的更改包含在下一个版本中。

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

阅读并重新阅读此文件以及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 (周二 30 十月 2018)

添加 UIkit 模板 (breadcrumbs::uikit) (#198 由 PieterHollevoet 实现)

v5.1.2 (周五 14 九月 2018)

更新默认配置文件以包含所有可用的视图

v5.1.1 (周三 5 九月 2018)

添加 Laravel 5.7 支持

v5.1.0 (周六 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 (周六 10 二月 2018)

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

从 4.x 升级到 5.x

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

旧版本

许可

MIT 许可证

在此特此授予任何获得此软件及其相关文档文件（以下简称“软件”）副本的人免费使用软件的权利，不受任何限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本，以及允许提供软件的人进行此类操作，但受以下条件的约束

stevenberg / laravel-breadcrumbs

维护者

详细信息

README

Laravel Breadcrumbs

目录

兼容性图表

入门

1. 安装Laravel Breadcrumbs

2. 定义您的面包屑

3. 选择一个模板

4. 输出面包屑

定义面包屑

静态页面

父链接

动态标题和链接

嵌套分类

自定义模板

创建视图

视图数据

更新配置

跳过视图

输出面包屑

使用Blade

使用Blade布局和@section

纯PHP（不使用Blade）

结构化数据

路由绑定面包屑

命名您的路由

命名您的面包屑以匹配

在布局中输出面包屑

路由绑定异常

路由模型绑定

资源控制器

高级用法

无URL的面包屑

自定义数据

“before”和“after”回调

获取当前页面包屑

在运行时切换视图

覆盖“current”路由

检查面包屑是否存在

在另一个文件中定义面包屑

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

依赖注入

宏

高级自定义

API参考

Breadcrumbs 门面

定义面包屑

在视图（模板）中

配置文件

常见问题解答

有新的 Laravel 版本发布 - 您能添加对它的支持吗？

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

故障排除

通用

未找到类 'Breadcrumbs'

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

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

未定义变量：breadcrumbs

方法不存在

其他问题

贡献

创建pull请求

在项目中使用您的叉出

单元测试

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 (周二 30 十月 2018)

v5.1.2 (周五 14 九月 2018)

v5.1.1 (周三 5 九月 2018)

v5.1.0 (周六 5 五月 2018)

从 5.0.0 升级到 5.1.0

`Breadcrumbs` 门面