dav/SabreDAV/lib/Sabre/CalDAV/Notifications/INotificationType.php

   1 <?php
   2
   3 /**
   4  * This interface reflects a single notification type.
   5  *
   6  * @package Sabre
   7  * @subpackage CalDAV
   8  * @copyright Copyright (C) 2007-2012 Rooftop Solutions. All rights reserved.
   9  * @author Evert Pot (http://www.rooftopsolutions.nl/)
  10  * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
  11  */
  12 interface Sabre_CalDAV_Notifications_INotificationType extends Sabre_DAV_PropertyInterface {
  13
  14     /**
  15      * Serializes the notification as a single property.
  16      *
  17      * You should usually just encode the single top-level element of the
  18      * notification.
  19      *
  20      * @param Sabre_DAV_Server $server
  21      * @param DOMElement $node
  22      * @return void
  23      */
  24     function serialize(Sabre_DAV_Server $server, \DOMElement $node);
  25
  26     /**
  27      * This method serializes the entire notification, as it is used in the
  28      * response body.
  29      *
  30      * @param Sabre_DAV_Server $server
  31      * @param DOMElement $node
  32      * @return void
  33      */
  34     function serializeBody(Sabre_DAV_Server $server, \DOMElement $node);
  35
  36     /**
  37      * Returns a unique id for this notification
  38      *
  39      * This is just the base url. This should generally be some kind of unique
  40      * id.
  41      *
  42      * @return string
  43      */
  44     function getId();
  45
  46 }