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

Class: Net_Monitor_Alert_Growl

Source Location: /Net_Monitor-0.3.0/Net/Monitor/Alert/Growl.php

Class Overview

Net_Monitor_Alert
   |
   --Net_Monitor_Alert_Growl

class Net_Monitor_Alert_Growl


Author(s):

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 45]
class Net_Monitor_Alert_Growl


[ Top ]


Class Variables

$_alert = array()

[line 63]

Array of alert objects to be used

in the format $messenger => $object

  • Access: protected

Type:   array
Overrides:   Array


[ Top ]

$_options = array()

[line 87]

Net_Growl specific options
  • Access: protected

Type:   int


[ Top ]

$_port =  null

[line 71]

The default port to be used
  • Access: protected

Type:   int


[ Top ]

$_protocol =  'udp'

[line 79]

The default protocol to be used
  • Access: protected

Type:   int


[ Top ]

$_resource =  'Net_Monitor_Alert_Growl'

[line 95]

The resource name to specify to the messenger
  • Access: protected

Type:   string


[ Top ]

$_service =  'Growl'

[line 53]

Defines the name of the service
  • Access: protected

Type:   string
Overrides:   Array


[ Top ]



Method Detail

alert   [line 118]

mixed alert( array $server, array $result_array, [array $options = array()])

Sends the alerts thru the specified Growl server with optional password

<li> $server is an array of key=>value where value is a string. Server defines these keys:

  • server - The server to connect to. Mandatory.
  • password - The password to use for Growl authentication. Mandatory.
<li> $results is the array of results to send </ul> Returns true on success, PEAR_Error object on failure

  • Return: true or PEAR_Error
  • Access: public

Overrides Net_Monitor_Alert::alert() (function alert)

Parameters:

array   $server     Growl server connection/authentication options
array   $result_array     results to send
array   $options     standard Net_Monitor options

[ Top ]

sendAlert   [line 176]

mixed sendAlert( string $message, string $messenger, [string $server = ''], [string $password = ''], [string $subject = ''])

Sends the specified results to the specified Growl server

Returns true on success, PEAR_Error object on failure

  • Access: public

Parameters:

string   $message     message to send
string   $messenger     messager
string   $server     Growl server
string   $password     Growl server password
string   $subject     optional subject line

[ Top ]


Documentation generated on Sun, 30 Mar 2014 14:30:03 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.