Download the PHP package opekunov/laravel-centrifugo-broadcaster without Composer

On this page you can find all versions of the php package opekunov/laravel-centrifugo-broadcaster. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of opekunov/laravel-centrifugo-broadcaster

Informations about the package laravel-centrifugo-broadcaster

Documentation EN | RU

Latest Version Tests Code Quality Coverage Total Downloads Software License

Laravel Centrifugo 5-6 Broadcaster

Centrifugo 5-6 broadcast driver for Laravel 8.75 - 13.x

For Centrifugo 4.x use version 2.x
For Centrifugo 2.8 - 3.x use version 1.2.6

Features

Requirements

Installation

Require this package with composer:

Laravel 10 and below: Open your config/app.php and uncomment BroadcastServiceProvider:

Laravel 11+: Run the install command which will automatically create the necessary configuration:

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 the broadcast driver setting in your .env file!

Laravel 11+:

Laravel 10 and below:

Basic Usage

To configure Centrifugo server, read official documentation

For broadcasting events, see official documentation of laravel

Channel authentication example:

Laravel

Frontend. See documentation centrifugal/centrifuge-js

Broadcasting example

Create event (for example SendMessage) with artisan php artisan make:event SendMessageEvent

A simple client usage example:

History example

Centrifugo allows you to retrieve the history of messages in a channel (the channel must have history configured on the server side).

Backend (Laravel):

Frontend (centrifuge-js):

Presence example

Presence allows you to see which users are currently subscribed to a channel (must be enabled in Centrifugo server config).

Backend (Laravel):

Frontend (centrifuge-js):

Server-side subscribe/unsubscribe example

You can manage subscriptions from the backend without client involvement:

Available methods

Name Description
publish(string $channel, array $data) Send message into channel.
broadcast(array $channels, array $data) Send message into multiple channel.
publishMany(array $data) Send multiple data to multiple channels. $data - array of data arrays [channel, data]
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, int $limit = 0, ?int $offset = null, ?string $epoch = null, bool $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, array $info = [], array $data = []) Subscribe user to channel (server-side).
unsubscribe(string $channel, string $user) Unsubscribe user from channel.
disconnect(string $userId) Disconnect user by it's ID.
rpc(string $method, array $data = []) Remote procedure call.
channels(string $pattern = '') Get channels information (list of currently active channels).
info() Get stats information about running server nodes.
generateConnectionToken(string|int $userId, int|Carbon $exp = 0, array $info = [], array $channels = []) Generate connection token.
generateSubscriptionToken(string|int $userId, string $channel, int|Carbon $exp = 0, array $info = [], array $override = []) Generate subscription token.

License

The MIT License (MIT). Please see License File for more information.

All versions of laravel-centrifugo-broadcaster with dependencies

PHP Build Version
Package Version
Requires php Version ^8.0|^8.1|^8.2|^8.3|^8.4
laravel/framework Version ^8.75|^9.0|^10.0|^11.0|^12.0|^13.0
ext-json Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package opekunov/laravel-centrifugo-broadcaster contains the following files

Loading the files please wait ...