laupifrpar/pusher-bundle

A Pusher bundle for Symfony2

Saturday, April 14, 2018
by laupifrpar
Repository
5 Watchers
53 Stars
146,792 Installations

PHP
1 Dependents
0 Suggesters
31 Forks
6 Open issues
21 Versions
7 % Grown

The README.md

LopiPusherBundle

, _(*1)

This bundle let you use Pusher simply., _(*2)

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!, _(*3)

This bundle is under the MIT license., _(*4)

Installation

Use composer to install this bundle., _(*5)

composer require laupifrpar/pusher-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., _(*6)

<?php

return [
    // ...
    Lopi\Bundle\PusherBundle\LopiPusherBundle::class => ['all' => true],
    // ...
];

Configuration

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

General

To start, you'll need to setup a bit of configuration., _(*8)

This is the default configuration in yml:, _(*9)

# app/config/config.yml
lopi_pusher:
    # Default configuration
    scheme: http
    host: api.pusherapp.com
    port: 80
    cluster: us-east-1 # Change the cluster name
    timeout: 30
    debug: false # true if you want use the debug of all requests

You must set the url parameter :, _(*10)

# app/config/config.yml
lopi_pusher:
    url: <scheme>://<key>:<secret>@<host>[:<port>]/apps/<app-id>

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, _(*11)

Or you can set the various parameters separately:, _(*12)

# app/config/config.yml
lopi_pusher:
    app_id: <app-id>
    key: <key>
    secret: <secret>

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

# app/config/config.yml
lopi_pusher:
    # ...
    scheme: https
    port: 443

If you want to use private or presence channels, set the parameter auth_service_id, _(*14)

# app/config/config.yml
lopi_pusher:
    # ...
    auth_service_id: <the_auth_service_id>

See the section about "Private and Presense channel auth" below, _(*15)

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:, _(*16)

use Pusher\Pusher;

class SampleController
{
    public function triggerPusherAction(Pusher $pusher)
    {
        // ...

        $data['message'] = 'hello world';
        $pusher->trigger('test_channel', 'my_event', $data);

        // ...
    }
}

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

Private and Presence channel authentication (optional)

If you'd like to use private or presence, you need to add an authorization service., _(*18)

First, create an authorization service that implements Lopi\Bundle\PusherBundle\Authenticator\ChannelAuthenticatorInterface:, _(*19)

<?php
// src/Pusher/ChannelAuthenticator.php

namespace App\Pusher;

use Lopi\Bundle\PusherBundle\Authenticator\ChannelAuthenticatorInterface;

class ChannelAuthenticator implements ChannelAuthenticatorInterface
{
    public function authenticate($socketId, $channelName)
    {
        // logic here

        return true;
    }
}

Next, register it as service like normal:, _(*20)

# config/services.yml
services:
    my_channel_authenticator: AppBundle\Pusher\ChannelAuthenticator

Then include its service id in the lopi_pusher auth_service_id configuration parameter:, _(*21)

# config/packagers/lopi_pusher.yml
lopi_pusher:
    # ...

    auth_service_id: 'my_channel_authenticator'

Additionally, enable the route by adding the following to your config\routing.yml configuration:, _(*22)

# config\routing.yml
lopi_pusher:
    resource: "@LopiPusherBundle/Resources/config/routing.xml"
    prefix:   /pusher

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

{# app/Resources/views/base.html.twig #}

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker., _(*24)

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., _(*25)

The Versions

14/04 2018

dev-master

9999999-dev https://github.com/laupifrpar/lopipusherbundle

A Pusher bundle for Symfony2

symfony-bundle pusher-bundle

A Pusher bundle for Symfony2

laupifrpar/pusher-bundle

The README.md

LopiPusherBundle

Installation

Configuration

General

Usage!

Private and Presence channel authentication (optional)

Reporting an issue or a feature request

The Versions

dev-master

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

2.0.1

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

3.x-dev

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

dev-feature/refactor

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

2.0.0

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.5.2

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.5.1

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.5.0

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.4.0

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.3.0

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.2.9

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.2.8

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.2.7

The Requires

The Development Requires

by Community contributors

by Pierre-Louis Launay

1.2.6

The Requires

The Development Requires