dav/SabreDAV/lib/Sabre/CalDAV/ICalendar.php

   1 <?php
   2
   3 /**
   4  * Calendar interface
   5  *
   6  * Implement this interface to allow a node to be recognized as an calendar.
   7  *
   8  * @package Sabre
   9  * @subpackage CalDAV
  10  * @copyright Copyright (C) 2007-2012 Rooftop Solutions. All rights reserved.
  11  * @author Evert Pot (http://www.rooftopsolutions.nl/)
  12  * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
  13  */
  14 interface Sabre_CalDAV_ICalendar extends Sabre_DAV_ICollection {
  15
  16     /**
  17      * Performs a calendar-query on the contents of this calendar.
  18      *
  19      * The calendar-query is defined in RFC4791 : CalDAV. Using the
  20      * calendar-query it is possible for a client to request a specific set of
  21      * object, based on contents of iCalendar properties, date-ranges and
  22      * iCalendar component types (VTODO, VEVENT).
  23      *
  24      * This method should just return a list of (relative) urls that match this
  25      * query.
  26      *
  27      * The list of filters are specified as an array. The exact array is
  28      * documented by Sabre_CalDAV_CalendarQueryParser.
  29      *
  30      * @param array $filters
  31      * @return array
  32      */
  33     public function calendarQuery(array $filters);
  34
  35 }