makinuk / icalendar

v3.1.0 2026-09-24 14:56 UTC

Requires

• php: ^8.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.64
• phpstan/phpstan: ^2.0
• phpstan/phpstan-phpunit: ^2.0
• phpunit/phpunit: ^11.4
• rector/rector: ^2.6

Suggests

• rector/rector: Run the bundled Rector set to upgrade code from 2.x to 3.0 automatically

MIT

• Mustafa AKIN

• event
• calendar
• iCalendar
• ics
• ical
• google calendar
• Invitation
• outlook
• meeting
• alarm
• rfc5545
• vevent
• vtodo

Published on Packagist.org on 2026-09-24 14:59 UTC

README

Generate standards-compliant iCalendar (.ics) files in PHP: events, to-dos, reminders, recurring events, calendar feeds and meeting invitations that work in Outlook, Google Calendar and Apple Calendar.

• RFC 5545 compliant output: CRLF line endings, text escaping, UTF-8-safe line folding, UTC dates
• Fluent, typed API: enums instead of magic strings, validation with clear error messages
• Zero dependencies: only PHP 8.2+
• Extensible: add any X- or IANA property, or new component types

Installation

composer require makinuk/icalendar

Version	PHP	Status
3.x	≥ 8.2	Active development
2.x	≥ 7.4	No longer maintained

Upgrading from 2.x? Read the upgrade guide: a bundled Rector set migrates most of your code automatically.

Quick start

use Makinuk\ICalendar\Calendar;
use Makinuk\ICalendar\Component\Alarm;
use Makinuk\ICalendar\Component\Event;

$event = Event::create('Product demo', '2026-10-01 14:00', '2026-10-01 15:00')
    ->setDescription("We will walk through the new dashboard.\nQuestions are welcome.")
    ->setLocation('Meeting room 3, Istanbul')
    ->setOrganizer('[e-mail]', 'Jane Doe')
    ->addAlarm(Alarm::display('Product demo')->before(minutes: 10));

$calendar = new Calendar($event);

$calendar->save('demo.ics');        // write a file
$ics = $calendar->render();         // or get the string
$calendar->send('demo.ics');        // or download it in plain PHP

Dates accept a DateTimeInterface, any string DateTimeImmutable understands ('2026-10-01 14:00', '+1 day', '2026-10-01 14:00 Europe/Istanbul') or a Unix timestamp.

What can I build with it?

Use case	Example
"Add to calendar" button for bookings, orders or webinars	01-simple-event.php
Meeting invitations with Accept / Decline in the e-mail client	02-meeting-invitation.php
Recurring events: stand-ups, courses, shifts	03-recurring-events.php
Holidays, multi-day conferences and task lists	04-all-day-and-todos.php
Subscribable calendar feeds (webcal://)	05-calendar-feed.php

A few more examples

Meeting invitation

use Makinuk\ICalendar\Enum\Method;
use Makinuk\ICalendar\Property\Attendee;

$event = Event::create('Quarterly planning', '2026-10-05 10:00', '2026-10-05 11:30')
    ->setOrganizer('[e-mail]', 'Jane Doe')
    ->addAttendee(new Attendee('[e-mail]', 'Bob Smith', rsvp: true));

$calendar = (new Calendar($event))->setMethod(Method::Request);

// Attach $calendar->render() to an e-mail with the type $calendar->getContentType().

Recurring event

use Makinuk\ICalendar\Enum\Weekday;
use Makinuk\ICalendar\Value\RecurrenceRule;

Event::create('Monthly review', '2026-10-30 16:00', '2026-10-30 17:00')
    ->setRecurrenceRule(RecurrenceRule::monthly()->byDay(Weekday::Friday->nth(-1)));   // last Friday

All-day event and to-do

use Makinuk\ICalendar\Component\Todo;

(new Event())->setAllDay()->setStart('2026-10-29')->setSummary('Republic Day');

Todo::create('Send the quarterly report', '2026-10-15 17:00')->setPriority(1);

Documentation

Full documentation lives in the docs/ folder:

• Getting started
• Events, to-dos, alarms and recurrence
• Meeting invitations by e-mail
• Framework integration: Laravel, Symfony, plain PHP, feeds
• Extending the library
• RFC 5545 support matrix and roadmap

Contributing

Contributions are very welcome, from bug reports to new components. The roadmap lists good first issues. Please read CONTRIBUTING.md and our code of conduct.

composer install
composer check   # coding style, static analysis and tests

Security issues: see SECURITY.md.

License

MIT. See LICENSE.