Download the PHP package kanata-php/conveyor-laravel-broadcaster without Composer

On this page you can find all versions of the php package kanata-php/conveyor-laravel-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 kanata-php/conveyor-laravel-broadcaster

Informations about the package conveyor-laravel-broadcaster

Conveyor Laravel Broadcaster

This is a Laravel Integration for Socket Conveyor. It allows you to use the Conveyor WebSocket server as a broadcasting driver for Laravel. This package doesn't need Jacked Server, but just know that that web server is great!

This package allows the usage of Conveyor as a broadcasting driver in Laravel.

To understand how to broadcast with Laravel, visit Broadcasting.

Requirements

The companion server package kanata-php/socket-conveyor declares ext-openswoole: ^22. This package overrides the platform requirement via config.platform in composer.json, so newer openswoole versions install cleanly without --ignore-platform-req flags.

Quick Start

Table of Contents

Step 1: Install the package via composer

Step 2: Publish the configuration

Step 3: Add Service Provider

Laravel 10 backwards:

Laravel 11 onwards:

Step 4: Enable Laravel broadcasting

This is for Laravel 11 and forward, if in any other version just skip this step!

Step 5: Add broadcasting config

Add the following to your config/broadcasting.php file:

Step 6: Set configuration

Set the configurations for the WebSocket server in the .env file:

CONVEYOR_QUERY is the url query where we add the token you set to protect your WebSocket server.

Step 7: Create the tokens table

This package issues short-lived JWT tokens stored in a conveyor_tokens table. The package no longer ships a migration, so you must add one in your application:

Then in the generated migration:

Step 8: Install the Conveyor JS Client:

Important: Don't forget to run npm run build!

Add this to the bootstrap.js file of your Laravel app so the Conveyor client is available globally:

Remember to run npm install and npm run dev or npm run prod to compile the assets.

Info: If you want to send one-off messages to the Conveyor WebSocket server, you can just dispatch an event like follows:

Important: notice that we are using ShouldBroadcastNow instead of ShouldBroadcast. Conveyor doesn't need queueing and is much faster this way. If you want, you can still use queues.

Example of usage in a view with authorization at this point:

Then, add the route for this view at your routes/web.php file:

Extra: Simple Conveyor Server for this example

You can use this simple server to test your broadcasting (and in production...):

Remember to install conveyor with composer require kanata-php/socket-conveyor and run the server with php server.php.

License

Released under the MIT License.

All versions of conveyor-laravel-broadcaster with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
firebase/php-jwt Version ^6.10 || ^7.0
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 kanata-php/conveyor-laravel-broadcaster contains the following files

Loading the files please wait ...