Collaboration diagram for ilICalParser:

Public Member Functions
	__construct (string $a_ical, int $a_type)

	setCategoryId (int $a_id)

	parse ()

Data Fields
const	INPUT_STRING = 1

const	INPUT_FILE = 2

Protected Member Functions
	getContainer ()

	setContainer (ilICalItem $a_container)

	dropContainer ()

	pushContainer (ilICalItem $a_container)

	parseLine (string $line)

	storeItems (string $a_param_part, string $a_value_part)

	splitLine (string $a_line)

	tokenize (string $a_string, string $a_tokenizer)

	getTZ (string $a_timezone)

	switchTZ (ilTimeZone $timezone)

	restoreTZ ()

	writeEvent ()

	purgeString (string $a_string)

Protected Attributes
ilLogger	$log

ilCalendarCategory	$category = null

string	$ical = ''

string	$file = ''

ilTimeZone	$default_timezone = null

array	$container = array()

Detailed Description

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

Definition at line 25 of file class.ilICalParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilICalParser::__construct	(	string	$a_ical,
		int	$a_type
	)

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

References $DIC, and ilTimeZone\_getInstance().

     {
         global $DIC;
         if ($a_type == self::INPUT_STRING) {
             $this->ical = $a_ical;
         } elseif ($a_type == self::INPUT_FILE) {
             $this->file = $a_ical;
             $this->ical = file_get_contents($a_ical);
 
             if (!strlen($this->ical)) {
                 throw new ilICalParserException('Cannot parse empty ical file: ' . $a_ical);
             }
         }
         $this->log = $DIC->logger()->cal();
         $this->default_timezone = ilTimeZone::_getInstance();
     }

Here is the call graph for this function:

Member Function Documentation

◆ dropContainer()

ilICalParser::dropContainer ( )

protected

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

Referenced by parseLine(), and storeItems().

                                       : ?ilICalItem
     {
         if (is_array($this->container)) {
             return array_pop($this->container);
         }
         return null;
     }

Here is the caller graph for this function:

◆ getContainer()

ilICalParser::getContainer ( )

protected

Definition at line 90 of file class.ilICalParser.php.

Referenced by parseLine(), storeItems(), and writeEvent().

                                      : ?ilICalItem
     {
         if (count($this->container)) {
             return $this->container[count($this->container) - 1];
         }
         return null;
     }

Here is the caller graph for this function:

◆ getTZ()

ilICalParser::getTZ ( string $a_timezone )

protected

Definition at line 257 of file class.ilICalParser.php.

References $default_timezone, Vendor\Package\$e, $parts, and ilTimeZone\_getInstance().

Referenced by parseLine(), and writeEvent().

                                                 : ilTimeZone
     {
         $parts = explode('/', $a_timezone);
         $tz = array_pop($parts);
         $continent = array_pop($parts);
         if (isset($continent) and $continent) {
             $timezone = $continent . '/' . $tz;
         } else {
             $timezone = $a_timezone;
         }
         try {
             if ($this->default_timezone->getIdentifier() == $timezone) {
                 return $this->default_timezone;
             } else {
                 $this->log->info(': Found new timezone: ' . $timezone);
                 return ilTimeZone::_getInstance(trim($timezone));
             }
         } catch (ilTimeZoneException $e) {
             $this->log->notice(': Found invalid timezone: ' . $timezone);
             return $this->default_timezone;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

ilICalParser::parse ( )

Definition at line 61 of file class.ilICalParser.php.

References ilICalUtils\ICAL_EOL, ilICalUtils\ICAL_EOL_FB, ilICalUtils\ICAL_SPACE, ilICalUtils\ICAL_TAB, parseLine(), and tokenize().

                            : void
     {
         $lines = $this->tokenize($this->ical, ilICalUtils::ICAL_EOL);
         if (count($lines) == 1) {
             $lines = $this->tokenize($this->ical, ilICalUtils::ICAL_EOL_FB);
         }
         for ($i = 0; $i < count($lines); $i++) {
             $line = $lines[$i];
 
             // Check for next multilines (they start with a space)
             $offset = 1;
             while (
                 isset($lines[$i + $offset]) &&
                 (
                     (strpos($lines[$i + $offset], ilICalUtils::ICAL_SPACE) === 0) ||
                     (strpos($lines[$i + $offset], ilICalUtils::ICAL_TAB) === 0)
                 )
             ) {
                 $lines[$i + $offset] = str_replace(ilICalUtils::ICAL_EOL, '', $lines[$i + $offset]);
                 $line = $line . substr($lines[$i + $offset], 1);
                 $offset++;
             }
             $i += ($offset - 1);
 
             // Parse this line
             $this->parseLine($line);
         }
     }

Here is the call graph for this function:

◆ parseLine()

ilICalParser::parseLine ( string $line )

protected

Definition at line 119 of file class.ilICalParser.php.

References $param, $params, dropContainer(), getContainer(), getTZ(), ILIAS\UI\Implementation\Component\Input\getValue(), pushContainer(), setContainer(), splitLine(), storeItems(), and writeEvent().

Referenced by parse().

                                               : void
     {
         switch (trim($line)) {
             case 'BEGIN:VCALENDAR':
                 $this->log->debug('BEGIN VCALENDAR');
                 $this->setContainer(new ilICalComponent('VCALENDAR'));
                 break;
 
             case 'END:VCALENDAR':
                 $this->log->debug('END VCALENDAR');
                 break;
 
             case 'BEGIN:VEVENT':
                 $this->log->debug('BEGIN VEVENT');
                 $this->pushContainer(new ilICalComponent('VEVENT'));
                 break;
 
             case 'END:VEVENT':
                 $this->log->debug('END VEVENT');
                 $this->writeEvent();
                 $this->dropContainer();
                 break;
 
             case 'BEGIN:VTIMEZONE':
                 $this->log->debug('BEGIN VTIMEZONE');
                 $container = new ilICalComponent('VTIMEZONE');
                 $this->pushContainer($container);
                 break;
 
             case 'END:VTIMEZONE':
                 $this->log->debug('END VTIMEZONE');
                 if ($tzid = $this->getContainer()->getItemsByName('TZID')) {
                     $this->default_timezone = $this->getTZ($tzid[0]->getValue());
                 }
                 $this->dropContainer();
                 break;
 
             default:
                 if (strpos(trim($line), 'BEGIN') === 0) {
                     $this->log->info('Do not handling line:' . $line);
                     break;
                 }
                 if (strpos(trim($line), 'X-WR-TIMEZONE') === 0) {
                     list($param, $value) = $this->splitLine($line);
                     $this->default_timezone = $this->getTZ($value);
                 } else {
                     list($params, $values) = $this->splitLine($line);
                     $this->storeItems($params, $values);
                 }
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ purgeString()

ilICalParser::purgeString ( string $a_string )

protected

Definition at line 473 of file class.ilICalParser.php.

References ilUtil\stripSlashes().

Referenced by writeEvent().

                                                     : string
     {
         $a_string = str_replace("\;", ";", $a_string);
         $a_string = str_replace("\,", ",", $a_string);
         $a_string = str_replace("\:", ":", $a_string);
         return ilUtil::stripSlashes($a_string);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pushContainer()

ilICalParser::pushContainer ( ilICalItem $a_container )

protected

Definition at line 114 of file class.ilICalParser.php.

Referenced by parseLine(), and storeItems().

                                                              : void
     {
         $this->container[] = $a_container;
     }

Here is the caller graph for this function:

◆ restoreTZ()

ilICalParser::restoreTZ ( )

protected

Definition at line 289 of file class.ilICalParser.php.

                                   : void
     {
         $this->default_timezone->restoreTZ();
     }

◆ setCategoryId()

ilICalParser::setCategoryId ( int $a_id )

Definition at line 56 of file class.ilICalParser.php.

                                             : void
     {
         $this->category = new ilCalendarCategory($a_id);
     }

◆ setContainer()

ilICalParser::setContainer ( ilICalItem $a_container )

protected

Parameters

ilICalItem

Definition at line 101 of file class.ilICalParser.php.

Referenced by parseLine().

                                                             : void
     {
         $this->container = array($a_container);
     }

Here is the caller graph for this function:

◆ splitLine()

ilICalParser::splitLine ( string $a_line )

protected

Definition at line 240 of file class.ilICalParser.php.

Referenced by parseLine().

                                                 : array
     {
         $matches = array();
 
         if (preg_match('/([^:]+):(.*)/', $a_line, $matches)) {
             return array($matches[1], $matches[2]);
         } else {
             $this->log->notice(' Found invalid parameter: ' . $a_line);
         }
         return array('', '');
     }

Here is the caller graph for this function:

◆ storeItems()

ilICalParser::storeItems	(	string	$a_param_part,
		string	$a_value_part
	)

protected

Definition at line 172 of file class.ilICalParser.php.

References $param, dropContainer(), getContainer(), and pushContainer().

Referenced by parseLine().

                                                                              : void
     {
         // Check for a semicolon in param part and split it.
         $items = array();
         if ($splitted_param = explode(';', $a_param_part)) {
             $counter = 0;
             foreach ($splitted_param as $param) {
                 if (!$counter) {
                     $items[$counter]['param'] = $param;
                     $items[$counter]['value'] = $a_value_part;
                 } elseif ($splitted_param_values = explode('=', $param)) {
                     $items[$counter]['param'] = $splitted_param_values[0];
                     $items[$counter]['value'] = $splitted_param_values[1];
                 }
                 ++$counter;
             }
         }
         // Split value part
         $substituted_values = str_replace('\;', '', $a_value_part);
 
         $values = array();
         if ($splitted_values = explode(';', $substituted_values)) {
             $counter = 0;
             foreach ($splitted_values as $value) {
                 // Split by '='
                 $splitted_value_values = explode('=', $value);
                 if (is_array($splitted_value_values) && count($splitted_value_values) >= 2) {
                     $values[$counter]['param'] = $splitted_value_values[0];
                     $values[$counter]['value'] = $splitted_value_values[1];
                 }
                 ++$counter;
             }
         }
 
         // Return if there are no values
         if (!count($items)) {
             $this->log->write(__METHOD__ . ': Cannot parse parameter: ' . $a_param_part . ', value: ' . $a_value_part);
             return;
         }
 
         $counter = 0;
         foreach ($items as $item) {
             if (!$counter) {
                 // First is ical-Parameter
                 $parameter = new ilICalProperty($item['param'], $item['value']);
 
                 if (!$this->getContainer() instanceof ilICalItem) {
                     continue;
                 }
 
                 $this->getContainer()->addItem($parameter);
                 $this->pushContainer($parameter);
 
                 if (count($values) > 1) {
                     foreach ($values as $value) {
                         $value = new ilICalValue($value['param'], $value['value']);
                         $this->getContainer()->addItem($value);
                     }
                 }
             } else {
                 $value = new ilICalParameter($item['param'], $item['value']);
                 $this->getContainer()->addItem($value);
             }
             ++$counter;
         }
         $this->dropContainer();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchTZ()

ilICalParser::switchTZ ( ilTimeZone $timezone )

protected

Definition at line 280 of file class.ilICalParser.php.

References Vendor\Package\$e, ilTimeZone\getIdentifier(), and ilTimeZone\switchTZ().

                                                      : void
     {
         try {
             $timezone->switchTZ();
         } catch (ilTimeZoneException $e) {
             $this->log->notice(': Found invalid timezone: ' . $timezone->getIdentifier());
         }
     }

Here is the call graph for this function:

◆ tokenize()

ilICalParser::tokenize	(	string	$a_string,
		string	$a_tokenizer
	)

protected

Definition at line 252 of file class.ilICalParser.php.

Referenced by parse().

                                                                       : array
     {
         return explode($a_tokenizer, $a_string);
     }

Here is the caller graph for this function:

◆ writeEvent()

ilICalParser::writeEvent ( )

protected

Definition at line 294 of file class.ilICalParser.php.

References $default_timezone, $param, ilCalendarCategoryAssignments\addAssignment(), getContainer(), getTZ(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_DAY, ilCalendarCategory\LTYPE_REMOTE, and purgeString().

Referenced by parseLine().

                                    : void
     {
         $entry = new ilCalendarEntry();
 
         // Search for summary
         foreach ($this->getContainer()->getItemsByName('SUMMARY', false) as $item) {
             if (is_a($item, 'ilICalProperty')) {
                 $entry->setTitle($this->purgeString($item->getValue()));
                 break;
             }
         }
         // Search description
         foreach ($this->getContainer()->getItemsByName('DESCRIPTION', false) as $item) {
             if (is_a($item, 'ilICalProperty')) {
                 $entry->setDescription($this->purgeString($item->getValue()));
                 break;
             }
         }
 
         // Search location
         foreach ($this->getContainer()->getItemsByName('LOCATION', false) as $item) {
             if (is_a($item, 'ilICalProperty')) {
                 $entry->setLocation($this->purgeString($item->getValue()));
                 break;
             }
         }
 
         foreach ($this->getContainer()->getItemsByName('DTSTART') as $start) {
             $fullday = false;
             foreach ($start->getItemsByName('VALUE') as $type) {
                 if ($type->getValue() == 'DATE') {
                     $fullday = true;
                 }
             }
             $start_tz = $this->default_timezone;
             foreach ($start->getItemsByName('TZID') as $param) {
                 $start_tz = $this->getTZ($param->getValue());
             }
             if ($fullday) {
                 $start = new ilDate(
                     $start->getValue(),
                     IL_CAL_DATE
                 );
             } else {
                 $start = new ilDateTime(
                     $start->getValue(),
                     IL_CAL_DATETIME,
                     $start_tz->getIdentifier()
                 );
             }
             $entry->setStart($start);
             $entry->setFullday($fullday);
         }
 
         foreach ($this->getContainer()->getItemsByName('DTEND') as $end) {
             $fullday = false;
             foreach ($end->getItemsByName('VALUE') as $type) {
                 if ($type->getValue() == 'DATE') {
                     $fullday = true;
                 }
             }
             $end_tz = $this->default_timezone;
             foreach ($end->getItemsByName('TZID') as $param) {
                 $end_tz = $this->getTZ($param->getValue());
             }
             if ($fullday) {
                 $end = new ilDate(
                     $end->getValue(),
                     IL_CAL_DATE
                 );
                 $end->increment(IL_CAL_DAY, -1);
             } else {
                 $end = new ilDateTime(
                     $end->getValue(),
                     IL_CAL_DATETIME,
                     $end_tz->getIdentifier()
                 );
             }
             $entry->setEnd($end);
             $entry->setFullday($fullday);
         }
 
         if (!$entry->getStart() instanceof ilDateTime) {
             $this->log->warning('Cannot find start date. Event ignored.');
             return;
         }
 
         // check if end date is given otherwise replace with start
         if (
             !$entry->getEnd() instanceof ilDateTime &&
             $entry->getStart() instanceof ilDateTime
         ) {
             $entry->setEnd($entry->getStart());
         }
 
         // save calendar event
         if ($this->category->getLocationType() == ilCalendarCategory::LTYPE_REMOTE) {
             $entry->setAutoGenerated(true);
         }
         $entry->save();
 
         // Search exclusions
         // Only possible after entry is saved, otherwise the id is not available
         foreach ($this->getContainer()->getItemsByName('EXDATE', false) as $item) {
             if (is_a($item, 'ilICalProperty')) {
                 $rec_exclusion = new ilCalendarRecurrenceExclusion();
                 $rec_exclusion->setEntryId($entry->getEntryId());
                 $rec_exclusion->setDate(new ilDate($item->getValue(), IL_CAL_DATE));
                 $rec_exclusion->save();
             }
         }
 
         $ass = new ilCalendarCategoryAssignments($entry->getEntryId());
         $ass->addAssignment($this->category->getCategoryID());
 
         // Recurrences
         foreach ($this->getContainer()->getItemsByName('RRULE') as $recurrence) {
             $rec = new ilCalendarRecurrence();
             $rec->setEntryId($entry->getEntryId());
 
             foreach ($recurrence->getItemsByName('FREQ') as $freq) {
                 switch ($freq->getValue()) {
                     case 'DAILY':
                     case 'WEEKLY':
                     case 'MONTHLY':
                     case 'YEARLY':
                         $rec->setFrequenceType((string) $freq->getValue());
                         break;
 
                     default:
                         $this->log->notice(': Cannot handle recurring event of type: ' . $freq->getValue());
                         break 3;
                 }
             }
 
             foreach ($recurrence->getItemsByName('COUNT') as $value) {
                 $rec->setFrequenceUntilCount((int) $value->getValue());
                 break;
             }
             foreach ($recurrence->getItemsByName('UNTIL') as $until) {
                 $rec->setFrequenceUntilDate(new ilDate($until->getValue(), IL_CAL_DATE));
                 break;
             }
             foreach ($recurrence->getItemsByName('INTERVAL') as $value) {
                 $rec->setInterval((int) $value->getValue());
                 break;
             }
             foreach ($recurrence->getItemsByName('BYDAY') as $value) {
                 $rec->setBYDAY((string) $value->getValue());
                 break;
             }
             foreach ($recurrence->getItemsByName('BYWEEKNO') as $value) {
                 $rec->setBYWEEKNO((string) $value->getValue());
                 break;
             }
             foreach ($recurrence->getItemsByName('BYMONTH') as $value) {
                 $rec->setBYMONTH((string) $value->getValue());
                 break;
             }
             foreach ($recurrence->getItemsByName('BYMONTHDAY') as $value) {
                 $rec->setBYMONTHDAY((string) $value->getValue());
                 break;
             }
             foreach ($recurrence->getItemsByName('BYYEARDAY') as $value) {
                 $rec->setBYYEARDAY((string) $value->getValue());
                 break;
             }
             foreach ($recurrence->getItemsByName('BYSETPOS') as $value) {
                 $rec->setBYSETPOS((string) $value->getValue());
                 break;
             }
             foreach ($recurrence->getItemsByName('WKST') as $value) {
                 $rec->setWeekstart((string) $value->getValue());
                 break;
             }
             $rec->save();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $category

ilCalendarCategory ilICalParser::$category = null

protected

Definition at line 32 of file class.ilICalParser.php.

◆ $container

array ilICalParser::$container = array()

protected

Definition at line 37 of file class.ilICalParser.php.

◆ $default_timezone

ilTimeZone ilICalParser::$default_timezone = null

protected

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

Referenced by getTZ(), and writeEvent().

◆ $file

string ilICalParser::$file = ''

protected

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

◆ $ical

string ilICalParser::$ical = ''

protected

Definition at line 34 of file class.ilICalParser.php.

◆ $log

ilLogger ilICalParser::$log

protected

Definition at line 30 of file class.ilICalParser.php.

◆ INPUT_FILE

const ilICalParser::INPUT_FILE = 2

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

Referenced by ilCalendarCategoryGUI\doImportFile().

◆ INPUT_STRING

const ilICalParser::INPUT_STRING = 1

Definition at line 27 of file class.ilICalParser.php.

Referenced by ilCalendarRemoteReader\importIcal().

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

components/ILIAS/Calendar/classes/iCal/class.ilICalParser.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ dropContainer()

◆ getContainer()

◆ getTZ()

◆ parse()

◆ parseLine()

◆ purgeString()

◆ pushContainer()

◆ restoreTZ()

◆ setCategoryId()

◆ setContainer()

◆ splitLine()

◆ storeItems()

◆ switchTZ()

◆ tokenize()

◆ writeEvent()

Field Documentation

◆ $category

◆ $container

◆ $default_timezone

◆ $file

◆ $ical

◆ $log

◆ INPUT_FILE

◆ INPUT_STRING