Skip to content

Latest commit

 

History

History
154 lines (113 loc) · 4.49 KB

README.md

File metadata and controls

154 lines (113 loc) · 4.49 KB
Raw

eluceo — iCal

License Latest Stable Version Monthly Downloads Scrutinizer Code Quality Code Coverage Build Status

This package offers a abstraction layer for creating iCalendars. The output will follow RFC 5545 as best as possible.

The following components are supported at this time:

  • VCALENDAR
  • VEVENT
  • VALARM
  • VTIMEZONE

Installation

You can install this package by using Composer, running this command:

composer require eluceo/ical

Link to Packagist: https://packagist.org/packages/eluceo/ical

Usage

Basic Usage

1. Create a Calendar object

$vCalendar = new \Eluceo\iCal\Component\Calendar('www.example.com');

2. Create an Event object

$vEvent = new \Eluceo\iCal\Component\Event();

3. Add your information to the Event

$vEvent
    ->setDtStart(new \DateTime('2012-12-24'))
    ->setDtEnd(new \DateTime('2012-12-24'))
    ->setNoTime(true)
    ->setSummary('Christmas')
;

4. Add Event to Calendar

$vCalendar->addComponent($vEvent);

5. Set HTTP-headers

header('Content-Type: text/calendar; charset=utf-8');
header('Content-Disposition: attachment; filename="cal.ics"');

6. Send output

echo $vCalendar->render();

Timezone support

This package supports three different types of handling timezones:

1. UTC (default)

In the default setting, UTC/GMT will be used as Timezone. The time will be formated as following:

DTSTART:20121224T180000Z

2. Use explicit timezone

You can use an explicit timezone by calling $vEvent->setUseTimezone(true);. The timezone of your \DateTime object will be used. In this case the non-standard field "X-WR-TIMEZONE" will be used. Be awre that this is a simple solution which is not supported by all calendar clients. The output will be as following:

DTSTART;TZID=Europe/Berlin:20121224T180000

3. Use explicit timezone with definition

You can use an explicit timezone and define it using Timezone() and TimezoneRule() (see example5.php). The timezone of your \DateTime object will be used. The output will be as following:

BEGIN:VTIMEZONE
TZID:Europe/Berlin
X-LIC-LOCATION:Europe/Berlin
BEGIN:DAYLIGHT
TZOFFSETFROM:+0100
TZOFFSETTO:+0200
DTSTART:19810329T030000
RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=3;BYDAY=-1SU
END:DAYLIGHT
BEGIN:STANDARD
TZOFFSETFROM:+0200
TZOFFSETTO:+0100
DTSTART:19961027T030000
RRULE:FREQ=YEARLY;INTERVAL=1;BYMONTH=10;BYDAY=-1SU
END:STANDARD
END:VTIMEZONE
...
DTSTART;TZID=Europe/Berlin:20121224T180000

4. Use locale time

You can use local time by calling $vEvent->setUseUtc(false);. The output will be:

DTSTART:20121224T180000

License

This package is released under the MIT license.

Copyright (c) 2012-2017 Markus Poerschke

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.