Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleNotificationFacade

LICENSE

INSTALL

Packages:

Interfaces:

Facade
- arbitModuleNotificationFacade

Classes:

View
- arbitModuleNotificationXHtmlHandler
- arbitNotificationConfigurationViewModel

IniBackend
- arbitNotificationBackendIniModuleConfiguration

Model
- arbitModuleModelNotification

Facade
- arbitModuleCouchDbNotificationFacade

Notification::Facade::arbitModuleNotificationFacade

Interface arbitModuleNotificationFacade

Project facade defining all methods required to access project related data in the backend.

Author(s):

Version:	$Revision: 1236 $
License:	GPL

Method Summary

public void	`createStorage( $user )` Create a new settings storage for user Creates a new document with a basic settings storage for the given user ID.
public array	`getStorageForUser( $user )` Fetch storage for given user Return the storage data for the given user ID.
public array	`getUsersForSignal( $signal )` Get users registerd for signal Return an array with the IDs of the users, which have registered to receive messages for the given signal, assiciated with the type of messages they registered for.
public void	`storeStorage( $id , $data )` Store settings in backends Store the updated notification settings in the backend. existing storage is expected, and identified by the ID given as the first parameter.

Methods

createStorage

void createStorage( string $user )

Create a new settings storage for user Creates a new document with a basic settings storage for the given user ID.

Parameters:

Name	Type	Description
`$user`	string

getStorageForUser

array getStorageForUser( string $user )

Fetch storage for given user Return the storage data for the given user ID.

Parameters:

Name	Type	Description
`$user`	string

getUsersForSignal

array getUsersForSignal( string $signal )

Get users registerd for signal Return an array with the IDs of the users, which have registered to receive messages for the given signal, assiciated with the type of messages they registered for.

Parameters:

Name	Type	Description
`$signal`	string

storeStorage

void storeStorage( string $id , array $data )

Store settings in backends Store the updated notification settings in the backend. existing storage is expected, and identified by the ID given as the first parameter.

Store settings in backends Store the updated notification settings in the backend. An already existing storage is expected, and identified by the ID given as the first parameter.

Parameters:

Name	Type	Description
`$id`	string
`$data`	array

Documentation generated on Mon, 05 Apr 2010 14:02:07 +0200 by phpDocumentor 1.4.3