Documentation

Kronolith_Icalendar_Handler_Base
in package

Wraps logic responsible for importing iCalendar data, taking into account necessary steps to deal with recurrence series and exceptions.

Tags
author

Michael J Rubinsky mrubinsk@horde.org

license

http://www.horde.org/licenses/gpl GPL

category

Horde

Table of Contents

$_driver  : Kronolith_Driver
$_exceptions  : array<string|int, mixed>
$_iCal  : Horde_Icalendar
The iCalendar data.
__construct()  : mixed
process()  : array<string|int, mixed>
Perform the import.
_postSave()  : mixed
Responsible for any logic needed after each event is saved. Only called when base event (or an event with no recurrence) is saved. Exception events are not passed.
_preSave()  : bool
Responsible for any logic needed before the event is saved. Called for EVERY component in the iCalendar object. Returning false from this method will cause the current component to be ignored. Returning true causes it to be processed.
_process()  : array<string|int, mixed>
Process the iCalendar data.

Properties

$_exceptions

protected array<string|int, mixed> $_exceptions = array()

$_iCal

The iCalendar data.

protected Horde_Icalendar $_iCal

Methods

__construct()

public __construct(Horde_Icalendar $iCal, Kronolith_Driver $driver[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
$iCal : Horde_Icalendar

The iCalendar data.

$driver : Kronolith_Driver

The Kronolith driver.

$params : array<string|int, mixed> = array()

Any additional parameters needed for the importer.

Return values
mixed

process()

Perform the import.

public process() : array<string|int, mixed>
Return values
array<string|int, mixed>

A hash of UID => id.

_postSave()

Responsible for any logic needed after each event is saved. Only called when base event (or an event with no recurrence) is saved. Exception events are not passed.

protected _postSave(Kronolith_Event $event) : mixed
Parameters
$event : Kronolith_Event

The event object.

Return values
mixed

_preSave()

Responsible for any logic needed before the event is saved. Called for EVERY component in the iCalendar object. Returning false from this method will cause the current component to be ignored. Returning true causes it to be processed.

protected _preSave(Horde_Icalendar $component) : bool
Parameters
$component : Horde_Icalendar

The iCalendar component.

Return values
bool

True to continue processing, false to ignore.

_process()

Process the iCalendar data.

protected _process() : array<string|int, mixed>
Tags
throws
Kronolith_Exception
Return values
array<string|int, mixed>

A hash of UID => id.

Search results