search

phpfui / icalendar

Library for reading and writing iCalendar files in PHP
Other
10 stars 7 forks source link

readme

Zap Calendar iCalendar Library Tests Latest Packagist release

A modern 7.4 namespaced fork of Zap Calendar iCalendar Library

The Zap Calendar iCalendar Library is a PHP library for supporting the iCalendar (RFC 5545) standard.

This PHP library is for reading and writing iCalendar formatted feeds and files. Features of the library include:

All iCalendar data is stored in a PHP object tree. This allows any property to be added to the iCalendar feed without requiring specialized library function calls. With power comes responsibility. Missing or invalid properties can cause the resulting iCalendar file to be invalid. Visit iCalendar.org to view valid properties and test your feed using the site's iCalendar validator tool.

Library API documentation can be found at http://icalendar.org/zapcallibdocs and PHPFUI/ICalendarOrg

See the examples folder for programs that read and write iCalendar files. Best to include the sample files into a file with an active autoloader or include all the classes to run the examples directly.

Create an ical object using the ZCiCal object:

$icalobj = new \ICalendarOrg\ZCiCal();

Add an event object:

$eventobj = new \ICalendarOrg\ZCiCalNode("VEVENT", $icalobj->curnode);

Add a start and end date to the event:

// add start date
$eventobj->addNode(new \ICalendarOrg\ZCiCalDataNode("DTSTART:" . \ICalendarOrg\ZDateHelper::fromSqlDateTime("2020-01-01 12:00:00")));

// add end date
$eventobj->addNode(new \ICalendarOrg\ZCiCalDataNode("DTEND:" . \ICalendarOrg\ZDateHelper::fromSqlDateTime("2020-01-01 13:00:00")));

Write the object in iCalendar format using the export() function call:

echo $icalobj->export();

This example will not validate since it is missing some required elements. Look at the simpleevent.php example for the minimum # of elements needed for a validated iCalendar file.

To create a multi-event iCalendar file, simply create multiple event objects. For example:

$icalobj = new \ICalendarOrg\ZCiCal();
$eventobj1 = new \ICalendarOrg\ZCiCalNode("VEVENT", $icalobj->curnode);
$eventobj1->addNode(new \ICalendarOrg\ZCiCalDataNode("SUMMARY:Event 1"));
...
$eventobj2 = new \ICalendarOrg\ZCiCalNode("VEVENT", $icalobj->curnode);
$eventobj2->addNode(new \ICalendarOrg\ZCiCalDataNode("SUMMARY:Event 2"));
...

To read an existing iCalendar file/feed, create the ZCiCal object with a string representing the contents of the iCalendar file:

$icalobj = new \ICalendarOrg\ZCiCal($icalstring);

Large iCalendar files can be read in chunks to reduce the amount of memory needed to hold the iCalendar feed in memory. This example reads 500 events at a time:

$icalobj = null;
$eventcount = 0;
$maxevents = 500;
do
{
    $icalobj = new \ICalendarOrg\ZCiCal($icalstring, $maxevents, $eventcount);
    ...
    $eventcount += $maxevents;
}
while($icalobj->countEvents() >= $eventcount);

You can read the events from an imported (or created) iCalendar object in this manner:

foreach($icalobj->tree->child as $node)
{
    if($node->getName() == "VEVENT")
    {
        foreach($node->data as $key => $value)
        {
            if($key == "SUMMARY")
            {
                echo "event title: " . $value->getValues() . "\n";
            }
        }
    }
}

Known Limitations