API Documentation
\
Kronolith
Backup

\Kronolith_Icalendar_Handler_Base

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

Summary

Methods
Properties
Constants
__construct()
process()
No public properties found
No constants found
_process()
_postSave()
_preSave()
$_iCal
$_driver
$_exceptions
N/A
No private methods found
No private properties found
N/A

Properties

$_iCal

$_iCal : \Horde_Icalendar

The iCalendar data.

Type

\Horde_Icalendar

$_exceptions

$_exceptions : array

Type

array

Methods

__construct()

__construct(\Horde_Icalendar  $iCal, \Kronolith_Driver  $driver, array  $params = array())

Parameters

\Horde_Icalendar $iCal

The iCalendar data.
\Kronolith_Driver $driver

The Kronolith driver.
array $params

Any additional parameters needed for the importer.

process()

process() : array

Perform the import.

Returns

array —

A hash of UID => id.

_process()

_process() : array

Process the iCalendar data.

Throws

\Kronolith_Exception

Returns

array —

A hash of UID => id.

_postSave()

_postSave(\Kronolith_Event  $event)

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.

Parameters

\Kronolith_Event $event

The event object.

_preSave()

_preSave(\Horde_Icalendar  $component) : boolean

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.

Parameters

\Horde_Icalendar $component

The iCalendar component.

Returns

boolean —

True to continue processing, false to ignore.