Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleCouchDbNotificationFacade

LICENSE

INSTALL

Packages:

Interfaces:

Facade
- arbitModuleNotificationFacade

Classes:

View
- arbitModuleNotificationXHtmlHandler
- arbitNotificationConfigurationViewModel

IniBackend
- arbitNotificationBackendIniModuleConfiguration

Model
- arbitModuleModelNotification

Facade
- arbitModuleCouchDbNotificationFacade

Notification::Facade::arbitModuleCouchDbNotificationFacade

Class arbitModuleCouchDbNotificationFacade

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

Implements interfaces:

arbitModuleNotificationFacade

arbitCouchDbFacadeBase
   |
   --arbitModuleCouchDbNotificationFacade

Author(s):

Version:	$Revision: 1236 $
License:	GPL

Inherited Member Variables

From arbitCouchDbFacadeBase
protected	`arbitCouchDbFacadeBase::$connected`
protected	`arbitCouchDbFacadeBase::$manager`

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.

Inherited Methods

From arbitCouchDbFacadeBase
public void	`arbitCouchDbFacadeBase::__construct()` Constructor The constructor ensures the correct configuration for the conenction by connecting on the first request to on of the facde classes.

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

Implementation of:

Method	Description
`arbitModuleNotificationFacade::createStorage()`	Create a new settings storage for user Creates a new document with a basic settings storage for the given user ID.

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

Implementation of:

Method	Description
`arbitModuleNotificationFacade::getStorageForUser()`	Fetch storage for given user Return the storage data for the given user ID.

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

Implementation of:

Method	Description
`arbitModuleNotificationFacade::getUsersForSignal()`	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.

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

Implementation of:

Method	Description
`arbitModuleNotificationFacade::storeStorage()`	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.

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