thatobabusi/laravel-breadcrumbs

以Laravel风格创建面包屑的简单方式。

5.3.2 2019-12-30 22:50 UTC

README

**截至2020年7月27日,我已将其分支以接管并单独使用,因为Dave不再支持它。此外,我在composer install/update/dumpautoload等操作时,已经厌倦了收到“包不再支持”的通知。

Thato

截至2020年4月18日,Laravel Breadcrumbs不再维护。

它可能还会继续工作一段时间 - 我 composer.json中移除了版本约束,因此它将一直工作,直到Laravel的将来版本进行破坏性更改。

如果您想创建自己的分支,以修复错误或添加新功能,请参阅以下说明。MIT许可证要求您保留版权声明和许可证信息,但除此之外,您可以自由使用代码和文档。

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

Dave


Laravel Breadcrumbs

Latest Stable Version Total Downloads Monthly Downloads License
Latest Unstable Version Build Status Coverage Status

以Laravel风格创建面包屑的简单方式。

目录

兼容性图表

入门指南

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

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

1. 安装Laravel Breadcrumbs

在命令行中运行此命令

composer require thatobabusi/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',

可能的值有

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

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 面包屑使用与控制器相同的模型绑定。例如

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

不要使用titleurl键,因为它们将被覆盖。

前后回调

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

覆盖“当前”路由

如果您使用不带参数的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 ThatoBabusi\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' => ThatoBabusi\Breadcrumbs\BreadcrumbsManager::class,

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

(注意: 以下任何不是公开 API 部分的内容(见下文)都可能在不同版本之间发生变化,因此我建议您编写单元测试以确保升级时不会出现故障。)

API参考

Breadcrumbs 门面

源代码

定义面包屑

use App\Models\Post;
use ThatoBabusi\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 thatobabusi/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 中更新路径。
  • 确保面包屑名称正确。
    • 如果使用路由绑定面包屑,请确保它与路由名称完全匹配。
  • 要在使用路由绑定面包屑时抑制这些错误(如果您不想在某些页面上显示面包屑),请

BreadcrumbsServiceProvider::registerBreadcrumbs():失败打开所需的...

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

未定义变量:breadcrumbs

  • 请确保您使用 {{ Breadcrumbs::render() }}{{ Breadcrumbs::view() }},而不是 @include()

方法不存在

其他问题

很抱歉这次无法帮助您,但一旦您解决了您的问题,请编辑此文件并提供解决方案,以帮助下一个遇到同样问题的人!

贡献

文档:如果您认为文档可以以任何方式改进,请编辑此文件并创建一个拉取请求。

错误修复:请修复它并创建一个拉取请求。 (以下提供更详细的说明。) 如果您添加了单元测试以确保它不会再次发生,那么您将获得加分!

新功能:只有具有明确用例和经过深思熟虑的API的功能才会被接受。它们必须有文档,并包含单元测试。如有疑问,请创建一个概念证明(可以是代码或文档),并创建一个拉取请求以讨论细节。 (提示:如果您想要一个默认情况下无法包含的特定功能,请参阅高级定制部分,了解如何添加它们。)

创建拉取请求

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

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

然后检出主分支,创建自己的本地分支进行工作

cd vendor/thatobabusi/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:
        "thatobabusi/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(不支持组合)

如果需要更改,也更新

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

发布新版本

本节仅适用于维护者。

  • 确保单元测试已更新且覆盖率达到100%
  • 如果适用,更新测试应用并手动测试它
  • 确保README是最新的,包括
  • 将更改合并到master分支(如果需要)
  • 将代码更改推送到GitHub(git push
  • 确保所有测试都通过
  • 标记版本(git tag 1.2.3
  • 推送标记(git push --tag

无技术支持

很抱歉,我不提供任何技术支持,GitHub问题已被禁用。这意味着我不会找出为什么它对你不起作用,我不会为你修复错误,也不会根据你的要求编写新功能——毕竟,这是一个免费的软件。

但是开源的美丽之处在于你可以随意使用它!你可以分叉它、修复它、改进它并扩展它。如果你不想维护自己的分支,并且你认为其他人会从你的更改中受益,你可以提交一个pull request以将你的更改包含在下一个版本中。

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

  1. 阅读并反复阅读此文件和Laravel文档,看看你是否错过了什么。
  2. 深入研究源代码,花些时间了解它是如何工作的以及实际发生了什么。
  3. 尝试在一个全新的Laravel项目中重现问题,以防它是与其他包或你的其他代码不兼容。
  4. 如果你在一个团队工作,请你的同事帮助你调试。
  5. 支付有经验的人来帮助你(或者如果你在一家公司工作,请你的老板支付他们)。
  6. 尝试在Stack OverflowLaravel.io论坛Laracasts论坛上发布帖子(但我不能保证有人会回答——他们也没有得到报酬)。
  7. 使用不同的包。
  8. 自己编写。

变更日志

Laravel Breadcrumbs使用语义版本控制

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

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

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

  • Breadcrumbs外观添加文档注释(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日星期三)

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

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外观的PhpDoc中的类名

从4.x升级到5.x

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

旧版本

许可证

MIT许可证

版权所有 © 2013-2019 Dave James Miller

特此授予任何获得本软件及其相关文档文件(以下简称“软件”)副本的人,免费使用该软件的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利,并允许获得软件副本的个人这样做,前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。

软件按“原样”提供,不提供任何形式的保证,无论是明示的还是暗示的,包括但不限于适销性、特定目的适用性和非侵权性。在任何情况下,作者或版权所有者不对任何索赔、损害或其他责任负责,无论这些索赔、损害或其他责任是由合同、侵权或其他原因引起的,与软件或其使用或其他方式有关。