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.
Use composer to install this bundle.
composer require laupifrpar/pusher-bundle
Then update your AppKernel.php
file to register the new bundle:
// in app/AppKernel::registerBundles()
$bundles = array(
// ...
new Lopi\Bundle\PusherBundle\LopiPusherBundle(),
// ...
);
If you do not have a Pusher account, sign up and make a note of your API key before continuing.
To start, you'll need to setup a bit of configuration.
This is the default configuration in yml:
# 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 :
# app/config/config.yml
lopi_pusher:
url: <scheme>:https://<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
Or you can set the various parameters separately :
# 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:
# 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
# app/config/config.yml
lopi_pusher:
auth_service_id: <the_auth_service_id>
See the section about "Private and Presense channel auth" below
Once you've configured the bundle, you will have access to a lopi_pusher.pusher
service. From inside a controller, you can use it like this:
public function triggerPusherAction()
{
/** @var \Pusher $pusher */
$pusher = $this->container->get('lopi_pusher.pusher');
$data['message'] = 'hello world';
$pusher->trigger('test_channel', 'my_event', $data);
// ...
}
The lopi_pusher.pusher
returns an instance of the \Pusher
class from the official
Pusher SDK. You can find out all about it on
pusher's documentation.
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
:
<?php
// src/AppBundle/Pusher/ChannelAuthenticator.php
namespace AppBundle\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:
# app/config/services.yml
services:
my_channel_authenticator:
class: AppBundle\Pusher\ChannelAuthenticator
arguments: []
Then include its service id in the lopi_pusher auth_service_id
configuration
parameter:
# app/config/config.yml
lopi_pusher:
# ...
auth_service_id: my_channel_authenticator
Additionally, enable the route by adding the following to your app\config\routing.yml
configuration:
# app\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):
{# app/Resources/views/base.html.twig #}
<script type="text/javascript">
Pusher.channel_auth_endpoint = "{{ path('lopi_pusher_bundle_auth') }}";
</script>
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.