Getting started

Laravel iCalendar Reader reads and validates .ics content from strings, local files, streams, and Laravel uploads. It gives your application a queryable Calendar with events, todos, dates, participants, alarms, recurrence data, properties, and components.

Requirements

Requirement	Declared support	Continuously tested
PHP	8.2 or later in the PHP 8.x series	8.2, 8.3, 8.4, 8.5
Laravel	11, 12, 13	11, 12, 13

Required PHP extensions:

• DOM (ext-dom)
• JSON (ext-json)
• Multibyte String (ext-mbstring)
• XMLReader (ext-xmlreader)
• XMLWriter (ext-xmlwriter)

Composer also requires libxml 2.6.20 or later through the lib-libxml platform package. These requirements come from Sabre/VObject 5 and Sabre/XML. No database, migration, or external service is required.

Installation

composer require mattmy/laravel-icalendar-reader

Configuration

The package works with defaults immediately:

• max_bytes accepts up to 10 MiB per input.
• floating_timezone is null, so date-times without a timezone use app.timezone.

Publish config/icalendar_reader.php only when you need to change those values:

php artisan vendor:publish --tag=icalendar-reader-config

See Validation and configuration for timezone fallback rules and invalid configuration behavior.

Quick start

use Mattmy\ICalendar\Facades\ICalendar;

$calendar = ICalendar::read(<<<'ICS'
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Example//Calendar//EN
BEGIN:VEVENT
UID:meeting@example.test
DTSTAMP:20260803T000000Z
DTSTART:20260810T090000Z
SUMMARY:Project meeting
END:VEVENT
END:VCALENDAR
ICS);

$event = $calendar->events()->sole();

echo $event->summary; // Project meeting
echo $event->startsAt?->toIso8601String(); // 2026-08-10T09:00:00+00:00

Every read method returns the same Calendar type. Collections preserve document order, and missing optional values are null or empty collections rather than invented defaults.

Next steps

• Choose an input method and error strategy.
• Query calendars, events, and todos.
• Read properties and non-event components.
• Review performance and security before large imports.