Download the PHP package laupifrpar/pusher-bundle without Composer

LopiPusherBundle

This bundle let you use Pusher simply.

Pusher (Documentation) is a simple hosted API for adding realtime bi-directional functionality via WebSockets to web and mobile apps, or any other Internet connected device. It's super powerful, and a ton of fun!

This bundle is under the MIT license.

Installation

Use composer to install this bundle.

If you're not using Symfony Flex, then you will also need to enable Lopi\Bundle\PusherBundle\LopiPusherBundle in your config/bundles.php file.

Configuration

If you do not have a Pusher account, sign up and make a note of your API key before continuing.

General

To start, you'll need to setup a bit of configuration.

This is the default configuration in yml:

You must set the url parameter :

It will parse the URL and set, or replace the default value if exists, the various parameters scheme, key, secret, host, port and app_id

Or you can set the various parameters separately:

By default, calls will be made over a non-encrypted connection. To change this to make calls over HTTPS, simply:

If you want to use private or presence channels, set the parameter auth_service_id

See the section about "Private and Presense channel auth" below

Usage!

Once you've configured the bundle, you will have access to a pusher service, which can be autowired by Pusher\Pusher typehint. From inside a controller, you can use it like this:

This code will autowire \Pusher\Pusher class from the official Pusher SDK. You can find out all about it on pusher's documentation.

Private and Presence channel authentication (optional)

If you'd like to use private or presence, you need to add an authorization service.

First, create an authorization service that implements Lopi\Bundle\PusherBundle\Authenticator\ChannelAuthenticatorInterface:

Next, register it as service like normal:

Then include its service id in the lopi_pusher auth_service_id configuration parameter:

Additionally, enable the route by adding the following to your config\routing.yml configuration:

In some Symfony configurations, you may need to manually specify the channel_auth_endpoint: (not required in most setups):

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.

When reporting a bug, it may be a good idea to reproduce it in a basic project built using the Symfony Standard Edition to allow developers of the bundle to reproduce the issue by simply cloning it and following some steps.