Pusher Integration

Pusher Integration is a Drupal 8 module designed to provide a robust interface for integrating Pusher.com services into Drupal modules and apps. By itself, it doesn't do anything, but rather is a tool for Drupal developers to incorporate realtime message broadcasting into their modules and applications.

NOTE: This module is awaiting approval from the Drupal folks, and will appear in their repo soon! If you would like to use it in the meantime, follow the GitHub link in the left column of this page.

Requirements

• Drupal 8.x
• PHP 5.5 or higher (untested under PHP 7)
• An account at Pusher.com (at least a free sandbox account for smaller sites)

Known Issues

• None at this time

Installation Instructions

• Download and install the module (./modules/custom/push_integration)
• Configure the module (admin/config/pusher_integration)
• Install whatever other module needs it and go from there (e.g.SiteCommander)

Usage Information for Developers

Server-Side PHP

On the server side, in your app or module, you can simply broadcast commands as follows:

  use Drupal\pusher_integration\Controller\PusherController;
  ...
  $this->pusher = new PusherController( $configFactory, $currentUser );
  $data = array(
    'someVar' => 'Some value',
    'anotherVar' => 'Some other value'
  );

  // Broadcast an event to a single channel
  $this->pusher->broadcastMessage( $this->configFactory, 'my-channel-name-here', 'my-event-name-here', $data );
  ...
  // Broadcast an event to an array of channels
  $this->pusher->broadcastMessage( $this->configFactory, array('my-channel-name-here', 'channel2'), 'my-event-name-here', $data );
  ...
  // Get info on a specific channel
  $this->pusher->getChannelInfo( 'my-channel-name-here' );
  ...
  // Get list of channels
  $this->pusher->getChannelList();
  ...
  // Send any generic Pusher.com REST command
  $this->pusher->get('/channels');

Here is a more pseudo-complete example, with dependency injection:

<?php

/**
 * @file
 * Contains \Drupal\sitecommander\Controller\SiteCommanderController.
 */

namespace Drupal\my_module\Controller;

use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Config\ConfigFactory;
use Drupal\Core\Session\AccountInterface;

use Drupal\pusher_integration\Controller\PusherController;

class MyController extends ControllerBase {

  protected $configFactory;
  protected $currentUser;
  protected $pusher;

  public function __construct( ConfigFactory $configFactory, AccountInterface $account )
  {
    $this->configFactory = $configFactory;
    $this->currentUser = $account;

    $this->pusher = new PusherController( $configFactory, $currentUser );
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('config.factory'),
      $container->get('current_user'),
    );
  }

  ...

  public function foo()
  {
		...

    $data = array(
      'someVar' => 'Some value',
      'anotherVar' => 'Some other value'
    );

    $this->pusher->broadcastMessage( $this->configFactory, 'my-channel-name-here', 'my-event-name-here', $data );

		...
  }

	...
}
?>

Client-side Javascript

This module will create a global Javascript object simply called "pusher". You may use that to access the Pusher connection that is created automatically for you on page loads. 

Additionally, it will create the following global Javascript variables that can be used to access various Pusher channels:

pusherChannels: array of public channels the user is subscribed to. This is generally your default public channel, plus any default channels you've configured.

privateChannel:  If you've configured the option to automatically create a private channel, this will be set to the channel object.

presenceChannel:  If you've configured the option to automatically create a presence channel, this will be set to the channel handle.

...

// Bind to the "my-event-name-here" event on the private channel, so we can listen for it to come across the wire!
privateChannel.bind('my-event-name-here', function(data) {
    // Access your event information via the "data" object once the event is received by the client/browser
    console.log( data );
});

...

Here is an example of creating your own channel and subscribing to an event:

var myChannel;

if (pusher)
{
  myChannel = pusher.subscribe('my-channel-name-here');

  // Bind to the "my-event-name-here" event, so we can listen for it to come across the wire!
  myChannel.bind('my-event-name-here', function(data) {
    // Access your event information via the "data" object once the event is received by the client/browser
    console.log( data );
  });

}