Documentation

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.

Tags
copyright

Copyright (C) fruux GmbH (https://fruux.com/)

author

Dominik Tobschall (http://tobschall.de/)

license

http://sabre.io/license/ Modified BSD License

Table of Contents

__construct()  : mixed
Constructor.
getNext()  : Component|null
Every time getNext() is called, a new object will be parsed, until we hit the end of the stream.

Methods

__construct()

Constructor.

public __construct(resource $input) : mixed

The splitter should receive an readable file stream as its input.

Parameters
$input : resource
Return values
mixed

getNext()

Every time getNext() is called, a new object will be parsed, until we hit the end of the stream.

public getNext() : Component|null

When the end is reached, null will be returned.

Return values
Component|null

Search results