Blame view

sources/3rdparty/Sabre/VObject/Splitter/SplitterInterface.php 1013 Bytes
03e52840d   Kload   Init
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
  <?php
  
  namespace Sabre\VObject\Splitter;
  
  /**
   * VObject splitter
   *
   * The splitter is responsible for reading a large vCard or iCalendar object,
   * and splitting it into multiple objects.
   *
   * This is for example for Card and CalDAV, which require every event and vcard
   * to exist in their own objects, instead of one large one.
   *
   * @copyright Copyright (C) 2007-2012 Rooftop Solutions. All rights reserved.
   * @author Dominik Tobschall
   * @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
   */
  interface SplitterInterface {
  
      /**
       * Constructor
       *
       * The splitter should receive an readable file stream as it's input.
       *
       * @param resource $input
       */
      function __construct($input);
  
      /**
       * Every time getNext() is called, a new object will be parsed, until we
       * hit the end of the stream.
       *
       * When the end is reached, null will be returned.
       *
       * @return Sabre\VObject\Component|null
       */
      function getNext();
  
  }