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

Class: Net_Growl_Application

Source Location: /Net_Growl-0.7.0/Growl/Application.php

Class Overview


Application object for Net_Growl


Author(s):

Copyright:

  • 2006

Methods


Inherited Variables

Inherited Methods


Class Details

[line 54]
Application object for Net_Growl

This object represents an application containing the notifications to be registered by Growl. Feel free to use your own application object as long as it implements the few public getter methods:



[ Top ]


Method Detail

Net_Growl_Application (Constructor)   [line 87]

Net_Growl_Application Net_Growl_Application( string $appName, array $notifications, [string $password = ''])

Constructor Constructs a new application to be registered by Growl

Parameters:

string   $appName   —  Application name
array   $notifications   —  Array of notifications
string   $password   —  Password to be used to notify Growl

[ Top ]

addGrowlNotifications   [line 111]

void addGrowlNotifications( array $notifications)

Adds notifications supported by this application

Expected array format is:

 array('notification name' => array('option name' => 'option value'))
At the moment, only option name 'enabled' is supported. Example:
  1.  $notifications = array('Test Notification' => array('enabled' => true));

  • Access: public

Parameters:

array   $notifications   —  Array of notifications to support

[ Top ]

getGrowlName   [line 157]

string getGrowlName( )

Returns the application name for registration in Growl
  • Return: application name
  • Access: public

[ Top ]

getGrowlNotifications   [line 146]

array &getGrowlNotifications( )

Returns the notifications accepted by Growl for this application

Expected array format is:

 array('notification name' => array('option name' => 'option value'))
At the moment, only option name 'enabled' is supported. Example:
  1.  $notifications = array('Test Notification' => array('enabled' => true));
  2.  return $notifications;

  • Return: notifications
  • Access: public

[ Top ]

getGrowlPassword   [line 168]

string getGrowlPassword( )

Returns the password to be used by Growl to accept notification packets
  • Return: password
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:38:44 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.