laravelhungary / announcement
使用 Laravel 简单实现公告功能
Requires
- illuminate/support: ~5.0
- predis/predis: ^1.1
Requires (Dev)
- phpunit/phpunit: ~4.5
This package is auto-updated.
Last update: 2024-09-17 13:57:42 UTC
README
Laravel 公告
一个简化网站公告管理的包。使用 "Laravel 公告" 可以显示自动过期的公告。
安装
1- composer require laravelhungary/announcement
- 请注意,该包使用
predis/predis
进行所有操作。
2- 在 config/app.php
中添加以下内容:
'providers' => [ ... LaravelHungary\Announcement\PackageServiceProvider::class, ], 'aliases' => [ ... 'Announce' => LaravelHungary\Announcement\Facades\Announce::class, ]
3- 执行 php artisan vendor:publish
,然后你会得到
/config/announcement.php /views/vendor/announcement/alert.blade.php /Events/NewAnnouncement.php /components/Announcement-bootstrap.vue /components/Announcement-sweetalert.vue
4- 完成。
如果你需要通过类似 Web-sockets 的方式广播公告,请查看 事件广播
使用方法
常规
创建公告
Announce::create($title, $message, $type, $ttl);
参数
title
短消息。
例如:重大新闻!
message
较长的消息。
例如:我们的服务器正在遭受 DDoS 攻击。我们正在努力减轻。
type
公告的类型。
例如:成功、信息、危险、警告(或您想使用的任何类型),默认为:信息
ttl
公告何时过期。 [存活时间](以秒为单位)。
默认为:60 秒
公告显示
将 {!! Announce::display() !!}
放置在任何您希望公告可见的位置。
===
广播
创建公告
Announce::broadcast($title, $message, $type, $ttl, $transition, $channel_name);
参数
-
title
、message
、type
、ttl
与 常规 公告相同 -
transition
您想要的动画类型。
例如:淡入、弹跳等... 查看 Vue 转换,默认为:淡入
channel_name
改变它以覆盖配置值 "别忘了在组件文件中也更改它"
默认为:public-announcement-channel
公告显示
- 请注意,该包不关心您使用什么驱动程序
pusher
或socket.io
,它只是会工作 🍺。 - 我们还使用了 VueJs 2,但如果你想使用其他东西,请忽略以下内容,你可以自由构建自己的。
1- 将 Vue.component('my-announcement', require('./components/Announcement-bootstrap.vue'));
放入您的 app.js 文件
2- 将 <my-announcement></my-announcement>
放置在任何您希望此公告显示的位置。例如:您的 layout.blade.php 文件
如果您想使用类似
Animate.css
的东西,请按照 自定义过渡类 进行操作