A Pub-Sub abstraction for Laravel 4.
This package is a wrapper bridging php-pubsub into Laravel 4.
For Laravel 5 support, use the package https://github.com/Superbalist/laravel-pubsub
The following adapters are supported:
- Local
- /dev/null
- Redis
- Kafka (see separate installation instructions below)
- Google Cloud
- HTTP
composer require superbalist/laravel4-pubsubThe package has a default configuration built-in.
To customize the configuration file, publish the package configuration using Artisan.
php artisan config:publish superbalist/laravel4-pubsubYou can then edit the generated config at app/config/packages/superbalist/laravel4-pubsub/config.php.
Register the service provider in app.php
'providers' => [ // ... 'Superbalist\Laravel4PubSub\PubSubServiceProvider' ]Register the facade in app.php
'aliases' => [ // ... 'PubSub' => 'Superbalist\Laravel4PubSub\PubSubFacade', ]Please note that whilst the package is bundled with support for the php-pubsub-kafka adapter, the adapter is not included by default.
This is because the KafkaPubSubAdapter has an external dependency on the librdkafka c library and the php-rdkafka PECL extension.
If you plan on using this adapter, you will need to install these dependencies by following these installation instructions.
You can then include the adapter using:
composer require superbalist/php-pubsub-kafka// get the pub-sub manager $pubsub = app('pubsub'); // note: function calls on the manager are proxied through to the default connection // eg: you can do this on the manager OR a connection $pubsub->publish('channel_name', 'message'); // get the default connection $pubsub = app('pubsub.connection'); // or $pubsub = app(\Superbalist\PubSub\PubSubAdapterInterface::class); // get a specific connection $pubsub = app('pubsub')->connection('redis'); // publish a message // the message can be a string, array, bool, object - anything which can be json encoded $pubsub->publish('channel_name', 'this is where your message goes'); $pubsub->publish('channel_name', ['key' => 'value']); $pubsub->publish('channel_name', true); // publish multiple messages $messages = [ 'message 1', 'message 2', ]; $pubsub->publishBatch('channel_name', $messages); // subscribe to a channel $pubsub->subscribe('channel_name', function ($message) { var_dump($message); }); // all the above commands can also be done using the facade PubSub::connection('kafka')->publish('channel_name', 'Hello World!'); PubSub::connection('kafka')->subscribe('channel_name', function ($message) { var_dump($message); });A lot of pub-sub adapters will contain blocking subscribe() calls, so these commands are best run as daemons running as a supervisor process.
This is a sample subscriber written as an artisan command.
<?php namespace App\Commands; use App; use Illuminate\Console\Command; class MyExampleSubscriber extends Command { /** * The name and signature of the subscriber command. * * @var string */ protected $name = 'subscriber:name'; /** * The subscriber description. * * @var string */ protected $description = 'PubSub subscriber for ________'; /** * Execute the console command. */ public function fire() { $pubsub = App::make('pubsub'); $pubsub->subscribe('channel_name', function ($message) { }); } }For subscribers which use the php-pubsub-kafka adapter, you'll likely want to change the consumer_group_id per subscriber.
To do this, you need to use the PubSubConnectionFactory to create a new connection per subscriber. This is because the consumer_group_id cannot be changed once a connection is created.
Here is an example of how you can do this:
<?php namespace App\Commands; use App; use Config; use Illuminate\Console\Command; class MyExampleKafkaSubscriber extends Command { /** * The name and signature of the subscriber command. * * @var string */ protected $name = 'subscriber:name'; /** * The subscriber description. * * @var string */ protected $description = 'PubSub subscriber for ________'; /** * Execute the console command. */ public function fire() { $config = Config::get('laravel4-pubsub::connections.kafka'); $config['consumer_group_id'] = self::class; $factory = App::make('pubsub.factory'); $pubsub = $factory->make('kafka', $config); $pubsub->subscribe('channel_name', function ($message) { }); } }Please see the php-pubsub documentation Writing an Adapter.
To include your custom driver, you can call the extend() function.
$manager = app('pubsub'); $manager->extend('custom_connection_name', function ($config) { // your callable must return an instance of the PubSubAdapterInterface return new MyCustomPubSubDriver($config); }); // get an instance of your custom connection $pubsub = $manager->connection('custom_connection_name');