Net_Growl Class

Synopsis

<?php
class Net_Growl
{
    /* constants */
    const string VERSION;
    const int UDP_PORT;
    const int GNTP_PORT;
    const int PRIORITY_LOW;
    const int PRIORITY_MODERATE;
    const int PRIORITY_NORMAL;
    const int PRIORITY_HIGH;
    const int PRIORITY_EMERGENCY;

    /* properties */
    protected array $options;
    protected array $growlNotificationCallback;
    protected int $growlNotificationCount;
    protected bool $isRegistered;
    protected static object $instance;

    private object $_application;
    private int $_growlNotificationLimit;
    private resource $_fp;

    /* methods */
    public static final object singleton(mixed &$application, array $notifications [, string $password = '' [, array $options = array()]] );
    public static final void reset();
    public void __destruct();
    public array getOptions();
    public void setNotificationLimit($max);
    public object getApplication();
    public bool | Net_Growl_Response register();
    public bool | Net_Growl_Response notify(string $name, string $title [, string $description = '' [, array $options = array()]] )
    public bool | Net_Growl_Response publish(string $name, string $title [, string $description = '' [, array $options = array()]] )
    public string getDefaultGrowlIcon();
    public static void autoload($class);
    public void errorHandler(int $errno, string $errstr, string $errfile, int $errline);

    protected object __construct(mixed &$application, array $notifications [, string $password = '' [, array $options = array()]] );
    protected bool | Net_Growl_Response sendRequest(string $method, mixed $data [, bool $callback = false] );
    protected void debug(string $message [, string $priority = 'debug']);
    protected string utf8Encode($data);
    protected int strByteLen($string);

    private string _readLine(resource $fp);
}

Constants

Methods

Net_Growl::singleton

Makes sure there is only one Growl connection open.

mixed $application

Can be either a Net_Growl_Application object or the application name string

array $notifications

List of notification types

string $password

(optional) Password for Growl

array $options

(optional) List of options :

• host, port, protocol, timeout

  • for Growl socket server

• passwordHashAlgorithm, encryptionAlgorithm

  • to secure communications

• debug

  • to know what data are sent and received.

Net_Growl_Exception

if class handler does not exists

object - Net_Growl

Net_Growl::setNotificationLimit

This method limits the number of notifications to be displayed on the Growl user desktop. By default, there is no limit. It is used mostly to prevent problem with notifications within loops.

int $max

Maximum number of notifications

no exceptions thrown

void

Net_Growl::getApplication

Returns the registered application object

no exceptions thrown

object - Net_Growl_Application

Net_Growl::register

Sends a application register to Growl

Net_Growl_Exception

if REGISTER failed

void

Net_Growl::notify

Sends a notification to Growl

Growl notifications have a name, a title, a description and a few options, depending on the kind of display plugin you use. The bubble plugin is recommended, until there is a plugin more appropriate for these kind of notifications.

The current options supported by most Growl plugins are:

<?php
 array('priority' => 0, 'sticky' => false);

string $name

Notification name

string $title

Notification title

string $description

(optional) Notification description

string $options

(optional) few Notification options

Net_Growl_Exception

if NOTIFY failed

bool - true

Net_Growl::getDefaultGrowlIcon

Returns Growl default icon logo binary data. Decodes data encoded with MIME base64

bool $return

(optional) If used and set to FALSE, getDefaultGrowlIcon() will output the binary representation instead of return it

string $ver

(optional) Icon version

no exceptions thrown

string - icon logo binary data

<?php
require_once 'Net/Growl/Autoload.php';

Net_Growl::getDefaultGrowlIcon(false);
?>

Net_Growl::autoload

Autoloader for PEAR compatible classes

string $class

Class name

Net_Growl_Exception

if class handler cannot be loaded

void

Net_Growl::errorhandler

Throws ErrorException when a standard error occured with severity level we are asking for (uses error_reporting)

int $errno

contains the level of the error raised

string $errstr

contains the error message

string $errfile

contains the filename that the error was raised in

string $errline

contains the line number the error was raised at

ErrorException

corresponding to standard error/warning/notice raised

void

Net_Growl::getOptions

Gets options used with current Growl object

array

Net_Growl::publish

Sends a notification to Growl. Alias of notify() method.

Growl notifications have a name, a title, a description and a few options, depending on the kind of display plugin you use. The bubble plugin is recommended, until there is a plugin more appropriate for these kind of notifications.

The current options supported by most Growl plugins are:

<?php
 array('priority' => 0, 'sticky' => false);

string $name

Notification name

string $title

Notification title

string $description

(optional) Notification description

string $options

(optional) few Notification options

Net_Growl_Exception

if NOTIFY failed

bool - true

Net_Growl_Application Class

Synopsis

<?php
class Net_Growl_Application
{
    /* properties */
    private string $_growlAppName;
    private string $_growlAppPassword;
    private Net_Growl_Icon $_growlAppIcon;
    private array $_growlNotifications;

    /* methods */
    public object __construct([mixed $appName = null [, array $notifications = null [, string $password = null [, string $appIcon = null]]]] );
    public void addGrowlNotifications(array $notifications);
    public array getGrowlNotifications();
    public string setGrowlName(string $appName);
    public string getGrowlName();
    public string setGrowlPassword(string $password);
    public string getGrowlPassword();
    public string setGrowlIcon(mixed $appIcon);
    public string getGrowlIcon();

}

Methods

Net_Growl_Application::__construct

Constructs a new application to be registered by Growl

string $appName

Application name

array $notifications

Array of notifications

string $password

(optional) Password to be used to notify Growl

string $appIcon

(optional) Application icon

no exceptions thrown

object - Net_Growl_Application

<?php
require_once 'Net/Growl/Autoload.php';
require_once 'PEAR.php';

define('GROWL_NOTIFY_PEARERROR', 'PEAR_Error');

function growlErrors($error)
{
    static $app;

    if (!isset($app)) {
        $app = new Net_Growl_Application(
            'Net_Growl', array(GROWL_NOTIFY_PEARERROR), 'mamasam'
        );
    }

    $growl = Net_Growl::singleton(
        $app, null, null, array('host' => '127.0.0.1')
    );
    $growl->notify(GROWL_NOTIFY_PEARERROR,
        get_class($error),
        $error->message.' in '.$_SERVER['SCRIPT_NAME'],
        array('sticky' => true)
    );
}

PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, 'growlErrors');

PEAR::raiseError("The expected error you submitted does not exist");
?>

Net_Growl_Application::addGrowlNotifications

Adds notifications supported by this application

Expected array format is:

<?php
 array('notification name' => array('option name' => 'option value'));

At the moment, only option name enabled is supported. Example:

<?php
 $notifications = array('Test Notification' => array('enabled' => true));

array $notifications

Array of notifications to support

InvalidArgumentException

void

Net_Growl_Application::getGrowlNotifications

Returns the notifications accepted by Growl for this application

Expected array format is:

<?php
 array('notification name' => array('option name' => 'option value'));

At the moment, only option name enabled is supported. Example:

<?php
 $notifications = array('Test Notification' => array('enabled' => true));
 return $notifications;

no exceptions thrown

array - list of notifications type

Net_Growl_Application::setGrowlName

Sets the application name for registration in Growl

InvalidArgumentException

void

Net_Growl_Application::getGrowlName

Returns the application name for registration in Growl

no exceptions thrown

string — application name

Net_Growl_Application::setGrowlPassword

Sets the password to be used by Growl to accept notification packets

InvalidArgumentException

void

Net_Growl_Application::getGrowlPassword

Returns the password to be used by Growl to accept notification packets

no exceptions thrown

string — password

Net_Growl_Application::setGrowlIcon

Sets the application icon for registration in Growl

InvalidArgumentException

void

Net_Growl_Application::getGrowlIcon

Returns the application icon for registration in Growl

no exceptions thrown

string — application icon binary data or empty if default image

Net_Growl_Exception Class

Synopsis

<?php
class Net_Growl_Exception extends Exception
{
}

Methods

Inherit all methods and properties from base Exception class. More details at http://www.php.net/manual/en/class.exception.php

Net_Growl_Udp Class

Synopsis

<?php
class Net_Growl_Udp
{
    /* methods */
    public object __construct(mixed $application [, array $notifications = array() [, string $password = '' [, array $options = array()]]] );
    public bool sendRegister();
    public bool sendNotify($name, $title, $description, $options);

}

Methods

Net_Growl_Udp::__construct

Constructs a new UDP adapter

mixed $application

Application name

array $notifications

List of notification types

string $password

(optional) Password for Growl

array $options

(optional) List of options :

• host, port, protocol, timeout

  • for Growl socket server

• debug

  • to know what data are sent and received.

no exceptions thrown

object - Net_Growl_Udp

Net_Growl_Udp::sendRegister

Sends the REGISTER message type

Net_Growl_Exception

if remote server communication failure

true

Net_Growl_Udp::sendNotify

Sends the NOTIFY message type

Net_Growl_Exception

if remote server communication failure

true

Net_Growl_Gntp Class

Synopsis

<?php
class Net_Growl_Gntp
{
    /* properties */
    private array $_passwordHashAlgorithm;

    /* methods */
    public object __construct(mixed $application [, array $notifications = array() [, string $password = '' [, array $options = array()]]] );
    public Net_Growl_Response sendRegister();
    public Net_Growl_Response sendNotify($name, $title, $description, $options);

    protected string genMessageStructure($method, $data [, $binaries = false]);

    private array _genKey($password);
    private array _genEncryption($key, $plainText);
    private string _toBool($value);
}

Methods

Net_Growl_Gntp::__construct

Constructs a new GNTP adapter

mixed $application

Application name

array $notifications

List of notification types

string $password

(optional) Password for Growl

array $options

(optional) List of options :

• host, port, protocol, timeout

  • for Growl socket server

• passwordHashAlgorithm, encryptionAlgorithm

  • to secure communications

• debug

  • to know what data are sent and received.

• resourceDir

  • location of default icons; default to false, so use the @data_dir@ of PEAR

• defaultIcon

  • the default icon filename

no exceptions thrown

object - Net_Growl_Gntp

Net_Growl_Gntp::sendRegister

Sends the REGISTER message type

Net_Growl_Exception

if remote server communication failure

Net_Growl_Response object

Net_Growl_Gntp::sendNotify

Sends the NOTIFY message type

Net_Growl_Exception

if remote server communication failure

Net_Growl_Response object

Net_Growl_GntpMock Class

Synopsis

<?php
class Net_Growl_GntpMock
{
    /* properties */
    protected $responses = array();

    /* methods */
    public object __construct(mixed $application [, array $notifications = array() [, string $password = '' [, array $options = array()]]] );
    public Net_Growl_Response sendRegister();
    public Net_Growl_Response sendNotify($name, $title, $description, $options);
    public void addResponse($response)

    protected Net_Growl_Response sendRequest()
    protected Net_Growl_Response createResponseFromString($str)
    protected Net_Growl_Response createResponseFromFile($fp)
}

Methods

Net_Growl_Gntp::__construct

Constructs a new GNTP adapter

mixed $application

Application name

array $notifications

List of notification types

string $password

(optional) Password for Growl

array $options

(optional) List of options :

• host, port, protocol, timeout

  • for Growl socket server

• passwordHashAlgorithm, encryptionAlgorithm

  • to secure communications

• debug

  • to know what data are sent and received.

no exceptions thrown

object - Net_Growl_GntpMock

Net_Growl_GntpMock::sendRegister

Mock sending the REGISTER message type

Net_Growl_Exception

if Net_Growl_Response not received

Net_Growl_Response object

Net_Growl_GntpMock::sendNotify

Mock sending the NOTIFY message type

Net_Growl_Exception

if Net_Growl_Response not received

Net_Growl_Response object

Net_Growl_GntpMock::addResponse

Adds response expected to the queue

Net_Growl_Exception

if $response is different to file pointer, string or Net_Growl_Exception

void

Net_Growl_Response Class

Synopsis

<?php
class Net_Growl_Response
{
    /* properties */
    protected string $version;
    protected string $code;
    protected string $action;
    protected integer $errorCode;
    protected string $errorDescription;
    protected string $machineName;
    protected string $softwareName;
    protected string $softwareVersion;
    protected string $platformName;
    protected string $platformVersion;
    protected string $body;

    /* methods */
    public object __construct(string $statusLine );
    public void appendBody(string $bodyChunk );
    public string getVersion();
    public string getStatus();
    public string getResponseAction();
    public integer getErrorCode();
    public string getErrorDescription();
    public string getOriginMachineName();
    public string getOriginSoftwareName();
    public string getOriginSoftwareVersion();
    public string getOriginPlatformName();
    public string getOriginPlatformVersion();
    public string __toString();

}

Methods

Net_Growl_Response::__construct

Constructs a specialized response to a GNTP request

mixed $statusLine

Response status line (e.g. "GNTP/1.0 -OK NONE")

no exceptions thrown

object - Net_Growl_Response

Net_Growl_Response::appendBody

Append a string to the response body excluding the protocol identifier, version, message type, and encryption algorithm id

no exceptions thrown

void

Net_Growl_Response::getVersion

Returns GNTP protocol version (e.g. 1.0, 1.1)

no exceptions thrown

string

Net_Growl_Response::getStatus

Returns the status code (OK | ERROR)

no exceptions thrown

string

Net_Growl_Response::getResponseAction

Returns the request action (REGITER | NOTIFY)

no exceptions thrown

string

Net_Growl_Response::getErrorCode

Returns the error code

no exceptions thrown

integer

Net_Growl_Response::getErrorDescription

Returns the error description

no exceptions thrown

string

Net_Growl_Response::getOriginMachineName

Returns the machine name/host name of the sending computer

no exceptions thrown

string

Net_Growl_Response::getOriginSoftwareName

Returns the identity of the sending framework

no exceptions thrown

string

Net_Growl_Response::getOriginSoftwareVersion

Returns the version of the sending framework

no exceptions thrown

string

Net_Growl_Response::getOriginPlatformName

Returns the identify of the sending computer OS/platform

no exceptions thrown

string

Net_Growl_Response::getOriginPlatformVersion

Returns the version of the sending computer OS/platform

no exceptions thrown

string

Net_Growl_Response::__toString

Returns the String representation of the Growl response

no exceptions thrown

string