nashultz / laravel-breadcrumbs
以Laravel风格创建简单面包屑。
Requires
- php: >=7.1.3
- facade/ignition-contracts: ^1.0
- laravel/framework: >=5.6
Requires (Dev)
- orchestra/testbench: >=3.6
- php-coveralls/php-coveralls: ^2.0
- phpunit/phpunit: ^7.0|^8.0
- spatie/phpunit-snapshot-assertions: ^2.0
README
截至2020年4月18日,Laravel Breadcrumbs已停止维护。
它可能还会继续工作一段时间——我已经从composer.json
中移除了版本约束,因此它将一直工作,直到未来的Laravel版本进行破坏性更改。
如果您想创建自己的分支,以修复错误或添加新功能,请参阅下面的说明。MIT许可证要求您保留版权声明和许可证信息,但除此之外,您可以随意使用代码和文档。
感谢过去7年中帮助维护和添加功能的贡献者——我再也没有2013年时维护开源项目(或撰写博客文章,或社交媒体)的能量了,我决定是时候专注于新项目了。
—— Dave

Laravel Breadcrumbs
以Laravel风格的简单方式创建面包屑。
目录
兼容性图表
入门指南
注意:如果您使用的是旧版本,请在上面的表中单击它以查看该版本的文档。
注意2:如果您认为本文档可以在任何方面得到改进,请编辑此文件并提交一个pull request。
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 4breadcrumbs::bootstrap3
– Bootstrap 3breadcrumbs::bootstrap2
– Bootstrap 2breadcrumbs::bulma
– Bulmabreadcrumbs::foundation6
– Foundation 6breadcrumbs::materialize
– Materializebreadcrumbs::uikit
– UIkitbreadcrumbs::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模板会使用一个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
键,因为它们将被覆盖。
“之前”和“之后”回调
您可以注册“之前”和“之后”回调来在路径的开始/结束时添加面包屑。例如,要自动在末尾添加当前页码,可以这样做:
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) 有人为修复它提交了 拉取请求,或(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
中的路径。
- 尝试在该文件中放置
- 确保面包屑名称正确。
- 如果您使用路由绑定的面包屑,请确保它与路由名称完全匹配。
- 要抑制使用路由绑定的面包屑时的这些错误(如果您不希望某些页面有面包屑),请执行以下操作:
- 使用空闭包(没有推送/父调用)进行注册,或者
- 在配置文件中将
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上fork存储库并将您的更改推送到它
git remote add YOUR_USERNAME git@github.com:YOUR_USERNAME/laravel-breadcrumbs.git git push -u YOUR_USERNAME YOUR_BRANCH
最后,浏览到GitHub上的存储库并创建一个pull request。
(另外,还有一个测试应用您可以使用。)
在项目中使用您的fork
要使用自己的fork在项目中使用,请按以下方式更新您主项目中的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
(不受支持的组合)
如果需要更改,请也更新
如果向后不兼容的更改导致Laravel或PHP的最低支持版本发生变化,请更新
composer.json
php/*
illuminate/*
发布新版本
本节仅针对维护者。
- 确保单元测试已更新且覆盖率达到100%
- 如有必要,更新测试应用并手动测试
- 确保README是最新的,包括
- 将更改合并到
master
分支(如果需要) - 将代码更改推送到GitHub(
git push
) - 确保所有测试都通过
- 标记发布版本(
git tag 1.2.3
) - 推送标签(
git push --tag
)
无技术支持
抱歉,我不提供任何技术支持,GitHub问题已被禁用。这意味着我不会找出为什么它对你不起作用,我不会为你修复错误,也不会根据你的请求编写新功能——毕竟,这是一款免费软件。
但是开源的魅力在于你可以随心所欲地使用它!你可以将其分叉、修复、改进和扩展。如果你不想维护自己的分叉,并且你认为其他人会从你的更改中受益,你可以提交一个拉取请求,以便将你的更改包含在下一个版本中。
如果你真的遇到了困难,我建议你
- 阅读并反复阅读此文件以及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
)(由 #198 的 PieterHollevoet 提供)
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
返回类型提示。
旧版本
许可证
版权所有 © 2013-2019 Dave James Miller
在此特此授予任何获得此软件及其相关文档文件(以下简称“软件”)副本的任何人,在不受限制的情况下处理软件的权利,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本,并允许向软件提供者提供软件的人这样做,前提是遵守以下条件
上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。
软件按“现状”提供,不提供任何形式的保证,无论是明示的还是暗示的,包括但不限于适销性、特定用途适用性和非侵权性保证。在任何情况下,作者或版权所有者均不对任何索赔、损害或其他责任负责,无论是基于合同、侵权或其他方式引起的,无论该索赔、损害或其他责任是否与软件或其使用或其他方式有关。