Skip to content

Sabre VObject Splitter SplitterInterface

Evert Pot edited this page Sep 1, 2014 · 3 revisions

Sabre\VObject\Splitter\SplitterInterface

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.

  • Interface name: SplitterInterface
  • Namespace: Sabre\VObject\Splitter
  • This is an interface

Methods

__construct

mixed Sabre\VObject\Splitter\SplitterInterface::__construct(resource $input)

Constructor

The splitter should receive an readable file stream as it's input.

  • Visibility: public

Arguments

  • $input resource

getNext

\Sabre\VObject\Splitter\Sabre\VObject\Component|null 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.

  • Visibility: public
Clone this wiki locally