README

注意！可能与现实情况存在差异。

1. 此包从 "LaraComponents" 分支出来以适应新的 Centrifugo v2。
2. 移除 Redis 支持（v2 不支持），请参阅官方的 迁移指南。
3. 更新 generateToken(user id, timestamp, info) 方法（v2 仅使用 jwt 验证工作流程）。

简介

Centrifuge broadcaster for laravel ^6

要求

• PHP 7.2+
• Laravel 6+
• Centrifugo 服务器 2 或更高版本（请参阅 此处）

安装

使用 composer 安装此包

composer require emprove/centrifuge-broadcaster

打开您的 config/app.php 并将以下内容添加到 providers 数组中

'providers' => [
    // ...
    Emprove\Centrifugo\CentrifugoServiceProvider::class,

    // And uncomment BroadcastServiceProvider
    App\Providers\BroadcastServiceProvider::class,
],

打开您的 config/broadcasting.php 并将以下内容添加到其中

'connections' => [
    'centrifuge' => [
        'driver'       => 'centrifuge',
        'url'          => env('CENTRIFUGE_URL', 'http://127.0.0.1:8000'),
        'token_ttl'    => env('CENTRIFUGE_TOKEN_TTL', 3600),
        'token_issuer' => env('APP_URL', 'default'),
        'secret'       => env('CENTRIFUGE_SECRET', null),
        'api_key'      => env('CENTRIFUGE_API_KEY', null),
        'ssl_key'      => env('CENTRIFUGE_SSL_KEY', null),
        'verify'       => env('CENTRIFUGE_VERIFY', false),
    ],
    // ...
],

您还可以在 .env 文件中添加配置

CENTRIFUGE_API_KEY=very-long-secret-api-key
CENTRIFUGE_SECRET=very-long-secret-key
CENTRIFUGE_URL=https://:8000
CENTRIFUGE_SSL_KEY=/etc/ssl/some.pem
CENTRIFUGE_TOKEN_TTL=3600 # seconds
CENTRIFUGE_VERIFY=false

不要忘记安装广播驱动程序

BROADCAST_DRIVER=centrifuge

基本用法

要配置 Centrifugo 服务器，请阅读 官方文档

有关广播事件的详细信息，请参阅 laravel 官方文档

使用客户端的简单示例

<?php

namespace App\Http\Controllers;

use Emprove\Centrifugo\Contracts\Centrifugo;

class ExampleController extends Controller
{
    public function home(Centrifugo $centrifuge)
    {
        // Send message into channel
        $centrifuge->publish('channel-name', [
            'key' => 'value'
        ]);

        // Generate api sign
        $apiSign = $centrifuge->generateApiSign('data');

        // ...
    }
}

可用方法

许可协议

MIT 许可协议 (MIT)。请参阅 许可文件 了解更多信息。