README

Laravel now has built-in support for Pusher Channels. This is now the recommended approach to integrate Channels into a Laravel project.

Currently, Pusher will continue to review any PRs and solve security vulnerabilities in this SDK, but will not be making any major improvements going forward.

Pusher Channels Laravel Library

A Pusher Channels bridge for Laravel. Formerly vinkla/pusher.

// Triggering events.
$pusher->trigger('my-channel', 'my_event', 'hello world');

// Authenticating Private channels.
$pusher->socket_auth('my-channel', 'socket_id');

// Want to use the facade?
Pusher::get('/channels');

Installation

Require this package, with Composer, in the root directory of your project.

$ composer require pusher/pusher-http-laravel

Add the service provider to config/app.php in the providers array. If you're using Laravel 5.5 or greater, there's no need to do this.

Pusher\Laravel\PusherServiceProvider::class

If you want you can use the facade. Add the reference in config/app.php to your aliases array.

'Pusher' => Pusher\Laravel\Facades\Pusher::class

Configuration

The Laravel Channels SDK requires connection configuration. To get started, you'll need to publish all vendor assets:

$ php artisan vendor:publish --provider="Pusher\Laravel\PusherServiceProvider"

This will create a config/pusher.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

Default Connection Name

This option default is where you may specify which of the connections below you wish to use as your default connection for all work. Of course, you may use many connections at once using the manager class. The default value for this setting is main.

Channels Connections

This option connections is where each of the connections are setup for your application. Example configuration has been included, but you may add as many connections as you would like.

Encrypted Channels

To enable end to end encrypted channels, you need to uncomment a line from the Channels config file

'app_id' => env('APP_ID'),
'options' => [
    'cluster' => env('APP_CLUSTER'),
    'encryption_master_key' => env('ENCRYPTION_MASTER_KEY'),
],
'host' => null,
'port' => null,

Then you need to set an encryption_master_key in your .env file. You should then be able to publish encrypted events to channels prefixed with private-encrypted and you can validate this is working by checking the (dashboard)[https://dashboard.pusher.com] debug console for your app!

Usage

PusherManager

This is the class of most interest. It is bound to the ioc container as pusher and can be accessed using the Facades\Pusher facade. This class implements the ManagerInterface by extending AbstractManager. The interface and abstract class are both part of Graham Campbell's Laravel Manager package, so you may want to go and checkout the docs for how to use the manager class over at that repository. Note that the connection class returned will always be an instance of Pusher.

Facades\Pusher

This facade will dynamically pass static method calls to the pusher object in the ioc container which by default is the PusherManager class.

PusherServiceProvider

This class contains no public methods of interest. This class should be added to the providers array in config/app.php. This class will setup ioc bindings.

Examples

Here you can see an example of just how simple this package is to use. Out of the box, the default adapter is main. After you enter your authentication details in the config file, it will just work:

// You can alias this in config/app.php.
use Pusher\Laravel\Facades\Pusher;

Pusher::trigger('my-channel', 'my-event', ['message' => $message]);
// We're done here - how easy was that, it just works!

Pusher::getSettings();
// This example is simple and there are far more methods available.

The PusherManager will behave like it is a Pusher. If you want to call specific connections, you can do that with the connection method:

use Pusher\Laravel\Facades\Pusher;

// Writing this…
Pusher::connection('main')->log('They see me logging…');

// …is identical to writing this
Pusher::log('They hatin…');

// and is also identical to writing this.
Pusher::connection()->log('Tryin to catch me testing dirty…');

// This is because the main connection is configured to be the default.
Pusher::getDefaultConnection(); // This will return main.

// We can change the default connection.
Pusher::setDefaultConnection('alternative'); // The default is now alternative.

If you prefer to use dependency injection over facades like me, then you can inject the manager:

use Pusher\Laravel\PusherManager;

class Foo
{
    protected $pusher;

    public function __construct(PusherManager $pusher)
    {
        $this->pusher = $pusher;
    }

    public function bar()
    {
        $this->pusher->trigger('my-channel', 'my-event', ['message' => $message]);
    }
}

App::make('Foo')->bar();

Documentation

There are other classes in this package that are not documented here. This is because the package is a Laravel wrapper of the official Channels package.

nexwap / pusher-http-laravel

Maintainers

Details