ilCalendarExport Class Reference

Export calendar(s) to ical format More...

Collaboration diagram for ilCalendarExport:

Public Member Functions
	__construct (array $a_calendar_ids=[], bool $is_export_limited=false)
	getUserSettings ()
	setAppointments (array $a_apps)
	getAppointments ()
	setCalendarIds (array $a_cal_ids)
	getCalendarIds ()
	setExportType (int $a_type)
	getExportType ()
	export ()
	getExportString ()

Data Fields
const	EXPORT_CALENDARS = 1
const	EXPORT_APPOINTMENTS = 2

Protected Member Functions
	createTimezones ()
	addCategories (int $remaining_bytes)
	isRepeatingAppointment (ilCalendarEntry $appointment)
	addAppointments ()
	createAppointment (ilCalendarEntry $appointment)
	createVTODO (ilCalendarEntry $app)
	createVEVENT (ilCalendarEntry $app)
	createRecurrences (ilCalendarEntry $app)
	buildAppointmentUrl (ilCalendarEntry $entry)

Protected Attributes
const	BYTE_LIMIT = 1000000
int	$export_type = self::EXPORT_CALENDARS
ilObjUser	$il_user
array	$calendars = array()
ilCalendarUserSettings	$user_settings
array	$appointments = array()
ilICalWriter	$writer
ilICalWriter	$str_writer_export
bool	$is_export_limited

Private Attributes
ilLogger	$logger

Detailed Description

Export calendar(s) to ical format

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 26 of file class.ilCalendarExport.php.

Constructor & Destructor Documentation

__construct()

ilCalendarExport::__construct	(	array	$a_calendar_ids = [],
		bool	$is_export_limited = false
	)

Parameters

int[]

$a_calendar_ids

Definition at line 53 of file class.ilCalendarExport.php.

References $DIC, $is_export_limited, ilCalendarUserSettings\_getInstanceByUserId(), and ILIAS\Repository\logger().

    {
        global $DIC;
        $this->il_user = $DIC->user();
        $this->logger = $DIC->logger()->cal();
        $this->calendars = $a_calendar_ids;
        $this->is_export_limited = $is_export_limited;
        $this->appointments = [];
        $this->user_settings = ilCalendarUserSettings::_getInstanceByUserId($this->il_user->getId());
        $this->str_writer_export = new ilICalWriter();
    }

Here is the call graph for this function:

Member Function Documentation

addAppointments()

ilCalendarExport::addAppointments ( )

protected

Definition at line 219 of file class.ilCalendarExport.php.

References $app, createAppointment(), and getAppointments().

Referenced by export().

                                        : ilICalWriter
    {
        $str_builder_appointments = new ilICalWriter();
        foreach ($this->getAppointments() as $app) {
            $str_writer_appointment = $this->createAppointment(new ilCalendarEntry($app));
            $str_builder_appointments->append($str_writer_appointment);
        }
        return $str_builder_appointments;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addCategories()

ilCalendarExport::addCategories ( int  $remaining_bytes )

protected

Definition at line 159 of file class.ilCalendarExport.php.

References Vendor\Package\$a, Vendor\Package\$b, ilCalendarCategoryAssignments\_getAssignedAppointments(), createAppointment(), ilCalendarEntry\getStart(), IL_CAL_FKT_DATE, IL_CAL_UNIX, isRepeatingAppointment(), and ilTimeZone\UTC.

Referenced by export().

                                                          : ilICalWriter
    {
        $single_appointments = [];
        $str_writer_appointments = new ilICalWriter();

        foreach ($this->calendars as $category_id) {
            foreach (ilCalendarCategoryAssignments::_getAssignedAppointments(array($category_id)) as $app_id) {
                $appointment = new ilCalendarEntry($app_id);
                if ($this->isRepeatingAppointment($appointment)) {
                    $str_writer_appointment = $this->createAppointment($appointment);
                    $str_writer_appointments->append($str_writer_appointment);
                    continue;
                }
                $single_appointments[] = $appointment;
            }
        }

        usort($single_appointments, function (ilCalendarEntry $a, ilCalendarEntry $b) {
            if($a->getStart() === $b->getStart()) {
                return 0;
            }
            return $a->getStart() > $b->getStart() ? 1 : -1;
        });

        // Apply a filter on limited exports only
        if ($this->is_export_limited) {
            $single_appointments = array_filter($single_appointments, function (ilCalendarEntry $a) {
                $time_now = new ilDateTime(time(), IL_CAL_UNIX);
                $str_time_now = $time_now->get(IL_CAL_FKT_DATE, 'Ymd', ilTimeZone::UTC);
                $str_time_start = $a->getStart()->get(IL_CAL_FKT_DATE, 'Ymd', $this->il_user->getTimeZone());
                if ($str_time_start === null) {
                    return false;
                }
                $start = new DateTimeImmutable($str_time_start);
                $now = new DateTimeImmutable($str_time_now);
                $lower_bound = $now->sub(new DateInterval('P30D'));
                return $lower_bound <= $start;
            });
        }

        foreach ($single_appointments as $appointment) {
            $str_writer_appointment = $this->createAppointment($appointment);
            // Check byte count for limited exports only
            if (
                $this->is_export_limited &&
                ($str_writer_appointments->byteCount() + $str_writer_appointment->byteCount()) > $remaining_bytes
            ) {
                break;
            }
            $str_writer_appointments->append($str_writer_appointment);
        }

        return $str_writer_appointments;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildAppointmentUrl()

ilCalendarExport::buildAppointmentUrl ( ilCalendarEntry  $entry )

protected

Definition at line 329 of file class.ilCalendarExport.php.

References ilObject\_getAllReferences(), ilLink\_getLink(), ilCalendarCategoryAssignments\_lookupCategories(), ilCalendarEntry\getEntryId(), ilCalendarCategory\getInstanceByCategoryId(), and ilCalendarCategory\TYPE_OBJ.

Referenced by createVEVENT().

                                                                  : ilICalWriter
    {
        $str_writer = new ilICalWriter();
        $cat = ilCalendarCategory::getInstanceByCategoryId(
            current(ilCalendarCategoryAssignments::_lookupCategories($entry->getEntryId()))
        );
        if ($cat->getType() != ilCalendarCategory::TYPE_OBJ) {
            $str_writer->addLine('URL;VALUE=URI:' . ILIAS_HTTP_PATH);
        } else {
            $refs = ilObject::_getAllReferences($cat->getObjId());
            include_once './Services/Link/classes/class.ilLink.php';
            $str_writer->addLine('URL;VALUE=URI:' . ilLink::_getLink(current($refs)));
        }
        return $str_writer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createAppointment()

ilCalendarExport::createAppointment ( ilCalendarEntry  $appointment )

protected

Definition at line 229 of file class.ilCalendarExport.php.

References createVEVENT(), createVTODO(), and ilCalendarEntry\isMilestone().

Referenced by addAppointments(), and addCategories().

                                                                      : ilICalWriter
    {
        if ($appointment->isMilestone()) {
            return $this->createVTODO($appointment);
        } else {
            return $this->createVEVENT($appointment);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createRecurrences()

ilCalendarExport::createRecurrences ( ilCalendarEntry  $app )

protected

Definition at line 308 of file class.ilCalendarExport.php.

References ilCalendarRecurrences\_getRecurrences(), ilCalendarEntry\getEntryId(), and ilCalendarRecurrenceExclusions\getExclusionDates().

Referenced by createVEVENT().

                                                              : ilICalWriter
    {
        $str_writer = new ilICalWriter();
        include_once './Services/Calendar/classes/class.ilCalendarRecurrences.php';
        foreach (ilCalendarRecurrences::_getRecurrences($app->getEntryId()) as $rec) {
            foreach (ilCalendarRecurrenceExclusions::getExclusionDates($app->getEntryId()) as $excl) {
                $str_writer->addLine($excl->toICal());
            }
            $recurrence_ical = $rec->toICal($this->il_user->getId());
            if (strlen($recurrence_ical)) {
                $str_writer->addLine($recurrence_ical);
            }
        }
        return $str_writer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createTimezones()

ilCalendarExport::createTimezones ( )

protected

Definition at line 139 of file class.ilCalendarExport.php.

References ilCalendarUserSettings\CAL_EXPORT_TZ_UTC, getUserSettings(), and ilCalendarUtil\getZoneInfoFile().

Referenced by export().

                                        : ilICalWriter
    {
        $str_writer = new ilICalWriter();
        if ($this->getUserSettings()->getExportTimeZoneType() == ilCalendarUserSettings::CAL_EXPORT_TZ_UTC) {
            return $str_writer;
        }

        $str_writer->addLine('X-WR-TIMEZONE:' . $this->il_user->getTimeZone());
        $tzid_file = ilCalendarUtil::getZoneInfoFile($this->il_user->getTimeZone());
        if (!is_file($tzid_file)) {
            $tzid_file = ilCalendarUtil::getZoneInfoFile('Europe/Berlin');
        }
        $reader = fopen($tzid_file, 'r');
        while ($line = fgets($reader)) {
            $line = str_replace("\n", '', $line);
            $str_writer->addLine($line);
        }
        return $str_writer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createVEVENT()

ilCalendarExport::createVEVENT ( ilCalendarEntry  $app )

protected

Definition at line 243 of file class.ilCalendarExport.php.

References buildAppointmentUrl(), ilCalendarUserSettings\CAL_EXPORT_TZ_UTC, CLIENT_ID, createRecurrences(), ilICalWriter\escapeText(), ilCalendarEntry\getDescription(), ilCalendarEntry\getEnd(), ilCalendarEntry\getEntryId(), ilCalendarEntry\getLastUpdate(), ilCalendarEntry\getLocation(), ilCalendarEntry\getPresentationTitle(), ilCalendarEntry\getStart(), getUserSettings(), IL_CAL_DAY, IL_CAL_FKT_DATE, IL_CAL_UNIX, ilCalendarEntry\isFullday(), ILIAS\Repository\logger(), and ilTimeZone\UTC.

Referenced by createAppointment().

                                                         : ilICalWriter
    {
        $str_writer = new ilICalWriter();
        if (!$app->getStart() instanceof ilDateTime) {
            $this->logger->notice('Cannot create appointment for app_id: ' . $app->getEntryId());
            return $str_writer;
        }
        $test_date = $app->getStart()->get(IL_CAL_FKT_DATE, 'Ymd');
        if (!strlen((string) $test_date)) {
            return $str_writer;
        }
        $now = new ilDateTime(time(), IL_CAL_UNIX);

        $str_writer->addLine('BEGIN:VEVENT');
        $str_writer->addLine('DTSTAMP:'
            . $now->get(IL_CAL_FKT_DATE, 'Ymd\THis\Z', ilTimeZone::UTC));
        $str_writer->addLine('UID:' . ilICalWriter::escapeText(
            $app->getEntryId() . '_' . CLIENT_ID . '@' . ILIAS_HTTP_PATH
        ));

        $last_mod = $app->getLastUpdate()->get(IL_CAL_FKT_DATE, 'Ymd\THis\Z', ilTimeZone::UTC);
        $str_writer->addLine('LAST-MODIFIED:' . $last_mod);

        $startInit = $app->getStart();
        $endInit = $app->getEnd();

        // begin-patch aptar
        if ($app->isFullday()) {
            // According to RFC 5545 3.6.1 DTEND is not inclusive.
            // But ILIAS stores inclusive dates in the database.
            $endInit->increment(IL_CAL_DAY, 1);
            $start = $startInit->get(IL_CAL_FKT_DATE, 'Ymd', $this->il_user->getTimeZone());
            $end = $endInit->get(IL_CAL_FKT_DATE, 'Ymd', $this->il_user->getTimeZone());
            $str_writer->addLine('DTSTART;VALUE=DATE:' . $start);
            $str_writer->addLine('DTEND;VALUE=DATE:' . $end);
        } else {
            if ($this->getUserSettings()->getExportTimeZoneType() == ilCalendarUserSettings::CAL_EXPORT_TZ_UTC) {
                $start = $app->getStart()->get(IL_CAL_FKT_DATE, 'Ymd\THis\Z', ilTimeZone::UTC);
                $end = $app->getEnd()->get(IL_CAL_FKT_DATE, 'Ymd\THis\Z', ilTimeZone::UTC);
                $str_writer->addLine('DTSTART:' . $start);
                $str_writer->addLine('DTEND:' . $end);
            } else {
                $start = $startInit->get(IL_CAL_FKT_DATE, 'Ymd\THis', $this->il_user->getTimeZone());
                $end = $endInit->get(IL_CAL_FKT_DATE, 'Ymd\THis', $this->il_user->getTimeZone());
                $str_writer->addLine('DTSTART;TZID=' . $this->il_user->getTimezone() . ':' . $start);
                $str_writer->addLine('DTEND;TZID=' . $this->il_user->getTimezone() . ':' . $end);
            }
        }
        // end-patch aptar

        $str_writer->append($this->createRecurrences($app));
        $str_writer->addLine('SUMMARY:' . ilICalWriter::escapeText($app->getPresentationTitle(false)));
        if (strlen($app->getDescription())) {
            $str_writer->addLine('DESCRIPTION:' . ilICalWriter::escapeText($app->getDescription()));
        }
        if (strlen($app->getLocation())) {
            $str_writer->addLine('LOCATION:' . ilICalWriter::escapeText($app->getLocation()));
        }

        // TODO: URL
        $str_writer->append($this->buildAppointmentUrl($app));
        $str_writer->addLine('END:VEVENT');
        return $str_writer;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createVTODO()

ilCalendarExport::createVTODO ( ilCalendarEntry  $app )

protected

Definition at line 238 of file class.ilCalendarExport.php.

Referenced by createAppointment().

                                                        : ilICalWriter
    {
        return new ilICalWriter();
    }

Here is the caller graph for this function:

export()

ilCalendarExport::export

(

)

Definition at line 111 of file class.ilCalendarExport.php.

References addAppointments(), addCategories(), createTimezones(), and getExportType().

Referenced by ilCalendarRemoteAccessHandler\handleRequest().

                            : void
    {
        $this->str_writer_export->clear();
        $str_writer_prefix = new ilICalWriter();
        $str_writer_prefix->addLine('BEGIN:VCALENDAR');
        $str_writer_prefix->addLine('VERSION:2.0');
        $str_writer_prefix->addLine('METHOD:PUBLISH');
        $str_writer_prefix->addLine('PRODID:-//ilias.de/NONSGML ILIAS Calendar V4.4//EN');
        $str_writer_prefix->append($this->createTimezones());
        $str_writer_suffix = new ilICalWriter();
        $str_writer_suffix->addLine('END:VCALENDAR');
        $this->str_writer_export->append($str_writer_prefix);
        switch ($this->getExportType()) {
            case self::EXPORT_CALENDARS:
                $byte_sum = $str_writer_prefix->byteCount() + $str_writer_suffix->byteCount();
                $remaining_bytes = self::BYTE_LIMIT - $byte_sum;
                $str_builder_body = $this->addCategories($remaining_bytes);
                $this->str_writer_export->append($str_builder_body);
                break;

            case self::EXPORT_APPOINTMENTS:
                $str_builder_body = $this->addAppointments();
                $this->str_writer_export->append($str_builder_body);
                break;
        }
        $this->str_writer_export->append($str_writer_suffix);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAppointments()

ilCalendarExport::getAppointments

(

)

Returns

int[]

Definition at line 81 of file class.ilCalendarExport.php.

References $appointments.

Referenced by addAppointments().

                                     : array
    {
        return $this->appointments;
    }

Here is the caller graph for this function:

getCalendarIds()

ilCalendarExport::getCalendarIds

(

)

Returns

int[]

Definition at line 97 of file class.ilCalendarExport.php.

References $calendars.

                                    : array
    {
        return $this->calendars;
    }

getExportString()

ilCalendarExport::getExportString

(

)

Definition at line 324 of file class.ilCalendarExport.php.

                                     : string
    {
        return $this->str_writer_export->__toString();
    }

getExportType()

ilCalendarExport::getExportType

(

)

Definition at line 106 of file class.ilCalendarExport.php.

References $export_type.

Referenced by export().

                                   : int
    {
        return $this->export_type;
    }

Here is the caller graph for this function:

getUserSettings()

ilCalendarExport::getUserSettings

(

)

Definition at line 65 of file class.ilCalendarExport.php.

References $user_settings.

Referenced by createTimezones(), and createVEVENT().

                                     : ilCalendarUserSettings
    {
        return $this->user_settings;
    }

Here is the caller graph for this function:

isRepeatingAppointment()

ilCalendarExport::isRepeatingAppointment ( ilCalendarEntry  $appointment )

protected

Definition at line 214 of file class.ilCalendarExport.php.

References ilCalendarRecurrences\_getRecurrences(), and ilCalendarEntry\getEntryId().

Referenced by addCategories().

                                                                           : bool
    {
        return count(ilCalendarRecurrences::_getRecurrences($appointment->getEntryId())) > 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAppointments()

ilCalendarExport::setAppointments

(

array

$a_apps

)

Parameters

int[]

$a_apps

Definition at line 73 of file class.ilCalendarExport.php.

                                                  : void
    {
        $this->appointments = $a_apps;
    }

setCalendarIds()

ilCalendarExport::setCalendarIds

(

array

$a_cal_ids

)

Parameters

int[]

$a_cal_ids

Definition at line 89 of file class.ilCalendarExport.php.

                                                    : void
    {
        $this->calendars = $a_cal_ids;
    }

setExportType()

ilCalendarExport::setExportType

(

int

$a_type

)

Definition at line 102 of file class.ilCalendarExport.php.

                                              : void
    {
        $this->export_type = $a_type;
    }

Field Documentation

$appointments

array ilCalendarExport::$appointments = array()

protected

Definition at line 40 of file class.ilCalendarExport.php.

Referenced by getAppointments().

$calendars

array ilCalendarExport::$calendars = array()

protected

Definition at line 38 of file class.ilCalendarExport.php.

Referenced by getCalendarIds().

$export_type

int ilCalendarExport::$export_type = self::EXPORT_CALENDARS

protected

Definition at line 33 of file class.ilCalendarExport.php.

Referenced by getExportType().

$il_user

ilObjUser ilCalendarExport::$il_user

protected

Definition at line 36 of file class.ilCalendarExport.php.

$is_export_limited

bool ilCalendarExport::$is_export_limited

protected

Definition at line 48 of file class.ilCalendarExport.php.

Referenced by __construct().

$logger

ilLogger ilCalendarExport::$logger

private

Definition at line 35 of file class.ilCalendarExport.php.

$str_writer_export

ilICalWriter ilCalendarExport::$str_writer_export

protected

Definition at line 46 of file class.ilCalendarExport.php.

$user_settings

ilCalendarUserSettings ilCalendarExport::$user_settings

protected

Definition at line 39 of file class.ilCalendarExport.php.

Referenced by getUserSettings().

$writer

ilICalWriter ilCalendarExport::$writer

protected

Definition at line 41 of file class.ilCalendarExport.php.

BYTE_LIMIT

const ilCalendarExport::BYTE_LIMIT = 1000000

protected

Definition at line 31 of file class.ilCalendarExport.php.

EXPORT_APPOINTMENTS

const ilCalendarExport::EXPORT_APPOINTMENTS = 2

Definition at line 29 of file class.ilCalendarExport.php.

Referenced by ilCalendarMailNotification\addAttachment().

EXPORT_CALENDARS

const ilCalendarExport::EXPORT_CALENDARS = 1

Definition at line 28 of file class.ilCalendarExport.php.

---

The documentation for this class was generated from the following file:

• Services/Calendar/classes/Export/class.ilCalendarExport.php