Download the PHP package slivka-b/laravel-centrifugo without Composer
On this page you can find all versions of the php package slivka-b/laravel-centrifugo. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download slivka-b/laravel-centrifugo
More information about slivka-b/laravel-centrifugo
Files in slivka-b/laravel-centrifugo
Package laravel-centrifugo
Short Description Centrifugo broadcaster for laravel 6.20.26-8 and Centrifugo >= 2.8.1
License MIT
Homepage https://github.com/denis660/laravel-centrifugo
Informations about the package laravel-centrifugo
Documentation EN | RU
Laravel + Centrifugo
Centrifugo broadcast driver for Laravel 8.75.0 - 9
Introduction
Centrifugo broadcaster for laravel , based on:
Features
- Compatible with latest Centrifugo 3.2.0 🚀
- Wrapper over Centrifugo HTTP API 🔌
- Authentication with JWT token (HMAC algorithm) for anonymous, authenticated user and private channel 🗝️
Requirements
- PHP >= 7.4 , 8.0, 8.1
- Laravel 8.75.0 - 9.0
- guzzlehttp/guzzle 6 - 7
- Centrifugo Server 3.2.0 or newer (see here)
Installation
Require this package with composer:
Open your config/app.php and add the following to the providers array:
Open your config/broadcasting.php and add new connection like this:
Also you should add these two lines to your .env file:
These lines are optional:
Don't forget to change BROADCAST_DRIVER
setting in .env file!
Basic Usage
To configure Centrifugo server, read official documentation
For broadcasting events, see official documentation of laravel
A simple client usage example:
Available methods
Name | Description |
---|---|
publish(string $channel, array $data, $skipHistory = false) | Send message into channel. |
broadcast(array $channels, array $data, $skipHistory = false) | Send message into multiple channel. |
presence(string $channel) | Get channel presence information (all clients currently subscribed on this channel). |
presenceStats(string $channel) | Get channel presence information in short form (number of clients). |
history(string $channel, $limit = 0, $since = [], $reverse = false) | Get channel history information (list of last messages sent into channel). |
historyRemove(string $channel) | Remove channel history information. |
subscribe(string $channel, string $user, $client = '') | subscribe user from channel. |
unsubscribe(string $channel, string $user, string $client = '') | Unsubscribe user from channel. |
disconnect(string $user_id) | Disconnect user by it's ID. |
channels(string $pattern = '') | Get channels information (list of currently active channels). |
info() | Get stats information about running server nodes. |
generateConnectionToken(string $userId = '', int $exp = 0, array $info = [], array $channels = []) | Generate connection token. |
generatePrivateChannelToken(string $client, string $channel, int $exp = 0, array $info = []) | Generate private channel token. |
License
The MIT License (MIT). Please see [License File](https://github.com/denis660/laravel-centrifugo/blob/master/LICENSE for more information.
All versions of laravel-centrifugo with dependencies
laravel/framework Version ^8.75.0|^9.0|^10.0
guzzlehttp/guzzle Version ~6.0|^7.0