Arbit - project tracking

Arbit - project tracking

API documentation :: Docs For Class arbitMessenger

Core::arbitMessenger

Class arbitMessenger

Arbit messenger implementation Sends any structures, which implement arbitDecorateable through one of the configured messaging systems.

Arbit messenger implementation Sends any structures, which implement arbitDecorateable through one of the configured messaging systems. Common messaging systems are mail or jabber, but also XMLRpc requests or REST request are possible.

Author(s):
Version:   $Revision: 1236 $
License:   GPL

Member Variables

protected static array $transports
Default registered messenger implementations.

Default registered messenger implementations.

Method Summary

public static void registerMessenger( $name , $class )
Register messenger Register additional custom messaging systems, or overwrite an existing one with a custom implementation.
public static void send( $content , [ $to = null] , [ $transport = 'email'] )
Send message Send a decorateable object using the given messenger to the given message receiver.

Methods

registerMessenger

static void registerMessenger( string $name , string $class )

Register messenger Register additional custom messaging systems, or overwrite an existing one with a custom implementation.

Register messenger Register additional custom messaging systems, or overwrite an existing one with a custom implementation.

Parameters:
Name Type Description
$name string
$class string

send

static void send( arbitDecorateable $content , [mixed $to = null] , [string $transport = 'email'] )

Send message Send a decorateable object using the given messenger to the given message receiver.

Send message Send a decorateable object using the given messenger to the given message receiver. By default the mail transport is used.

Parameters:
Name Type Description
$content arbitDecorateable
$to mixed
$transport string
Documentation generated on Mon, 05 Apr 2010 14:02:04 +0200 by phpDocumentor 1.4.3