holm/egroupware
1
1
Fork 0
forked from extern/egroupware
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added new function set_skip_backends() to notifications class. The calling application now can set backends which must be skipped even if the user has set the backend to be executed in its prefs. This is useful for e.g. notifying about new mails in future (where a user pref "notify me by mail" does not make sense).

Browse Source
This commit is contained in:
Christian Binder 2008-12-10 19:47:22 +00:00
parent 66bb41b065
commit fad2227b8c
1 changed files with 34 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
notifications/inc/class.notifications.inc.php
View File

@ -42,6 +42,13 @@ final class notifications {
*/
private $backends = array('popup', 'winpopup', 'email', 'sms');
/**
* backends to skip even if the user has chosen it
* this could be set by the calling application
* @var array
*/
private $skip_backends = array();
/**
* pre-defined notificaton chains
* @abstract
@ -316,6 +323,17 @@ final class notifications {
return true;
}
/**
* Sets backends that should be skipped even if the user
* defined them in its chain
*
* @param array $_skip_backends array with names of the backends to be skipped
* e.g. array('popup', 'winpopup')
*/
public function set_skip_backends(array $_skip_backends) {
$this->skip_backends = $_skip_backends;
}
/**
* sends notifications
*/
@ -373,9 +391,16 @@ final class notifications {
continue; //user disabled notifications
}
foreach($notification_chain as $notification_backend => $action) {
foreach($notification_chain as $backend => $action) {
try {
$notification_backend = self::_appname.'_'.$notification_backend;
// check if backend should be skipped
if( in_array($backend, $this->skip_backends) ) {
// log as error just for the case too much skipping prevents user from being notified
$backend_errors[] = $backend.' will be skipped (as defined by calling application)';
continue;
}
$notification_backend = self::_appname.'_'.$backend;
if(!file_exists(EGW_INCLUDE_ROOT. SEP. self::_appname. SEP. 'inc'. SEP. 'class.'. $notification_backend. '.inc.php')) {
throw new Exception('file for '.$notification_backend. ' does not exist');
}
@ -393,19 +418,19 @@ final class notifications {
if($action == 'fail' || $action == 'continue') {
continue;
}
// all backends failed - give error message
if(!$user_notified) {
error_log('Error: notification of receiver '.$receiver->handle.' failed for the following reasons:');
foreach($backend_errors as $id=>$backend_error) {
error_log($backend_error);
}
}
break; // stop running through chain
}
// backend sucseeded
$user_notified = true;
if($action == 'stop' || $action == 'fail') { break; } // stop running through chain
}
// check if the user has been notified at all
if(!$user_notified) {
error_log('Error: notification of receiver '.$receiver->handle.' failed for the following reasons:');
foreach($backend_errors as $id=>$backend_error) {
error_log($backend_error);
}
}
}
catch (Exception $exception_user) {
error_log('Error: notification of receiver '.$receiver->handle.' failed: '.$exception_user->getMessage());