README

Laravel SSE

Laravel 包，为您的应用程序提供服务器端事件功能。您可以使用此包在不刷新页面的情况下向用户显示即时通知。

需求

• PHP >= 7
• Laravel 5

安装

通过 Composer

$ composer require sarfraznawaz2005/laravel-sse

对于 Laravel < 5.5

将服务提供者添加到 config/app.php 文件中的 providers 部分

Sarfraznawaz2005\SSE\ServiceProvider::class,

将外观添加到 config/app.php 文件中的 aliases 部分

'SSE' => Sarfraznawaz2005\SSE\Facades\SSEFacade::class,

通过运行以下命令发布包的配置、迁移和视图文件

$ php artisan vendor:publish --provider="Sarfraznawaz2005\SSE\ServiceProvider"

运行 php artisan migrate 创建 sselogs 表。

设置 SSE

在 config/sse.php 文件中设置配置选项，然后在您的视图/布局文件中添加以下内容

@include('sse::view')

用法

语法

/**
 * @param string $message : notification message
 * @param string $type : alert, success, error, warning, info
 * @param string $event : Type of event such as "EmailSent", "UserLoggedIn", etc
 */
SSEFacade::notify($message, $type = 'info', $event = 'message')

要在屏幕上显示弹出通知，在您的控制器/事件类中，您可以这样做

use Sarfraznawaz2005\SSE\Facades\SSEFacade;

public function myMethod()
{
    SSEFacade::notify('hello world....');
    
    // or via helper
    sse_notify('hi there');
}

自定义通知库

默认情况下，此包使用 noty 来显示通知。您可以通过修改 resources/views/vendor/sse/view.blade.php 文件中的代码来自定义此功能。

自定义 SSE 事件

默认情况下，包使用 message 事件类型进行流式响应

SSEFacade::notify($message, $type = 'info', $event = 'message')

注意 $event = 'message'。您可以自定义此功能，例如，如果您想使用 UserLoggedIn 作为 SSE 事件类型

use Sarfraznawaz2005\SSE\Facades\SSEFacade;

public function myMethod()
{
    SSEFacade::notify('hello world....', 'info', 'UserLoggedIn');
    
    // or via helper
    sse_notify('hi there', 'info', 'UserLoggedIn');
}

然后您需要自行在视图中处理此事件，如下所示

<script>
var es = new EventSource("{{route('__sse_stream__')}}");

es.addEventListener("UserLoggedIn", function (e) {
    var data = JSON.parse(e.data);
    alert(data.message);
}, false);

</script>

鸣谢

• Sarfraz Ahmed
• 所有贡献者

许可

请参阅 许可文件 获取更多信息。