Class: Net_Monitor_Alert_Jabber

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

Class Overview

Net_Monitor_Alert
   |
   --Net_Monitor_Alert_Jabber

class Net_Monitor_Alert_Jabber

Author(s):

Bertrand Gugger <bertrand at toggg.com>
Robert Peake <cyberscribe at php.net>

Variables

Methods

Inherited Variables

Inherited Methods

Class: Net_Monitor_Alert

Net_Monitor_Alert::alert(): function alert

Class Details

[line 41]
class Net_Monitor_Alert_Jabber

Author: Bertrand Gugger <bertrand@toggg.com>
Author: Robert Peake <cyberscribe@php.net>
Link: http://pear.php.net/package/Net_Monitor
Access: public
License: PHP License 3.0

[ Top ]

Class Variables

$_alert = null

[line 57]

The alert object to be used (if any)

Access: protected

Type:	object
Overrides:	Array

[ Top ]

$_maxResponseLength = 4096

[line 97]

Max expected server response length

Access: protected

Type:

string

[ Top ]

$_port = 5222

[line 65]

The default port to be used

Access: protected

Type:

int

[ Top ]

$_resource = 'Net_Monitor_Alert_Jabber'

[line 73]

The resource name to specify to the server

Access: protected

Type:

string

[ Top ]

$_service = 'Jabber'

[line 49]

Defines the name of the service

Access: protected

Type:	string
Overrides:	Array

[ Top ]

$_sockErr = 0

[line 81]

Any socket error numbers

Access: protected

Type:

int

[ Top ]

$_sockErrMsg = false

[line 89]

Any socket error messages

Access: protected

Type:

string

[ Top ]

Method Detail

alert [line 122]

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

Sends the alerts thru the specified Jabber servers and accounts

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

server - The server to connect to. Mandatory.
recipient - The recipient of the message. Mandatory.
login - The login to use for Jabber authentication. Mandatory.
password - The password to use for Jabber 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`	—	Jabber server connection/authentication options
array	`$result_array`	—	results to send
array	`$options`	—	standard Net_Monitor options

[ Top ]

sendAlert [line 175]

mixed sendAlert(
string
$server, string
$recipient, string
$login, string
$password, string
$message)

Sends the specified results to the specified Jabber server

Returns true on success, PEAR_Error object on failure

Access: public

Parameters:

string	`$server`	—	Jabber server
string	`$recipient`	—	Jabber recipient
string	`$login`	—	Jabber sender login
string	`$password`	—	Jabber sender password
string	`$message`	—	message to send

[ Top ]