anchu/faye-php

This is a PHP wrapper for interacting with the Faye server.

dev-master 2013-11-18 05:48 UTC

Requires

• php: >=5.3.0
• ext-curl: *

MIT

• Harish A

• rest
• events
• publish
• realtime
• trigger
• php-faye-server
• faye

README

#Faye PHP Library

This is a PHP library for interacting with the Faye server. Faye is a publish-subscribe messaging system based on the Bayeux protocol.

##Installation

You can get the Faye PHP library via composer package. See https://packagist.org/packages/anchu/faye-php

Or you can clone or download the library files.

##Faye constructor

Use the Faye server configurations to create a new Faye instance.

$host = 'YOUR_FAYE_HOST';
$mountPoint = 'YOUR_FAYE_MOUNT_POINT';
$port = 'YOUR_FAYE_PORT'; //by default this will be 8000

$faye = new Faye($host, $mountPoint, $port);

##Publishing/Triggering messges

To trigger a message on a channel use the trigger function.

$faye->trigger( 'my-channel', 'my_event', 'hello world' );

###Arrays

Objects are automatically converted to JSON format:

$array['status'] = 'success';
$array['action'] = 'continue';

$faye->trigger('my_channel', 'my_event', $array);

The output of this will be:

"{'event': 'my_event', 'message': {'status': 'success', 'action': 'continue'}}"

##License

Copyright 2013, Harish A. Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php