README

感谢DaveJamesMiller的出色工作!!

这是对已归档的DaveJamesMiller / Laravel Breadcrumbs项目的分支。

Laravel Breadcrumbs

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

兼容性图表

入门

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

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

1. 安装Laravel Breadcrumbs

在命令行中运行此命令

composer require rivalex/laravel-breadcrumbs

这将更新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',

使用fontawesome.io在面包屑中支持图标

    'view' => 'breadcrumbs::bootstrap4icons',

并实现根...

// Home
Breadcrumbs::for('home', function ($trail) {
    $trail->push('Home', route('home'), ['faIcon' => 'fas fa-home']);
});

可能的值有

breadcrumbs::bootstrap4icons – Bootstrap 4 - fontawesome.io
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::view()

$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模板将其渲染为具有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”回调来在路径的开始/结束时添加面包屑。例如，自动在末尾添加当前页面编号

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 Rivalex\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' => Rivalex\Breadcrumbs\BreadcrumbsManager::class,

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

(注意： 任何不是公共API（见下文）的部分可能在发布之间发生变化，所以我建议你编写单元测试以确保升级时不会破坏。）

API参考

`Breadcrumbs` 门面

源代码

定义面包屑

use App\Models\Post;
use Rivalex\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)我决定升级我的应用程序 - 以先发生者为准。实际上，这通常是前者，因为我通常不会在第1天升级。

为什么没有 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 rivalex/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(): Failed opening required ...

请确保路径正确。
如果是这样，请检查文件所有权和权限是否正确。
如果不正确，请尝试运行 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的功能才会被接受。它们必须进行文档记录并包含单元测试。如有疑问，请制作一个概念验证（可以是代码或文档），并打开一个拉取请求来讨论细节。（提示：如果您想要一个过于特定而无法默认包含的功能，请参阅宏或高级自定义以了解添加它们的途径。）

创建拉取请求

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

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

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

cd vendor/rivalex/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:
        "rivalex/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问题已禁用。这意味着我不会找出为什么它对您不起作用，我不会为您修复错误，也不会根据要求编写新功能——毕竟这是免费软件。

但是开源之美在于你可以随心所欲地使用它！你可以进行分支、修复、改进和扩展。如果你不想维护自己的分支，而且你认为你的更改会惠及他人，你可以提交一个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（2018年9月5日星期三）

添加 Laravel 5.7 支持

v5.1.0（2018年5月5日星期六）

添加 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（2018 年 2 月 10 日星期六）

添加 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 许可证

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

rivalex / 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(): Failed opening required ...

未定义变量：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（2018年10月30日星期二）

v5.1.2（2018年9月14日星期五）

v5.1.1（2018年9月5日星期三）

v5.1.0（2018年5月5日星期六）

从 5.0.0 升级到 5.1.0

`Breadcrumbs` 门面