Arbit - project tracking, tracked with Arbit

API documentation :: Docs For Class arbitModuleNotificationController

LICENSE

INSTALL

Packages:

Interfaces:

Facade
- arbitModuleNotificationFacade

Classes:

View
- arbitModuleNotificationXHtmlHandler
- arbitNotificationConfigurationViewModel

IniBackend
- arbitNotificationBackendIniModuleConfiguration

Model
- arbitModuleModelNotification

Facade
- arbitModuleCouchDbNotificationFacade

Notification::arbitModuleNotificationController

Class arbitModuleNotificationController

Base notification controller.

ezcMvcController
   |
   --arbitController
      |
      --arbitModuleNotificationController

Author(s):

Version:	$Revision: 1393 $
License:	GPL

Method Summary

public static void	`handleSignal( $signal , $struct )` Handle all signals Handle all signals and send out notifications based on the user settings.
public static void	`sendIfNotRegistered( $signal , $struct , $user , [ $type = 'email'] )` Send signal for user Explicitely send the given signal to the given user.
protected static void	`sendSignal( $users , $struct )` Send signal to users Send the given signal view struct to the given users. users must contain user IDs associated with the type of message tehy want to receive.
public arbitViewModuleModel	`configure( $request )` Configure action Let the user configure his notification settings.
protected array	`getMenu( )` Return the menu for the notification controller
public arbitViewModuleModel	`index( $request )` Index action The index action just dispatches to the default view of the notification module - the custom notification configuration.

Inherited Methods

From arbitController
public static string	`arbitController::createActionMethodName()` Creates a method name to call from an action name.
public ezcMvcResult\|ezcMvcInternalRedirect	`arbitController::createResult()` Runs the controller to process the query and return variables usable to render the view.
protected void	`arbitController::setRequestVariables()` Don't copy shit here.
public void	`arbitController::__call()` Wrapper for unknown actions Wrapper for unknown actions, which throws an exception instead of causing PHP to report a fatal error.

Methods

handleSignal

static void handleSignal( string $signal , $struct )

Handle all signals Handle all signals and send out notifications based on the user settings.

Parameters:

Name	Type	Description
`$signal`	string
`$struct`	arbitSignalSlotStruct

sendIfNotRegistered

static void sendIfNotRegistered( string $signal , $struct , $user , [string $type = 'email'] )

Send signal for user Explicitely send the given signal to the given user.

Send signal for user Explicitely send the given signal to the given user. This method will only send the signal, if the user does not already has registerd globally for this type of signals. By default the signal is sent via email - you may optionally specify a different sending type.

Parameters:

Name	Type	Description
`$signal`	string
`$struct`	arbitSignalSlotStruct
`$user`	arbitModelUser
`$type`	string

sendSignal

static void sendSignal( $users , $struct )

Send signal to users Send the given signal view struct to the given users. users must contain user IDs associated with the type of message tehy want to receive.

Send signal to users Send the given signal view struct to the given users. The array with the users must contain user IDs associated with the type of message tehy want to receive.

Parameters:

Name	Type	Description
`$users`	array
`$struct`	arbitSignalSlotViewStruct

configure

arbitViewModuleModel configure( $request )

Configure action Let the user configure his notification settings.

Parameters:

Name	Type	Description
`$request`	arbitRequest

getMenu

array getMenu( )

Return the menu for the notification controller

index

arbitViewModuleModel index( $request )

Index action The index action just dispatches to the default view of the notification module - the custom notification configuration.

Parameters:

Name	Type	Description
`$request`	arbitRequest

Documentation generated on Mon, 05 Apr 2010 14:01:45 +0200 by phpDocumentor 1.4.3