Documentation

ICalendar
in package
implements SplitterInterface

Splitter.

This class is responsible for splitting up iCalendar objects.

This class expects a single VCALENDAR object with one or more calendar-objects inside. Objects with identical UID's will be combined into a single object.

Tags
copyright

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

author

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

author

Armin Hackmann

license

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

Interfaces, Classes and Traits

SplitterInterface
VObject splitter.

Table of Contents

$objects  : array<string|int, mixed>
iCalendar objects.
$vtimezones  : array<string|int, mixed>
Timezones.
__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.

Properties

$objects

iCalendar objects.

protected array<string|int, mixed> $objects = []

$vtimezones

Timezones.

protected array<string|int, mixed> $vtimezones = []

Methods

__construct()

Constructor.

public __construct(resource $input, int $options) : mixed

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

Parameters
$input : resource
$options : int

parser options, see the OPTIONS constants

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