iCalendar Generator

https://github.com/spatie/icalendar-generator
Admin
iCalendar Generator is a PHP package for building and generating calendars in the iCalendar (RFC...
Tokens:15,165
Snippets:162
Trust Score:10
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install spatie/icalendar-generator

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Install the library using Composer.

```bash
composer require spatie/icalendar-generator
```

--------------------------------

### Set Todo Start Date

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Shows how to specify a start date for a todo item. This is often used in conjunction with a duration.

```php
Todo::create()
    ->starts(new DateTime('2023-12-31 23:59:59'))
    ...
```

--------------------------------

### Create Basic Event

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Create a new event with a name and a start date. A name is optional, but a start date is required.

```php
Event::create('Laracon Online')
    ->startsAt(new DateTime('6 march 2019'));
```

--------------------------------

### Create Event Alert (Minutes Before)

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set up an alert for an event to trigger a reminder a specified number of minutes before it starts, including a custom description.

```php
Event::create('Laracon Online')
    ->alertMinutesBefore(5, 'Laracon online is going to start in five minutes');
```

--------------------------------

### Set Week Start Day

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Define the starting day of the week for recurrence calculations.

```php
$rrule = RRule::frequency(RecurrenceMonth::Monthly)->weekStartsOn(
   ReccurenceDay::monday()
);
```

--------------------------------

### Create and Output a Calendar

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Use Calendar::create() to build a calendar object and ->get() to serialize it into an iCalendar string. This string can be streamed or downloaded.

```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Event;

$ical = Calendar::create('Laracon Online')
    ->description('The Laravel conference, online')
    ->productIdentifier('MyApp/1.0')
    ->refreshInterval(5)          // clients re-fetch every 5 minutes
    ->source('https://example.com/calendar.ics')
    ->event(Event::create('Opening Keynote')
        ->startsAt(new DateTime('2024-03-06 15:00:00', new DateTimeZone('Europe/Brussels')))
        ->endsAt(new DateTime('2024-03-06 16:00:00', new DateTimeZone('Europe/Brussels')))
    )
    ->get();

// Stream in Laravel:
// return response($ical)->header('Content-Type', 'text/calendar; charset=utf-8');

// Force download in Laravel:
// return response($ical, 200, [
//     'Content-Type'        => 'text/calendar; charset=utf-8',
//     'Content-Disposition' => 'attachment; filename="calendar.ics"',
// ]);

echo $ical;
// BEGIN:VCALENDAR
// VERSION:2.0
// PRODID:MyApp/1.0
// NAME:Laracon Online
// X-WR-CALNAME:Laracon Online
// ...
// END:VCALENDAR
```

--------------------------------

### Todo::create() - Create a calendar task

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Create `VTODO` components that support start, due, duration, completion, priority, percentage, and status.

```APIDOC
## Todo::create() — Create a calendar task

`VTODO` components support start, due, duration, completion, priority, percentage, and status.

```php
use Spatie\IcalendarGenerator\Components\Todo;
use Spatie\IcalendarGenerator\Enums\Classification;
use Spatie\IcalendarGenerator\Enums\TodoStatus;

$todo = Todo::create('Prepare Q4 Report')
    ->description('Compile metrics and write executive summary')
    ->uniqueIdentifier('todo-q4-report-2024')
    ->createdAt(new DateTime('2024-10-01 08:00:00'))
    ->startsAt(new DateTime('2024-10-15 09:00:00'))
    ->duration(new DateInterval('P5D'))            // 5-day duration (cannot combine with dueAt)
    ->completedAt(new DateTime('2024-10-20 17:00:00'))
    ->percentCompleted(100)                        // 0–100
    ->priority(2)                                  // 0 = undefined; 1 = highest; 9 = lowest
    ->status(TodoStatus::Completed)                // NeedsAction | Completed | InProcess | Cancelled
    ->classification(Classification::Confidential)
    ->url('https://intranet.example.com/reports/q4')
    ->organizer('manager@example.com', 'Manager')
    ->attendee('analyst@example.com')
    ->attachment('https://example.com/template.xlsx', 'application/vnd.ms-excel')
    ->sequence(1)
    ->alertMinutesBefore(60, 'Report due in 1 hour');

// Using dueAt instead of duration:
$todo2 = Todo::create('Submit invoice')
    ->dueAt(new DateTime('2024-12-31 23:59:59'))
    ->status(TodoStatus::NeedsAction);
```
```

--------------------------------

### Manually Create VTIMEZONE Components

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Craft custom VTIMEZONE, VSTANDARD, and VDAYLIGHT components when auto-generation is insufficient. This example shows how to define standard and daylight saving time entries with specific dates, offsets, names, and recurrence rules.

```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Timezone;
use Spatie\IcalendarGenerator\Components\TimezoneEntry;
use Spatie\IcalendarGenerator\Enums\RecurrenceFrequency;
use Spatie\IcalendarGenerator\Enums\TimezoneEntryType;
use Spatie\IcalendarGenerator\ValueObjects\RRule;

$standardEntry = TimezoneEntry::create(
    TimezoneEntryType::Standard,
    new DateTime('2020-10-25 03:00:00'),
    '+02:00',   // offset before change (summer time)
    '+01:00'    // offset after change  (winter time)
)->name('CET')->description('Central European Time');

$daylightEntry = TimezoneEntry::create(
    TimezoneEntryType::Daylight,
    new DateTime('2020-03-29 02:00:00'),
    '+01:00',
    '+02:00'
)->name('CEST')
 ->rrule(RRule::frequency(RecurrenceFrequency::Yearly));

$timezone = Timezone::create('Europe/Brussels')
    ->lastModified(new DateTime('2020-01-01'))
    ->url('https://tzdata.example.com/Europe_Brussels')
    ->entry([$standardEntry, $daylightEntry]);

$calendar = Calendar::create()
    ->withoutAutoTimezoneComponents()   // disable auto-generation
    ->timezone($timezone)
    ->event(Event::create('Brussels Meeting')
        ->startsAt(new DateTime('2024-06-01 10:00:00', new DateTimeZone('Europe/Brussels')))
    )
    ->get();
```

--------------------------------

### Calendar::create()

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Creates a new Calendar instance and allows for setting global calendar properties and adding components like events. The `get()` method serializes the calendar to an iCalendar string.

```APIDOC
## Calendar::create()

### Description
Creates and outputs a calendar. `Calendar` is the root component. Call `->get()` to serialise it to an iCalendar string for streaming or download.

### Method
`Calendar::create(string $name = 'Calendar')`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Usage
```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Event;

$ical = Calendar::create('Laracon Online')
    ->description('The Laravel conference, online')
    ->productIdentifier('MyApp/1.0')
    ->refreshInterval(5)          // clients re-fetch every 5 minutes
    ->source('https://example.com/calendar.ics')
    ->event(Event::create('Opening Keynote')
        ->startsAt(new DateTime('2024-03-06 15:00:00', new DateTimeZone('Europe/Brussels')))
        ->endsAt(new DateTime('2024-03-06 16:00:00', new DateTimeZone('Europe/Brussels')))
    )
    ->get();

echo $ical;
```

### Response
#### Success Response (200)
An iCalendar string representing the generated calendar.

#### Response Example
```
BEGIN:VCALENDAR
VERSION:2.0
PRODID:MyApp/1.0
NAME:Laracon Online
X-WR-CALNAME:Laracon Online
...
END:VCALENDAR
```
```

--------------------------------

### Set Recurrence Rule Start Date

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Define a specific start date and time for the recurrence rule.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Daily)->starting(new DateTime('now'));
```

--------------------------------

### Set Full Event Properties

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set various properties for an event including name, description, unique identifier, creation date, start time, and end time.

```php
Event::create()
    ->name('Laracon Online')
    ->description('Experience Laracon all around the world')
    ->uniqueIdentifier('A unique identifier can be set here')
    ->createdAt(new DateTime('6 march 2019'))
    ->startsAt(new DateTime('6 march 2019 15:00'))
    ->endsAt(new DateTime('6 march 2019 16:00'));
```

--------------------------------

### Create Event with Period

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Quickly create an event with a specified start and end date using the `period` method.

```php
Event::create('Laracon Online')
    ->period(new DateTime('6 march 2019'), new DateTime('7 march 2019'));
```

--------------------------------

### Set event start and end times together

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Use the `period()` method to define both the start and end times of an event simultaneously. This is a convenient way to set a duration.

```php
use Spatie\IcalendarGenerator\Components\Event;

$event = Event::create('Conference')
    ->period(
        new DateTime('2024-09-10 09:00:00'),
        new DateTime('2024-09-10 17:00:00')
    );
```

--------------------------------

### Create Calendar Tasks with Todo Component

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Define tasks with various properties including description, unique identifier, start and due dates, duration, completion status, priority, and classification. Use `duration` for a period or `dueAt` for a specific deadline, but not both. Attachments and organizer/attendee information can also be included.

```php
use Spatie\IcalendarGenerator\Components\Todo;
use Spatie\IcalendarGenerator\Enums\Classification;
use Spatie\IcalendarGenerator\Enums\TodoStatus;

$todo = Todo::create('Prepare Q4 Report')
    ->description('Compile metrics and write executive summary')
    ->uniqueIdentifier('todo-q4-report-2024')
    ->createdAt(new DateTime('2024-10-01 08:00:00'))
    ->startsAt(new DateTime('2024-10-15 09:00:00'))
    ->duration(new DateInterval('P5D'))            // 5-day duration (cannot combine with dueAt)
    ->completedAt(new DateTime('2024-10-20 17:00:00'))
    ->percentCompleted(100)                        // 0–100
    ->priority(2)                                  // 0 = undefined; 1 = highest; 9 = lowest
    ->status(TodoStatus::Completed)                // NeedsAction | Completed | InProcess | Cancelled
    ->classification(Classification::Confidential)
    ->url('https://intranet.example.com/reports/q4')
    ->organizer('manager@example.com', 'Manager')
    ->attendee('analyst@example.com')
    ->attachment('https://example.com/template.xlsx', 'application/vnd.ms-excel')
    ->sequence(1)
    ->alertMinutesBefore(60, 'Report due in 1 hour');

// Using dueAt instead of duration:
$todo2 = Todo::create('Submit invoice')
    ->dueAt(new DateTime('2024-12-31 23:59:59'))
    ->status(TodoStatus::NeedsAction);
```

--------------------------------

### Set Todo Duration

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Defines the duration for a todo item. A start date is required when a duration is specified.

```php
Todo::create()
    ->duration(new DateInterval('PT1H30M'))
    ...
```

--------------------------------

### Set Todo Due Date

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Specifies a due date for a todo item. Note that a todo cannot have both a start date and a due date.

```php
Todo::create()
    ->due(new DateTime('2023-12-31 23:59:59'))
    ...
```

--------------------------------

### Event::period() — Set start and end together

Source: https://context7.com/spatie/icalendar-generator/llms.txt

A convenience method to set both the start and end times of an event simultaneously using DateTime objects.

```APIDOC
## Event::period() — Set start and end together

```php
use Spatie\IcalendarGenerator\Components\Event;

$event = Event::create('Conference')
    ->period(
        new DateTime('2024-09-10 09:00:00'),
        new DateTime('2024-09-10 17:00:00')
    );
```
```

--------------------------------

### Set Recurrence Interval

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Define the interval between repetitions. For example, an interval of 2 with a daily frequency means the event repeats every two days.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Daily)->interval(2);
```

--------------------------------

### Run Tests

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Execute the package's test suite using Composer.

```bash
composer test
```

--------------------------------

### Create an all-day event

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Use `fullDay()` in conjunction with `startsAt()` to create an event that spans an entire day. The `DTSTART` will be formatted without a time component.

```php
use Spatie\IcalendarGenerator\Components\Event;

$event = Event::create('Public Holiday')
    ->startsAt(new DateTime('2024-12-25'))
    ->fullDay();
// DTSTART will be formatted as DATE (no time component)
```

--------------------------------

### Create a basic calendar with an event

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Use this to generate a simple iCalendar feed with a single event. Ensure you have imported the necessary classes.

```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Event;

Calendar::create('Laracon online')
    ->event(Event::create('Creating calender feeds')
        ->startsAt(new DateTime('6 March 2019 15:00'))
        ->endsAt(new DateTime('6 March 2019 16:00'))
    )
    ->get();
```

--------------------------------

### Create a Daily Recurrence Rule

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Initialize a basic daily recurrence rule. Supported frequencies include secondly, minutely, hourly, daily, weekly, monthly, and yearly.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Daily);
```

--------------------------------

### Create a full VEVENT component

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Use Event::create() to build a VEVENT with RFC 5545 properties. Ensure correct DateTime and DateTimeZone objects are used for accurate scheduling.

```php
use Spatie\IcalendarGenerator\Components\Event;
use Spatie\IcalendarGenerator\Enums\Classification;
use Spatie\IcalendarGenerator\Enums\Display;
use Spatie\IcalendarGenerator\Enums\EventStatus;
use Spatie\IcalendarGenerator\Enums\ParticipationStatus;

$event = Event::create('Team Standup')
    ->name('Daily Team Standup')                        // override name
    ->description('Quick sync on current tasks')
    ->uniqueIdentifier('standup-2024-06-01')            // stable UID for updates
    ->createdAt(new DateTime('2024-01-01 00:00:00'))
    ->startsAt(new DateTime('2024-06-01 09:00:00', new DateTimeZone('Europe/Brussels')))
    ->endsAt(new DateTime('2024-06-01 09:15:00', new DateTimeZone('Europe/Brussels')))
    ->url('https://meet.example.com/standup')
    ->status(EventStatus::Confirmed)                    // Confirmed | Tentative | Cancelled
    ->classification(Classification::Private)           // Public | Private | Confidential
    ->transparent()                                     // does not block time in calendar view
    ->sequence(2)                                       // increment when updating an event
    ->organizer('alice@example.com', 'Alice')
    ->attendee('bob@example.com', 'Bob', ParticipationStatus::Accepted)
    ->attendee('carol@example.com', 'Carol', ParticipationStatus::NeedsAction, requiresResponse: true)
    ->attachment('https://example.com/agenda.pdf')
    ->attachment('https://example.com/notes.txt', 'text/plain')
    ->image('https://example.com/banner.png', 'image/png', Display::Thumbnail)
    ->googleConference('https://meet.google.com/abc-defg-hij')
    ->microsoftTeams('https://teams.microsoft.com/l/meetup-join/...')
    ->alertMinutesBefore(10, 'Standup starts in 10 minutes');
```

--------------------------------

### Create a calendar with a name

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Instantiate a new calendar object and assign it a name.

```php
$calendar = Calendar::create('Laracon Online');
```

--------------------------------

### Create and Add a Todo to a Calendar

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Demonstrates how to create a single todo item and add it to a calendar. Similar methods are available for adding multiple todos or using closures.

```php
$todo = Todo::create('My first todo')

$calendar = Calendar::create('My calendar')->todo($todo);
```

--------------------------------

### Append Property with Parameters

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Properties can have additional key-value parameters. Use `addParameter` to add them to a property instance.

```php
$property = TextProperty::create('ORGANIZER', 'ruben@spatie.be')
    ->addParameter(Parameter::create('CN', 'RUBEN VAN ASSCHE'));

Calendar::create()
    ->appendProperty($property)
    ...
```

--------------------------------

### Add reminders for events and todos

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Create VALARM subcomponents using convenience methods like `alertMinutesBefore`, `alertMinutesAfter`, `alertAt`, or by building an `Alert` object directly and attaching it with `->alert()`.

```php
use Spatie\IcalendarGenerator\Components\Alert;
use Spatie\IcalendarGenerator\Components\Event;

$event = Event::create('Webinar')
    ->startsAt(new DateTime('2024-07-15 14:00:00'))
    ->endsAt(new DateTime('2024-07-15 15:00:00'))
    // Convenience methods (on HasAlerts trait):
    ->alertMinutesBefore(15, 'Webinar starts in 15 minutes')
    ->alertMinutesAfter(5, 'The webinar has ended')
    ->alertAt(new DateTime('2024-07-15 13:00:00'), 'Prepare your slides')
    // Or attach an Alert object directly:
    ->alert(Alert::minutesBeforeStart(30, '30-minute warning'))
    ->alert(Alert::minutesAfterEnd(10, 'Post-webinar reminder'))
    ->alert(Alert::date(new DateTime('2024-07-14 09:00:00'), 'Day-before reminder'));
```

--------------------------------

### Event::create() — Create a calendar event

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Build a full VEVENT component with all supported RFC 5545 properties. This method allows setting various event details such as name, description, unique identifier, timestamps, URL, status, classification, sequence, organizer, attendees, attachments, images, and conference links.

```APIDOC
## Event::create() — Create a calendar event

Build a full `VEVENT` component with all supported RFC 5545 properties.

```php
use Spatie\IcalendarGenerator\Components\Event;
use Spatie\IcalendarGenerator\Enums\Classification;
use Spatie\IcalendarGenerator\Enums\Display;
use Spatie\IcalendarGenerator\Enums\EventStatus;
use Spatie\IcalendarGenerator\Enums\ParticipationStatus;

$event = Event::create('Team Standup')
    ->name('Daily Team Standup')                        // override name
    ->description('Quick sync on current tasks')
    ->uniqueIdentifier('standup-2024-06-01')            // stable UID for updates
    ->createdAt(new DateTime('2024-01-01 00:00:00'))
    ->startsAt(new DateTime('2024-06-01 09:00:00', new DateTimeZone('Europe/Brussels')))
    ->endsAt(new DateTime('2024-06-01 09:15:00', new DateTimeZone('Europe/Brussels')))
    ->url('https://meet.example.com/standup')
    ->status(EventStatus::Confirmed)                    // Confirmed | Tentative | Cancelled
    ->classification(Classification::Private)           // Public | Private | Confidential
    ->transparent()                                     // does not block time in calendar view
    ->sequence(2)                                       // increment when updating an event
    ->organizer('alice@example.com', 'Alice')
    ->attendee('bob@example.com', 'Bob', ParticipationStatus::Accepted)
    ->attendee('carol@example.com', 'Carol', ParticipationStatus::NeedsAction, requiresResponse: true)
    ->attachment('https://example.com/agenda.pdf')
    ->attachment('https://example.com/notes.txt', 'text/plain')
    ->image('https://example.com/banner.png', 'image/png', Display::Thumbnail)
    ->googleConference('https://meet.google.com/abc-defg-hij')
    ->microsoftTeams('https://teams.microsoft.com/l/meetup-join/...')
    ->alertMinutesBefore(10, 'Standup starts in 10 minutes');
```
```

--------------------------------

### Add name and description to a calendar

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set the name and description properties for the calendar feed.

```php
$calendar = Calendar::create()
    ->name('Laracon Online')
    ->description('Experience Laracon all around the world');
```

--------------------------------

### Use Carbon for Dates

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Integrate the Carbon library for convenient date and time manipulation when setting event dates.

```php
use Carbon\Carbon;

Event::create('Laracon Online')
    ->startsAt(Carbon::now())
    ...
```

--------------------------------

### Add Recurrence Rule String with DTSTART and UNTIL

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Provide a recurrence rule string along with explicit DTSTART and UNTIL DateTime objects to help with timezone handling.

```php
Event::create('SymfonyCon')
    ->rruleAsString(
        'DTSTART=20231207T090000Z;FREQ=DAILY;INTERVAL=1;UNTIL=20231208T090000Z',
        new DateTime('7 december 2023 09:00:00', new DateTimeZone('UTC')),
        new DateTime('8 december 2023 09:00:00', new DateTimeZone('UTC'))
    );
```

--------------------------------

### Repeat Event on Multiple Dates

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set up an event to repeat on a series of specific dates by passing an array of DateTime objects to the `repeatOn` method.

```php
Event::create('Laracon Online')
    ->repeatOn([new DateTime('05/16/2020 12:00:00'), new DateTime('08/13/2020 15:00:00')]);
```

--------------------------------

### Create Event Alert (Minutes After)

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Configure an alert to trigger a reminder a specified number of minutes after an event has ended, with a custom message.

```php
Event::create('Laracon Online')
    ->alertMinutesAfter(5, 'Laracon online has ended, see you next year!');
```

--------------------------------

### Set event location with address and coordinates

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Define the physical location of an event using `address()`, `addressName()`, and `coordinates()` for latitude and longitude.

```php
use Spatie\IcalendarGenerator\Components\Event;

$event = Event::create('Company Summit')
    ->address('Kruikstraat 22, 2018 Antwerp, Belgium')
    ->addressName('Spatie HQ')
    ->coordinates(51.2343, 4.4287);    // latitude, longitude
```

--------------------------------

### Build Recurrence Rules with RRule

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Construct complex recurrence rules by chaining frequency, interval, and specific day/month configurations. Use `until` for end dates or `times` for a fixed number of occurrences. The `weekStartsOn` method sets the first day of the week for recurrence calculations.

```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Event;
use Spatie\IcalendarGenerator\Enums\RecurrenceDay;
use Spatie\IcalendarGenerator\Enums\RecurrenceFrequency;
use Spatie\IcalendarGenerator\Enums\RecurrenceMonth;
use Spatie\IcalendarGenerator\ValueObjects\RRule;

// Every two weeks on Monday and Wednesday, starting now, for 10 occurrences
$rrule = RRule::frequency(RecurrenceFrequency::Weekly)
    ->interval(2)
    ->times(10)
    ->onWeekDay(RecurrenceDay::Monday)
    ->onWeekDay(RecurrenceDay::Wednesday)
    ->weekStartsOn(RecurrenceDay::Monday);

// Monthly on the last Sunday
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)
    ->onWeekDay(RecurrenceDay::Sunday, -1);  // -1 = last occurrence in month

// Yearly in Q2 only on the 15th of each month
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)
    ->onMonthDay(15)
    ->onMonth([RecurrenceMonth::April, RecurrenceMonth::May, RecurrenceMonth::June])
    ->until(new DateTime('2026-12-31'));

$event = Event::create('Monthly Review')
    ->startsAt(new DateTime('2024-01-15 10:00:00'))
    ->rrule($rrule)
    // Skip specific dates:
    ->doNotRepeatOn([new DateTime('2024-04-15'), new DateTime('2024-08-15')]);

// Raw RRULE string (with optional boundary hints for timezone detection)
$event2 = Event::create('Daily Sync')
    ->startsAt(new DateTime('2024-01-01 09:00:00'))
    ->rruleAsString(
        'FREQ=DAILY;INTERVAL=1;UNTIL=20241231T090000Z',
        new DateTime('2024-01-01 09:00:00', new DateTimeZone('UTC')),
        new DateTime('2024-12-31 09:00:00', new DateTimeZone('UTC'))
    );

// Repeat on explicit dates (RDATE)
$event3 = Event::create('Irregular Meeting')
    ->repeatOn([
        new DateTime('2024-03-05'),
        new DateTime('2024-07-22'),
    ]);
```

--------------------------------

### Set Common Todo Properties

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Configures various properties for a todo item, including description, unique identifier, creation date, timezone settings, classification, URL, sequence, attendees, attachments, address, coordinates, organizer, recurrence rules, and alerts.

```php
Todo::create()
  ->description('Meeting about project updates')
  ->uniqueIdentifier('event-12345')
  ->createdAt(new DateTime('2024-01-15 09:00:00'))
  ->withoutTimezone()
  ->classification(Classification::Public)
  ->url('https://example.com/details')
  ->sequence(1)
  ->attendee('john@example.com')
  ->attachment('https://example.com/file.pdf')
  ->address('123 Main St, New York')
  ->addressName('Conference Room A')
  ->coordinates(40.7128, -74.0060)
  ->organizer('admin@example.com')
  ->rrule('FREQ=DAILY')
  ->alert(Alert::minutesBeforeStart(15))
```

--------------------------------

### Create a Timezone Entry

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Constructs a single entry for a timezone, defining changes relative to UTC. Requires entry type, change date, and UTC offsets before and after the change.

```php
$entry = TimezoneEntry::create(
    TimezoneEntryType::Standard,
    new DateTime('16 may 2020 12:00:00'),
    '+00:00',
    '+02:00'
);
```

--------------------------------

### Create a Timezone

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Initializes a timezone object with a specified identifier, such as 'Europe/Brussels'.

```php
$timezone = Timezone::create('Europe/Brussels');
```

--------------------------------

### Alert — Reminders for events and todos

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Manages reminders (VALARM subcomponents) for events and todos. This can be done using convenience methods like `alertMinutesBefore`, `alertMinutesAfter`, `alertAt` directly on an event, or by creating and attaching an `Alert` object.

```APIDOC
## Alert — Reminders for events and todos

`Alert` static factories create `VALARM` subcomponents. Use `alertMinutesBefore`, `alertMinutesAfter`, or `alertAt` directly on an event or todo, or build an `Alert` object and attach it with `->alert()`.

```php
use Spatie\IcalendarGenerator\Components\Alert;
use Spatie\IcalendarGenerator\Components\Event;

$event = Event::create('Webinar')
    ->startsAt(new DateTime('2024-07-15 14:00:00'))
    ->endsAt(new DateTime('2024-07-15 15:00:00'))
    // Convenience methods (on HasAlerts trait):
    ->alertMinutesBefore(15, 'Webinar starts in 15 minutes')
    ->alertMinutesAfter(5, 'The webinar has ended')
    ->alertAt(new DateTime('2024-07-15 13:00:00'), 'Prepare your slides')
    // Or attach an Alert object directly:
    ->alert(Alert::minutesBeforeStart(30, '30-minute warning'))
    ->alert(Alert::minutesAfterEnd(10, 'Post-webinar reminder'))
    ->alert(Alert::date(new DateTime('2024-07-14 09:00:00'), 'Day-before reminder'));
```
```

--------------------------------

### Set Event as Full Day

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Mark an event as a full-day event.

```php
Event::create()
    ->fullDay()
    ...
```

--------------------------------

### Download Calendar Response with Laravel

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Provides a downloadable iCalendar file for users to import into their calendar applications. Sets Content-Type and Content-Disposition headers.

```php
$calendar = Calendar::create('Laracon Online');

return response($calendar->get(), 200, [
   'Content-Type' => 'text/calendar; charset=utf-8',
   'Content-Disposition' => 'attachment; filename="my-awesome-calendar.ics"',
]);
```

--------------------------------

### Create Event Alert (Specific Time)

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Schedule an alert to trigger at a precise date and time, providing a custom notification message.

```php
Event::create('Laracon Online')
    ->alertAt(
       new DateTime('05/16/2020 12:00:00'),
       'Laracon online has ended, see you next year!'
    );
```

--------------------------------

### Set Event Organizer

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set the organizer for an event. The email address is required, while the name is optional.

```php
Event::create()
    ->organizer('ruben@spatie.be', 'Ruben')
    ...
```

--------------------------------

### Extend Components with Custom Properties and Subcomponents

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Add arbitrary RFC 5545 properties or custom subcomponents not natively supported by the package. This is useful for proprietary extensions like Google's X-GOOGLE-CONFERENCE.

```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Event;
use Spatie\IcalendarGenerator\Properties\Parameter;
use Spatie\IcalendarGenerator\Properties\TextProperty;

// Add a custom property with a parameter
$organizerProperty = TextProperty::create('ORGANIZER', 'mailto:boss@example.com')
    ->addParameter(Parameter::create('CN', 'The Boss'));

$calendar = Calendar::create()
    ->appendProperty(TextProperty::create('X-CUSTOM-PROP', 'custom-value'))
    ->event(
        Event::create('Extended Event')
            ->startsAt(new DateTime('2024-06-01 10:00'))
            ->appendProperty($organizerProperty)
            ->appendSubComponent(
                // Any Component subclass can be nested
                Event::create('Nested virtual event')
            )
    )
    ->get();
```

--------------------------------

### Set Timezone Entry Name and Description

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Adds a human-readable name and description to a timezone entry for better identification.

```php
$entry = TimezoneEntry::create(...)
    ->name('Europe - Brussels')
    ->description('Belgian timezones ftw!');
```

--------------------------------

### Add Events to a Calendar

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Events can be added individually, as an array, or using a closure for inline creation.

```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Event;

// Single event
$calendar = Calendar::create()->event(Event::create('Meetup'));

// Array of events
$calendar = Calendar::create()->event([
    Event::create('Workshop'),
    Event::create('Hackathon'),
]);

// Closure (inline creation)
$calendar = Calendar::create()->event(function (Event $event) {
    $event->name('Inline Event')
          ->startsAt(new DateTime('2024-06-01 09:00'));
});
```

--------------------------------

### Set Todo Completion Date

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Marks a todo item as completed by setting its completion date.

```php
Todo::create()
    ->completedAt(new DateTime('2023-12-25 12:00:00'))
    ...
```

--------------------------------

### Event::fullDay() — All-day event

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Marks an event as an all-day event. When this method is used, the DTSTART property will be formatted as a DATE (without a time component).

```APIDOC
## Event::fullDay() — All-day event

```php
use Spatie\IcalendarGenerator\Components\Event;

$event = Event::create('Public Holiday')
    ->startsAt(new DateTime('2024-12-25'))
    ->fullDay();
// DTSTART will be formatted as DATE (no time component)
```
```

--------------------------------

### Set Todo Percentage Complete

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Indicates the progress of a todo item using a percentage value between 0 and 100.

```php
Todo::create()
    ->percentComplete(75) // In a range from 0 to 100
    ...
```

--------------------------------

### Add URL Attachment

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Add a URL as an attachment to an event. An optional MIME type can be specified.

```php
Event::create()
    ->attachment('https://spatie.be/logo.svg')
    ->attachment('https://spatie.be/feed.xml', 'application/json')
    ...
```

--------------------------------

### Create an event with floating time

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Use `withoutTimezone()` to specify a time that should not be converted to any specific timezone, effectively making it 'noon everywhere'.

```php
use Spatie\IcalendarGenerator\Components\Event;

// Noon everywhere — no timezone conversion applied
$event = Event::create('Global Noon')
    ->startsAt(new DateTime('2024-06-01 12:00:00'))
    ->withoutTimezone();
```

--------------------------------

### Add Attendees to Event

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Add attendees to an event. Only an email address is required, but a name can also be provided.

```php
Event::create()
    ->attendee('ruben@spatie.be') // only an email address is required
    ->attendee('brent@spatie.be', 'Brent')
    ...
```

--------------------------------

### Event location — address, name, and GPS coordinates

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Sets the location details for an event, including a physical address, a display name for the location, and GPS coordinates (latitude and longitude).

```APIDOC
## Event location — address, name, and GPS coordinates

```php
use Spatie\IcalendarGenerator\Components\Event;

$event = Event::create('Company Summit')
    ->address('Kruikstraat 22, 2018 Antwerp, Belgium')
    ->addressName('Spatie HQ')
    ->coordinates(51.2343, 4.4287);    // latitude, longitude
```
```

--------------------------------

### Add Todos to a Calendar

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Todos can be added similarly to events, using Todo::create() and specifying due dates with ->dueAt().

```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Todo;

$calendar = Calendar::create('My Tasks')
    ->todo(Todo::create('Submit report')->dueAt(new DateTime('2024-12-31 23:59:59')))
    ->todo([
        Todo::create('Review PR'),
        Todo::create('Update docs'),
    ])
    ->get();
```

--------------------------------

### Make Event Transparent

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set an event to be transparent, which affects its visual representation in calendar views.

```php
Event::create()
    ->transparent()
    ...
```

--------------------------------

### Add Location to Event

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Add address details and geographical coordinates to an event.

```php
Event::create()
    ->address('Kruikstraat 22, 2018 Antwerp, Belgium')
    ->addressName('Spatie HQ')
    ->coordinates(51.2343, 4.4287)
    ...
```

--------------------------------

### Repeat Event on Specific Date

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Configure an event to repeat on a single, specified date using the `repeatOn` method with a DateTime object.

```php
Event::create('Laracon Online')
    ->repeatOn(new DateTime('05/16/2020 12:00:00'));
```

--------------------------------

### Create DateTime with Timezone

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

When creating DateTime objects, specify the timezone to avoid unexpected behavior. Do not use setTimezone on existing objects.

```php
new DateTime('6 march 2019 15:00', new DateTimeZone('Europe/Brussels'))
```

--------------------------------

### Repeat on Specific Weekday Monthly

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Configure monthly recurrence to occur on a specific weekday, like every Friday.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)->onWeekDay(
   RecurrenceDay::Friday
);
```

--------------------------------

### Repeat on Multiple Month Days

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Specify recurrence to occur on an array of specific days within a month.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)->onMonthDay(
   [5, 10, 15, 20]
);
```

--------------------------------

### Calendar::event()

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Adds events to the calendar. Events can be provided as a single `Event` instance, an array of instances, or defined inline using a closure.

```APIDOC
## Calendar::event()

### Description
Adds events to a calendar. Events can be added as an `Event` instance, an array of instances, or via a closure.

### Method
`Calendar::event(Event|array<Event>|callable(Event): void $event)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Usage
```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Event;

// Single event
$calendar = Calendar::create()->event(Event::create('Meetup'));

// Array of events
$calendar = Calendar::create()->event([
    Event::create('Workshop'),
    Event::create('Hackathon'),
]);

// Closure (inline creation)
$calendar = Calendar::create()->event(function (Event $event) {
    $event->name('Inline Event')
          ->startsAt(new DateTime('2024-06-01 09:00'));
});
```

### Response
#### Success Response (200)
Returns the `Calendar` instance for chaining.

#### Response Example
None provided.
```

--------------------------------

### Set Attendee Participation Status

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set the participation status for an attendee. Available statuses include Accepted, Declined, Tentative, NeedsAction, and Delegated.

```php
Event::create()
    ->attendee('ruben@spatie.be', 'Ruben', ParticipationStatus::Accepted)
    ...
```

--------------------------------

### Repeat on Specific Months

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Configure recurrence to occur only in specified months of the year.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)->onMonth(
   [RecurrenceMonth::April, RecurrenceMonth::May, RecurrenceMonth::June]
);
```

--------------------------------

### Repeat on Last Weekday of Month

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set recurrence to occur on the last instance of a specific weekday in a month, indicated by a negative index.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)->onWeekDay(
   RecurrenceDay::Sunday, -1
);
```

--------------------------------

### RRule - Recurrence Rules

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Build structured recurrence rules using `RRule::frequency()` and chain various modifiers to define complex repeating events.

```APIDOC
## RRule — Recurrence rules

Build structured recurrence rules with `RRule::frequency()` and chain modifiers.

```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Event;
use Spatie\IcalendarGenerator\Enums\RecurrenceDay;
use Spatie\IcalendarGenerator\Enums\RecurrenceFrequency;
use Spatie\IcalendarGenerator\Enums\RecurrenceMonth;
use Spatie\IcalendarGenerator\ValueObjects\RRule;

// Every two weeks on Monday and Wednesday, starting now, for 10 occurrences
$rrule = RRule::frequency(RecurrenceFrequency::Weekly)
    ->interval(2)
    ->times(10)
    ->onWeekDay(RecurrenceDay::Monday)
    ->onWeekDay(RecurrenceDay::Wednesday)
    ->weekStartsOn(RecurrenceDay::Monday);

// Monthly on the last Sunday
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)
    ->onWeekDay(RecurrenceDay::Sunday, -1);  // -1 = last occurrence in month

// Yearly in Q2 only on the 15th of each month
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)
    ->onMonthDay(15)
    ->onMonth([RecurrenceMonth::April, RecurrenceMonth::May, RecurrenceMonth::June])
    ->until(new DateTime('2026-12-31'));

$event = Event::create('Monthly Review')
    ->startsAt(new DateTime('2024-01-15 10:00:00'))
    ->rrule($rrule)
    // Skip specific dates:
    ->doNotRepeatOn([new DateTime('2024-04-15'), new DateTime('2024-08-15')]);

// Raw RRULE string (with optional boundary hints for timezone detection)
$event2 = Event::create('Daily Sync')
    ->startsAt(new DateTime('2024-01-01 09:00:00'))
    ->rruleAsString(
        'FREQ=DAILY;INTERVAL=1;UNTIL=20241231T090000Z',
        new DateTime('2024-01-01 09:00:00', new DateTimeZone('UTC')),
        new DateTime('2024-12-31 09:00:00', new DateTimeZone('UTC'))
    );

// Repeat on explicit dates (RDATE)
$event3 = Event::create('Irregular Meeting')
    ->repeatOn([
        new DateTime('2024-03-05'),
        new DateTime('2024-07-22'),
    ]);
```
```

--------------------------------

### Calendar::todo()

Source: https://context7.com/spatie/icalendar-generator/llms.txt

Adds todos to the calendar, similar to how events are added. Accepts a single `Todo` instance, an array of instances, or a closure for inline creation.

```APIDOC
## Calendar::todo()

### Description
Adds todos to a calendar. Todos are added the same way as events.

### Method
`Calendar::todo(Todo|array<Todo>|callable(Todo): void $todo)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Usage
```php
use Spatie\IcalendarGenerator\Components\Calendar;
use Spatie\IcalendarGenerator\Components\Todo;

$calendar = Calendar::create('My Tasks')
    ->todo(Todo::create('Submit report')->dueAt(new DateTime('2024-12-31 23:59:59')))
    ->todo([
        Todo::create('Review PR'),
        Todo::create('Update docs'),
    ])
    ->get();
```

### Response
#### Success Response (200)
Returns the `Calendar` instance for chaining.

#### Response Example
None provided.
```

--------------------------------

### Set Event Status

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Set the overall status of an event. Available statuses are Confirmed, Cancelled, and Tentative.

```php
Event::create()
    ->status(EventStatus::Cancelled)
    ...
```

--------------------------------

### Set Todo Priority

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Assigns a priority level to a todo item, with values ranging from 0 (highest) to 9 (lowest).

```php
Todo::create()
    ->priority(1) // In a range from 0 to 9
    ...
```

--------------------------------

### Add Recurrence Rule as String

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Incorporate a recurrence rule directly as a string, without parsing.

```php
Event::create('SymfonyCon')
    ->rruleAsString('FREQ=DAILY;INTERVAL=1');
```

--------------------------------

### Set Timezone URL

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Associates a URL with the timezone, providing additional information or resources.

```php
$timezone = Timezone::create('Europe/Brussels')
    ->url('https://spatie.be');
```

--------------------------------

### Stream Calendar Response with Laravel

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Returns an iCalendar response directly to the browser, suitable for streaming to calendar applications. Sets the appropriate Content-Type header.

```php
$calendar = Calendar::create('Laracon Online');

return response($calendar->get())
    ->header('Content-Type', 'text/calendar; charset=utf-8');
```

--------------------------------

### Repeat on Nth Weekday of Month

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Specify recurrence on a particular occurrence of a weekday within a month, e.g., the 3rd Friday.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)->onWeekDay(
   RecurrenceDay::Friday, 3
);
```

--------------------------------

### Add Image to Event

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Add an image to an event, optionally specifying the MIME type and display type (Badge, Graphic, Fullsize, Thumbnail).

```php
Event::create()
    ->image('https://spatie.be/logo.svg')
    ->image('https://spatie.be/logo.svg', 'text/svg+xml')
    ->image('https://spatie.be/logo.svg', 'text/svg+xml', Display::Badge)
    ...
```

--------------------------------

### Repeat on Specific Month Day

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Define monthly recurrence to occur on a particular day of the month.

```php
$rrule = RRule::frequency(RecurrenceFrequency::Monthly)->onMonthDay(16);
```

--------------------------------

### Set calendar refresh interval

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Configure the refresh interval for the calendar in minutes. This informs calendar applications when to check for updates.

```php
Calendar::create('Laracon Online')
    ->refreshInterval(5)
    ...
```

--------------------------------

### Manually Add Timezone Entry

Source: https://github.com/spatie/icalendar-generator/blob/main/README.md

Manually add timezone information to a calendar by creating `TimezoneEntry` and `Timezone` objects and associating them with the calendar.

```php
$timezoneEntry = TimezoneEntry::create(
    TimezoneEntryType::Daylight,
    new DateTime('23 march 2020'),
    '+00:00',
    '+02:00'
);

$timezone = Timezone::create('Europe/Brussels')
    ->entry($timezoneEntry)
    ...

Calendar::create()
    ->timezone($timezone)
    ...
```
Tokens:
Raw