bomo/ical-bundle

Create ics url or file for Symfony 2, 3, 4 and 5

v2.0.2 2021-11-16 11:13 UTC

Requires

• php: >=5.3.3
• kigkonsult/icalcreator: >=2.29.18 <3.0
• symfony/framework-bundle: ^2.1|^3.0|^4.0|^5.0

Requires (Dev)

• phpunit/phpunit: ^7.5
• symfony/config: ^2.0|^3.0|^4.0
• symfony/dependency-injection: ^2.0|^3.0|^4.0
• symfony/http-kernel: ^2.0|^3.0|^4.0

MIT

• Boris Morel
• Philippe Le Van

README

This bundle is used to create an ics file or url to populate a shared calendar with events.

Caution

Release 2.0 introduce new major version of kigkonsult.

Overview

<?php
public function getIcs()
{
    $provider = $this->get('bomo_ical.ics_provider');

    $tz = $provider->createTimezone();
    $tz
        ->setTzid('Europe/Paris')
        ->setXProp('X-LIC-LOCATION', $tz->getTzid())
        ;

    $cal = $provider->createCalendar($tz);

    $cal
        ->setName('My cal1')
        ->setDescription('Foo')
        ;

    $datetime = new \Datetime('now');
    $event = $cal->newEvent();
    $event
        ->setStartDate($datetime)
        ->setEndDate($datetime->modify('+5 hours'))
        ->setName('Event 1')
        ->setDescription('Desc for event')
        ->setAttendee('[e-mail]')
        ->setAttendee('John Do')
        ;

    $alarm = $event->newAlarm();
    $alarm
        ->setAction('DISPLAY')
        ->setDescription($event->getDescription())
        ->setTrigger('-PT2H') //See Dateinterval string format
        ;

    // All Day event
    $event = $cal->newEvent();
    $event
        ->isAllDayEvent()
        ->setStartDate($datetime)
        ->setEndDate($datetime->modify('+10 days'))
        ->setName('All day event')
        ->setDescription('All day visualisation')
        ;

    $calStr = $cal->returnCalendar();

    return new Response(
        $calStr,
        200,
        array(
            'Content-Type' => 'text/calendar; charset=utf-8',
            'Content-Disposition' => 'attachment; filename="calendar.ics"',
        )
    );
}

Versions

• Release 1.0: Kigkonsult 2.24
• Release 2.0: Kigkonsult >2.24 with majors changes

Actual state

This bundle is in stable state with release 1.0;

Installation

Add BOMOIcalBundle in your composer.json

{
    "require": {
        "bomo/ical-bundle": "1.0.*"
    }
}

Now tell composer to download the bundle by running the step:

$ php composer.phar update bomo/ical-bundle

AppKernel.php

$bundles = array(
    ...
    new BOMO\IcalBundle\BOMOIcalBundle(),
);

User's Guide

All objects can be managed regardless by the provider. But the object need to be attached.

Event attached to Calendar

Alarm attached to Event

To simplify the use, the objects are a proxy method to create a child feature.

$alarm = $event->newAlarm();
$alarm
    ->set[...]
    [...]
    ;

Is stricly same that

$alarm = $provider->createAlarm();
$alarm
    ->set[...]
    [...]
    ;
$event->attachAlarm($alarm);

Outlook compatibility

Outlook does not support the parameter "x-wr-timezone". To prevent adding it to the ics, the createCalendar has a new parameter for defining whether or not to include a Timezone in the ics.

$ical = $cal = $this->provider->createCalendar(null, true);

Object reference

Provider

Timezone function createTimezone();
Calendar function createCalendar();
Event function createEvent();
Alarm function createAlarm();

Timezone

Timezone function __construct(array $config=null);
string function getTzid();
this function setTzid($tz);
vtimezone function getTimezone();

Calendar

Calendar function __construct(array $config);
this function setName($name);
this function setDescription($desc);
Event function newEvent(); //Directly attached to this Calendar
this function attachEvent(Event $event)
string function returnCalendar();
vcalendar function getCalendar();

Event

Event function __construct(mixed $param);
this function setStartDate(Datetime $date);
this function setEndDate(Datetime $date);
this function isAllDayEvent();
this function setName($name);
this function setLocation($loc);
this function setDescription($desc);
this function setComment($comment);
this function setAttendee($attendee);
this function setOrganizer($org);
Alarm function newAlarm(); //Directly attached to this Event
this function attachAlarm(Alarm $alarm);
vevent function getEvent();

Alarm

Alarm function __construct(mixed $param);
this function setAction($action); //Currently, only 'DISPLAY' action is setted.
this function setDescription($desc);
this function setTrigger($trigger);
valarm function getAlarm();

Configuration example

Currently, this bundle doesn't required any configuration section.