growler/growler

Growl binding for PHP

Growler - A pure PHP Growl notification library

, _(*1)

Class loading

If you have installed the package with composer, it will provide autoloading feature:, _(*2)

require_once 'vendor/.composer/autoload.php';

Otherwise, if you already use in your project a PSR-0 compliant autoloader, simply register the "Growler" namespace:, _(*3)

// This is based on the Symfony2 Class Loader
$loader->registerNamespace('Growler', 'growler/src');

Otherwise, a basic autoloader is included in the Growler distribution:, _(*4)

require_once 'growler/src/Growler/ClassLoader.php';
Growler\ClassLoader::register();

UDP protocol

Historical versions of Growl (< 1.3), listen to the UDP port 9887 for incoming messages that represents notifications to display, _(*5)

The protocol is very simple:, _(*6)

• supports only title and message, no custom icon
• on the same socket you can send as many messages as you want, no response from the other side

The UDP procol implementation is feature-complete., _(*7)

This is an example for creating a UDP based transport:, _(*8)

$connection  = new Growler\Connection("udp", "localhost", 9887);
$transport   = new Growler\Transport\Udp($connection);

GNTP protocol

From Growl 1.3 has been introduced the new TCP-based GNTP protocol., _(*9)

GNTP is a protocol to allow two-way communication between applications and centralized notification systems such as Growl for Mac OS X and to allow two-way communication between two machines running centralized notification systems for notification forwarding purposes., _(*10)

Missing GNTP features:, _(*11)

• Message encryption. In the current version of Growl (1.3.2), encryption is not supported yet. Is only defined in the protocol specification
• Subscribing and callbacks.

This is an example for creating a GNTP based transport:, _(*12)

$connection  = new Growler\Connection("tcp", "localhost", 23053);
$transport   = new Growler\Transport\Gntp($connection);

Password protection

Either the UDP and the GNTP protocols, support server password. Just add the password as the second parameter in transport creation:, _(*13)

$transport   = new Growler\Transport\Gntp($connection, "secret");

Other TODOs

• Error handling
• A Facade for simpler use out-of-the-box

Examples

Code samples are available in the "examples" directory, _(*14)