Arbit - project tracking

Arbit - project tracking

API documentation :: Package Notification Element Index

Element index for package Notification

Package indexes

[ a ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ m ] [ n ] [ p ] [ r ] [ s ] [ v ] [ x ] [ _ ]

Letter '_'

__construct
in file exceptions.php, method arbitModulePhpDocNotFoundException::__construct()
    Create exception from signal struct name
__construct
in file exceptions.php, method arbitModulePhpunitNotFoundException::__construct()
    Create exception from signal struct name
__construct
in file exceptions.php, method arbitModulePdependNotFoundException::__construct()
    Create exception from signal struct name
__construct
in file exceptions.php, method arbitModuleNotificationNoSignalViewStructException::__construct()
    Create exception from signal struct name
__construct
in file exceptions.php, method arbitModuleCiNotFoundException::__construct()
    Create exception from signal struct name
__construct
in file exceptions.php, method arbitModulePhpcsNotFoundException::__construct()
    Create exception from signal struct name
__construct
in file notification.php, method arbitModuleModelNotification::__construct()
    Create project model
__construct
in file configuration.php, method arbitNotificationConfigurationViewModel::__construct()
    Construct project view model from common values

Letter 'a'

arbitBackendCouchDbNotificationStorageView
in file notification.php, class arbitBackendCouchDbNotificationStorageView
    View on user notifications
arbitModuleCiNotFoundException
in file exceptions.php, class arbitModuleCiNotFoundException
    Exception throw, when no view struct could be found for a signal struct.
arbitModuleNotificationController
in file controller.php, class arbitModuleNotificationController
    Base notification controller.
arbitModuleNotificationDefintion
in file definition.php, class arbitModuleNotificationDefintion
    Arbit wiki module definition
arbitModuleNotificationException
in file exceptions.php, class arbitModuleNotificationException
    Basic arbit notification module exception
arbitModuleNotificationNoSignalViewStructException
in file exceptions.php, class arbitModuleNotificationNoSignalViewStructException
    Exception throw, when no view struct could be found for a signal struct.
arbitModuleNotificationSignalMappingRegistry
in file mapping_registry.php, class arbitModuleNotificationSignalMappingRegistry
    Maps signal structs to signal view structs.
arbitModulePdependNotFoundException
in file exceptions.php, class arbitModulePdependNotFoundException
    Exception throw, when no view struct could be found for a signal struct.
arbitModulePhpcsNotFoundException
in file exceptions.php, class arbitModulePhpcsNotFoundException
    Exception throw, when no view struct could be found for a signal struct.
arbitModulePhpDocNotFoundException
in file exceptions.php, class arbitModulePhpDocNotFoundException
    Exception throw, when no view struct could be found for a signal struct.
arbitModulePhpunitNotFoundException
in file exceptions.php, class arbitModulePhpunitNotFoundException
    Exception throw, when no view struct could be found for a signal struct.
arbitModuleCouchDbNotificationFacade
in file notification.php, class arbitModuleCouchDbNotificationFacade
    Project facade defining all methods required to access project related data in the backend.
arbitModuleNotificationFacade
in file notification.php, class arbitModuleNotificationFacade
    Project facade defining all methods required to access project related data in the backend.
arbitNotificationBackendIniModuleConfiguration
in file module.php, class arbitNotificationBackendIniModuleConfiguration
    arbit project configuration
arbitModuleModelNotification
in file notification.php, class arbitModuleModelNotification
    Project model
arbitModuleNotificationXHtmlHandler
in file xhtml.php, class arbitModuleNotificationXHtmlHandler
    XHtml view handler generating XHtml from the provided view model.
arbitNotificationConfigurationViewModel
in file configuration.php, class arbitNotificationConfigurationViewModel
    Base model struct for the dashboard project overview

Letter 'c'

$caches
in file definition.php, variable arbitModuleNotificationDefintion::$caches
    Array with caches registered on initialization Each cache must have a unique name, normally prefixed with the module identifier. time to live for the cache.
$couchDbDocuments
in file definition.php, variable arbitModuleNotificationDefintion::$couchDbDocuments
    CouchDB documents to be registered at the document manager.
$couchDbViews
in file definition.php, variable arbitModuleNotificationDefintion::$couchDbViews
    CouchDB documents to be registered at the document manager.
configure
in file controller.php, method arbitModuleNotificationController::configure()
    Configure action Let the user configure his notification settings.
convert
in file mapping_registry.php, method arbitModuleNotificationSignalMappingRegistry::convert()
    Convert signal struct to view struct
controller.php
procedural page controller.php
createStorage
in file notification.php, method arbitModuleNotificationFacade::createStorage()
    Create a new settings storage for user Creates a new document with a basic settings storage for the given user ID.
createStorage
in file notification.php, method arbitModuleCouchDbNotificationFacade::createStorage()
    Create a new settings storage for user Creates a new document with a basic settings storage for the given user ID.
create
in file notification.php, method arbitModuleModelNotification::create()
    Method called to create a new instance in the backend.
configureTemplate
in file xhtml.php, method arbitModuleNotificationXHtmlHandler::configureTemplate()
    Configure tempalte library
configuration.php
procedural page configuration.php

Letter 'd'

definition.php
procedural page definition.php
$defaultValues
in file module.php, variable arbitNotificationBackendIniModuleConfiguration::$defaultValues
    Array with default values for all required configuration directives. array has the following structure:
$defaultFetchMethod
in file notification.php, variable arbitModuleModelNotification::$defaultFetchMethod
    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.

Letter 'e'

exceptions.php
procedural page exceptions.php

Letter 'f'

$facades
in file definition.php, variable arbitModuleNotificationDefintion::$facades
    Array with facades registered on initialization Array with facedes for all known database backends linked with their respective implementation.

Letter 'g'

getMenu
in file controller.php, method arbitModuleNotificationController::getMenu()
    Return the menu for the notification controller
getViewName
in file notification.php, method arbitBackendCouchDbNotificationStorageView::getViewName()
    Get name of view
getStorageForUser
in file notification.php, method arbitModuleNotificationFacade::getStorageForUser()
    Fetch storage for given user Return the storage data for the given user ID.
getStorageForUser
in file notification.php, method arbitModuleCouchDbNotificationFacade::getStorageForUser()
    Fetch storage for given user Return the storage data for the given user ID.
getUsersForSignal
in file notification.php, method 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.
getUsersForSignal
in file notification.php, method arbitModuleCouchDbNotificationFacade::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.
getStorageForUser
in file notification.php, method arbitModuleModelNotification::getStorageForUser()
    Fetch the basic project data
getUsersForSignal
in file notification.php, method arbitModuleModelNotification::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.

Letter 'h'

handleSignal
in file controller.php, method arbitModuleNotificationController::handleSignal()
    Handle all signals Handle all signals and send out notifications based on the user settings.

Letter 'i'

index
in file controller.php, method arbitModuleNotificationController::index()
    Index action The index action just dispatches to the default view of the notification module - the custom notification configuration.

Letter 'm'

$mapping
in file mapping_registry.php, variable arbitModuleNotificationSignalMappingRegistry::$mapping
    Registered mappings from ssignal structs to signal view struct class names.
mapping_registry.php
procedural page mapping_registry.php
module.php
procedural page module.php
$moduleTemplates
in file xhtml.php, variable arbitModuleNotificationXHtmlHandler::$moduleTemplates
    Method template association for default calls.

Letter 'n'

notification.php
procedural page notification.php
notification.php
procedural page notification.php
notification.php
procedural page notification.php
notification.php
procedural page notification.php

Letter 'p'

$properties
in file definition.php, variable arbitModuleNotificationDefintion::$properties
    Array containing the module structures properties.
$properties
in file notification.php, variable arbitModuleModelNotification::$properties
    Array containing the projects properties
$properties
in file configuration.php, variable arbitNotificationConfigurationViewModel::$properties
    Array containing the actual view data.

Letter 'r'

register
in file mapping_registry.php, method arbitModuleNotificationSignalMappingRegistry::register()
    Register mapping Register a view struct class name for the given signal struct class name. overwritten.

Letter 's'

sendIfNotRegistered
in file controller.php, method arbitModuleNotificationController::sendIfNotRegistered()
    Send signal for user Explicitely send the given signal to the given user.
sendSignal
in file controller.php, method arbitModuleNotificationController::sendSignal()
    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.
storeStorage
in file notification.php, method 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.
storeStorage
in file notification.php, method arbitModuleCouchDbNotificationFacade::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.
$shortcuts
in file module.php, variable arbitNotificationBackendIniModuleConfiguration::$shortcuts
    Shortcuts for configuration value access.
storeChanges
in file notification.php, method arbitModuleModelNotification::storeChanges()
    Method called to store changes to the model.

Letter 'v'

$viewDefinitions
in file notification.php, variable arbitBackendCouchDbNotificationStorageView::$viewDefinitions
    View functions to be registered on the server
$viewModels
in file definition.php, variable arbitModuleNotificationDefintion::$viewModels
    List of view models used by the module List of used view handlers associated with a list of view models used by the module, each associated with a callback to the concrete handler implementation to visit the view model.

Letter 'x'

xhtml.php
procedural page xhtml.php
Documentation generated on Mon, 05 Apr 2010 14:01:26 +0200 by phpDocumentor 1.4.3