You can install the package via composer:

composer require spatie/icalendar-generator

Here’s how you can create a calendar:

$calendar = Calendar::create();

You can give a name to a calendar:

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

A description can be added to an calendar:

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

In the end, you want to convert your calendar to text so it can be streamed or downloaded to the user. Here’s how you do that:

Calendar::create('Laracon Online')->get(); // BEGIN:VCALENDAR ...

An event can be created as follows. A name is not required, but a start date should always be given:

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

You can set the following properties on an event:

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'));

Want to create an event quickly with start and end date?

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

You can add a location to an event a such:

Event::create()  ->address('Samberstraat 69D, 2060 Antwerp, Belgium')  ->addressName('Spatie HQ')  ->coordinates(51.2343, 4.4287)  ...

You can set the organizer of an event, the email address is required but the name can be omitted:

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

Attendees of an event can be added as such

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

You can also set the participation status of an attendee:

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

There are three participation statuses:

• ParticipationStatus::accepted()
• ParticipationStatus::declined()
• ParticipationStatus::tentative()

An event can be made transparent, so it does not overlap visually with other events in a calendar:

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

After creating your event, it should be added to a calendar. There are multiple options to do this:

// As a single event parameter $event = Event::create('Creating calendar feeds');  Calendar::create('Laracon Online')  ->event($event)  ...  // As an array of events Calendar::create('Laracon Online')  ->event([  Event::create('Creating calender feeds'),  Event::create('Creating contact lists'),  ])  ...    // As a closure Calendar::create('Laracon Online')  ->event(function(Event $event){  $event->name('Creating calender feeds');  })  ...

By default, events will not use timezones. This means an event like noon at 12 o’clock will be shown for someone in New York at a different time than for someone in Sydney.

If you want to show an event at the exact time it is happening, for example, a talk at an online conference streamed around the world. Then you should consider using timezones.

Alerts allow calendar clients to send reminders about specific events. For example, Apple Mail on an iPhone will send users a notification about the event. An alert always belongs to an event and has a description and the number of minutes before the event it will be triggered:

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

You can also trigger an alert after the event:

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

Or trigger an alert on a specific date:

Event::create('Laracon Online')  ->alert(Alert::date(  new DateTime('05/16/2020 12:00:00'),  'Laracon online has ended, see you next year!'  ))

You can use Laravel Responses to stream to calendar applications:

$calendar = Calendar::create('Laracon Online');  response($calendar->get())  ->header('Content-Type', 'text/calendar')  ->header('charset', 'utf-8');

If you want to add the possibility for users to download a calendar and import it into a calendar application:

$calendar = Calendar::create('Laracon Online');  response($calendar->get())  ->header('Content-Type', 'text/calendar')  ->header('charset', 'utf-8')  ->download('my-awesome-calendar.ics');

We try to keep this package as straightforward as possible. That’s why a lot of properties and subcomponents from the RFC are not included in this package. We’ve made it possible to add other properties or subcomponents to each component in case you might need something not included in the package. But be careful! From this moment, you’re on your own correctly implementing the RFC’s.

You can add a new property to a component like this:

Calendar::create()  ->appendProperty(  TextPropertyType::create('ORGANIZER', 'ruben@spatie.be')  )  ...

Here we’ve added a TextPropertyType, and this is a default key-value property type with a text as value. You can also use the DateTimePropertyType, the DurationPropertyType or create your own by extending the PropertyType class.

Sometimes a property can have some additional parameters, these are key-value entries and can be added to properties as such:

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

A subcomponent can be appended as such:

Calendar::create()  ->appendSubComponent(  Event::create('Extending icalendar-generator')  )  ...

It is possible to create your subcomponents by extending the Component class.

You’re free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.