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('路由路径') (URL::to())
secure_url('路由路径')
route('routename') 或 route('routename', '参数') 或 route('routename', ['param1', 'param2']) (URL::route())
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未找到页面（custom 404 Not Found page），使用名称 errors.404

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

在布局中输出面包屑

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

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

（相关常见问题解答：为什么没有 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 键，因为它们将被覆盖。

前/后回调

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

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

覆盖 "当前" 路由

如果您不提供参数调用 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 属性（用户可能没有）。根据您的需要对其进行修改。

故障排除

通用

重新阅读说明并确保您已正确执行所有操作。
从简单的选项开始，并在理解其工作原理后，再使用高级选项（例如路由绑定面包屑）。

未找到类 '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 中的路径。
请确保面包屑名称正确。
- 如果使用路由绑定面包屑，请确保它与路由名称完全匹配。
要在使用路由绑定面包屑时抑制这些错误（如果您不希望在某些页面上显示面包屑），则可以
- 使用空闭包（没有 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()（或者升级）。

其他事项

很抱歉这次无法帮助您，但一旦您解决了问题，请编辑此文件并附上解决方案，以帮助其他人！

贡献

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

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

新功能：只有具有明确用例和良好考虑的API的功能将被接受。它们必须得到文档记载，并包含单元测试。如果有疑问，请制作一个概念证明（可以是代码或文档），然后打开一个拉取请求以讨论细节。（提示：如果您想要一个默认情况下无法包含的特定功能，请参阅宏或高级定制部分，了解添加这些功能的方法。）

创建一个拉取请求

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

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

然后检出主分支，创建一个本地分支以进行工作

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上的仓库并创建一个拉取请求。

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

在项目中使用您的分叉

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

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

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

阅读并反复阅读此文件以及Laravel文档，看看是否有什么遗漏的。
深入研究源代码，花些时间了解它是如何工作的以及实际发生了什么。
尝试在全新的Laravel项目中重现问题，以防它与另一个包或其他代码不兼容。
如果您在团队中工作，请让您的同事帮助您调试。
请 someone 更有经验的人来帮助您（或者如果您在一家公司工作，请老板付钱给他们）。
尝试在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 许可证

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

coliving / laravel-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

不存在该方法

其他事项

贡献

创建一个拉取请求

在项目中使用您的分叉

单元测试

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` 门面