📅
eluceo — iCal 2
This package offers an abstraction layer for creating iCalendars files. By using this PHP package, you can create *.ics files without the knowledge of the underling format. The output itself will follow RFC 5545 as good as possible.
Navigate through the project
-
📖 read the documentation -
🐛 report a bug or suggest a feature -
🙋 raise a question -
💬 start a discussion
Installation
You can install this package by using Composer, running the following command:
composer require eluceo/ical
Version / Upgrade
The initial version was released back in 2012. The version 2 of this package is a complete rewrite of the package and is not compatible to older version. Please see the upgrade guide if you want to migrate from version 0.* to 2.*. If you just start using this package, you should install version 2.
| Version | PHP Version |
|---|---|
| 2.* | 7.4 - 8.0 |
| 0.16.* | 7.0 - 8.0 |
| 0.11.* | 5.3.0 - 7.4 |
Documentation
Visit ical.poerschke.nrw for complete documentation.
Usage
The classes within this package are grouped into two namespaces:
- The
Domaincontains the information about the events. - The
Presentationcontains the transformation fromDomaininto a*.icsfile.
To create a calendar, the first step will be to create the corresponding domain objects. Then these objects can be transformed into a iCalendar PHP representation, which can be cast to string.
Empty event
In this very basic example, that renders an empty event. You will learn how to create an event domain object, how to add it to a calendar and how to transform it to a iCalendar component.
1. Create an event domain entity
$event = new \Eluceo\iCal\Domain\Entity\Event();
2. Create a calendar domain entity
$calendar = new \Eluceo\iCal\Domain\Entity\Calendar([$event]);
3. Transform calendar domain object into a presentation object
$iCalendarComponent = (new \Eluceo\iCal\Presentation\Factory\CalendarFactory())->createCalendar($calendar);
4. a) Save to file
file_put_contents('calendar.ics', (string) $iCalendarComponent);
4. b) Send via HTTP
header('Content-Type: text/calendar; charset=utf-8');
header('Content-Disposition: attachment; filename="cal.ics"');
echo $iCalendarComponent;
Full example
The following example will create a single day event with a summary and a description. More examples can be found in the examples/ folder.
require_once __DIR__ . '/../vendor/autoload.php';
// 1. Create Event domain entity
$event = (new Eluceo\iCal\Domain\Entity\Event())
->setSummary('Christmas Eve')
->setDescription('Lorem Ipsum Dolor...')
->setOccurrence(
new Eluceo\iCal\Domain\ValueObject\SingleDay(
new Eluceo\iCal\Domain\ValueObject\Date(
\DateTimeImmutable::createFromFormat('Y-m-d', '2030-12-24')
)
)
);
// 2. Create Calendar domain entity
$calendar = new Eluceo\iCal\Domain\Entity\Calendar([$event]);
// 3. Transform domain entity into an iCalendar component
$componentFactory = new Eluceo\iCal\Presentation\Factory\CalendarFactory();
$calendarComponent = $componentFactory->createCalendar($calendar);
// 4. Set headers
header('Content-Type: text/calendar; charset=utf-8');
header('Content-Disposition: attachment; filename="cal.ics"');
// 5. Output
echo $calendarComponent;
License
This package is released under the MIT license.
6 Nov 1, 2022
16k Dec 30, 2022
944 Dec 21, 2022
926 Dec 29, 2022
462 Dec 30, 2022
2 Dec 21, 2021
4.3k Jan 9, 2023
42 Dec 14, 2022
3 Mar 20, 2022
2.4k Jan 7, 2023
0 Oct 13, 2022
27 Dec 8, 2022
602 Dec 27, 2022
8.9k Dec 28, 2022
31 Oct 26, 2021
48 Sep 9, 2022
30 Oct 18, 2022
44 Dec 31, 2022