egroupware_official/notifications/inc/class.notifications_iface.inc.php

39 lines
949 B
PHP
Raw Normal View History

2006-09-07 09:04:15 +02:00
<?php
/**
2016-05-06 11:19:36 +02:00
* EGroupware - Notifications
2006-09-07 09:04:15 +02:00
*
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package notifications
* @link http://www.egroupware.org
* @author Cornelius Weiss <nelius@cwtech.de>
2006-09-25 12:16:19 +02:00
* @version $Id$
2006-09-07 09:04:15 +02:00
*/
/**
* Instant user notification
*/
interface notifications_iface {
2006-09-07 09:04:15 +02:00
/**
2016-05-06 11:19:36 +02:00
* constructor
2006-09-07 09:04:15 +02:00
*
* @param object $_sender
* @param object $_recipient
* @param object $_config
2006-09-07 09:04:15 +02:00
* @param object $_preferences
*/
public function __construct($_sender, $_recipient, $_config = null, $_preferences = null);
2016-05-06 11:19:36 +02:00
2006-09-07 09:04:15 +02:00
/**
* sends one notification to one recipient
2006-09-07 09:04:15 +02:00
*
* @abstract NOTE, $_messages is an array that contains
* the notification message in plain and html
* @param array $_messages
* @param string $_subject
* @param array $_links
* @param array $_attachments
2006-09-07 09:04:15 +02:00
*/
public function send(array $_messages, $_subject = false, $_links = false, $_attachments = false);
2006-09-07 09:04:15 +02:00
}