Sabre\VObject\Splitter\SplitterInterface Interface Reference
Inheritance diagram for Sabre\VObject\Splitter\SplitterInterface:
Collaboration diagram for Sabre\VObject\Splitter\SplitterInterface:
Public Member Functions | |
| __construct ($input) | |
| Constructor. More... | |
| getNext () | |
| Every time getNext() is called, a new object will be parsed, until we hit the end of the stream. More... | |
Detailed Description
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) fruux GmbH (https://fruux.com/)
Definition at line 18 of file SplitterInterface.php.
Constructor & Destructor Documentation
◆ __construct()
| Sabre\VObject\Splitter\SplitterInterface::__construct | ( | $input | ) |
Constructor.
The splitter should receive an readable file stream as it's input.
- Parameters
-
resource $input
Member Function Documentation
◆ getNext()
| Sabre\VObject\Splitter\SplitterInterface::getNext | ( | ) |
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.
- Returns
- Sabre|null
Implemented in Sabre\VObject\Splitter\ICalendar, and Sabre\VObject\Splitter\VCard.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/sabre/vobject/lib/Splitter/SplitterInterface.php
