Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleModelNotification

LICENSE

INSTALL

Packages:

Interfaces:

Facade
- arbitModuleNotificationFacade

Classes:

View
- arbitModuleNotificationXHtmlHandler
- arbitNotificationConfigurationViewModel

IniBackend
- arbitNotificationBackendIniModuleConfiguration

Model
- arbitModuleModelNotification

Facade
- arbitModuleCouchDbNotificationFacade

Notification::Model::arbitModuleModelNotification

Class arbitModuleModelNotification

Project model

arbitBaseStruct
   |
   --arbitModelBase
      |
      --arbitModuleModelNotification

Author(s):

Version:	$Revision: 1236 $
License:	GPL

Member Variables

protected string


              $defaultFetchMethod
               =  'getStorageForUser'

Method from the model class implementation used to fetch the requested data value for the constructed model. the data is actually requested from the model.

Method from the model class implementation used to fetch the requested data value for the constructed model. The method is called lazy, when the data is actually requested from the model. The here given method is used, when there is nor special callback defined in the $specialFetchMethods array.

protected array


              $properties
               = array(
        'user'     => null,
        'settings' => null,
    )

Array containing the projects properties

Inherited Member Variables

From arbitModelBase
protected	`arbitModelBase::$id`
protected	`arbitModelBase::$modifiedProperty`
protected	`arbitModelBase::$specialFetchMethods`
protected	`arbitModelBase::$static`
protected	`arbitModelBase::$userModelProperties`

Method Summary

public static 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	`__construct( $user )` Create project model
public void	`create( )` Method called to create a new instance in the backend.
protected void	`getStorageForUser( )` Fetch the basic project data
public void	`storeChanges( )` Method called to store changes to the model.

Inherited Methods

From arbitModelBase
public void	`arbitModelBase::__construct()` Create model from identifier If the identifier of the model is known from somewhere in the application you may set it directly here instead of searching for some value.
public abstract void	`arbitModelBase::create()` Method called to create a new instance in the backend.
protected array	`arbitModelBase::getModifiedValues()` Return modified values Return an array with all values which has been modified on the current model instance, with their new values.
public abstract void	`arbitModelBase::storeChanges()` Method called to store changes to the model.
protected mixed	`arbitModelBase::toUserModel()` Transform value to user model(s) Transform a user ID or an array with user IDs in the a user mdoel, or an array of user models.
protected array	`arbitModelBase::transformUserProperties()` Transform all user properties Transform all iser IDs in the declared user properties into user models.
From arbitBaseStruct
protected void	`arbitBaseStruct::deepClone()` Deep clone array structures
public array	`arbitBaseStruct::getProperties()` Get property names Returns an arary with all properties defined in this struct.
public void	`arbitBaseStruct::__clone()` Method called, when struct ist cloned

Methods

getUsersForSignal

static 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

__construct

void __construct( string $user )

Create project model

Create project model Just create the project model

Parameters:

Name	Type	Description
`$user`	string

Redefinition of:

Method	Description
`arbitModelBase::__construct()`	Create model from identifier If the identifier of the model is known from somewhere in the application you may set it directly here instead of searching for some value.

create

void create( )

Method called to create a new instance in the backend.

Method called to create a new instance in the backend. Method called when the model should be created in the backend the first time. This will normally throw an error if a model with the same identifier already exists in the backend.

Redefinition of:

Method	Description
`arbitModelBase::create()`	Method called to create a new instance in the backend.

getStorageForUser

void getStorageForUser( )

Fetch the basic project data

Fetch the basic project data Fetch the basic project data

storeChanges

void storeChanges( )

Method called to store changes to the model.

Method called to store changes to the model. Method called to store changes in the model to the backend. The method should only modify the backend data, if something really has been changed in the model. Use the __set() method, which should wrap all write access to the model, to remember write access.

Redefinition of:

Method	Description
`arbitModelBase::storeChanges()`	Method called to store changes to the model.

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