mallardduck/dynamic-echo-events

一个允许动态注册laravel-echo事件的库,完全由PHP编写。

0.9.0 2020-11-22 18:36 UTC

README

Travis Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version License Coveralls Coverage Status Code Intelligence Status

一个用于动态生成注册Echo事件监听器的JavaScript的辅助库。

您不需要手动编写JS代码来注册Echo事件监听器,只需在Event中定义JS处理器回调。然后添加ImplementsDynamicEcho接口和使用PrivateDynamicEchoChannel特性。

安装

您可以通过composer安装此包

composer require mallardduck/dynamic-echo-events

您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="MallardDuck\DynamicEcho\DynamicEchoServiceProvider" --tag="config"

这是发布配置文件的内容

return [
    'namespace' => env('DYNAMIC_ECHO_NS', 'App\\Events')
];

使用方法

首先,您需要确保您的网站的app.js文件正确配置了Echo JavaScript客户端。这确保生成的代码具有必要的要求。

然后,修改您网站的基础主题文件以加载动态Echo生成的JavaScript。这应该在模板中加载主app.js的位置进行。

添加以下内容

@dynamicEcho

最后,当您想要在浏览器中自动注册事件时,请使用Event接口和特性。这只需将ImplementsDynamicEcho接口和PrivateDynamicEchoChannel特性添加到事件中即可。

查看examples文件夹,了解如何实现的示例。

测试

composer test

变更日志

有关最近更改的更多信息,请参阅变更日志

鸣谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件