Net_Growl
[ class tree: Net_Growl ] [ index: Net_Growl ] [ all elements ]

Class: Net_Growl_Gntp

Source Location: /Net_Growl-2.7.0/Net/Growl/Gntp.php

Class Overview

Net_Growl
   |
   --Net_Growl_Gntp

Growl implements GNTP 1.0 protocol


Author(s):

Version:

  • Release: 2.7.0

Methods


Inherited Variables

Inherited Methods

Class: Net_Growl

Net_Growl::__construct()
Constructor
Net_Growl::debug()
Logs GNTP IN/OUT messages
Net_Growl::errorHandler()
Converts standard error into exception
Net_Growl::getApplication()
Returns the registered application object
Net_Growl::getDefaultGrowlIcon()
Returns Growl default icon logo binary data
Net_Growl::getOptions()
Gets options used with current Growl object
Net_Growl::notify()
Sends a notification to Growl
Net_Growl::publish()
Alias of notify() method.
Net_Growl::register()
Sends a application register to Growl
Net_Growl::reset()
Resettable Singleton Solution
Net_Growl::sendRequest()
Send request to remote server
Net_Growl::setNotificationLimit()
Limit the number of notifications
Net_Growl::singleton()
Singleton
Net_Growl::strByteLen()
Get string byte length
Net_Growl::utf8Encode()
Encodes a detect_order string to UTF-8
Net_Growl::__destruct()
Destructor

Class Details

[line 60]
Growl implements GNTP 1.0 protocol


[ Top ]


Method Detail

__construct (Constructor)   [line 81]

Net_Growl_Gntp __construct( mixed &$application, [array $notifications = array()], [string $password = ''], [array $options = array()])

Class constructor
  • Access: public

Overrides Net_Growl::__construct() (Constructor)

Parameters:

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.

[ Top ]

genMessageStructure   [line 403]

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

Generates full message structure (header + body).
  • Access: protected

Parameters:

string   $method     Identifies the type of message
string   $data     Request message type data
bool   $binaries     (optional) Do not encrypt binary data header

[ Top ]

sendNotify   [line 209]

Net_Growl_Response sendNotify( string $name, string $title, string $description, string $options)

Sends the NOTIFY message type
  • Throws: Net_Growl_Exception if remote server communication failure
  • Access: public

Parameters:

string   $name     Notification name
string   $title     Notification title
string   $description     Notification description
string   $options     Notification options

[ Top ]

sendRegister   [line 93]

Net_Growl_Response sendRegister( )

Sends the REGISTER message type
  • Throws: Net_Growl_Exception if remote server communication failure
  • Access: public

[ Top ]


Documentation generated on Tue, 29 Jan 2013 18:30:04 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.