spatie/calendar-links

Generate add to calendar links for Google, iCal and other calendar systems

Generate add to calendar links for Google, iCal and other calendar systems

, _(*1)

Using this package, you can generate links to add events to calendar systems. Here's a quick example:, _(*2)

use Spatie\CalendarLinks\Link;

Link::create(
    'Birthday',
    DateTime::createFromFormat('Y-m-d H:i', '2018-02-01 09:00'),
    DateTime::createFromFormat('Y-m-d H:i', '2018-02-01 18:00')
)->google();

This will output: https://calendar.google.com/calendar/render?action=TEMPLATE&text=Birthday&dates=20180201T090000/20180201T180000&sprop=&sprop=name:, _(*3)

If you follow that link (and are authenticated with Google), you’ll see a screen to add the event to your calendar., _(*4)

The package can also generate ics files that you can open in several email and calendar programs, including Microsoft Outlook, Google Calendar, and Apple Calendar., _(*5)

Support us

, _(*6)

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products., _(*7)

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall., _(*8)

Installation

You can install the package via composer:, _(*9)

composer require spatie/calendar-links

Usage

<?php
use Spatie\CalendarLinks\Link;

$from = DateTime::createFromFormat('Y-m-d H:i', '2018-02-01 09:00');
$to = DateTime::createFromFormat('Y-m-d H:i', '2018-02-01 18:00');

$link = Link::create('Sebastian’s birthday', $from, $to)
    ->description('Cookies & cocktails!')
    ->address('Kruikstraat 22, 2018 Antwerpen');

// Generate a link to create an event on Google calendar
echo $link->google();

// Generate a link to create an event on Yahoo calendar
echo $link->yahoo();

// Generate a link to create an event on outlook.live.com calendar
echo $link->webOutlook();

// Generate a link to create an event on outlook.office.com calendar
echo $link->webOffice();

// Generate a data URI for an ics file (for iCal & Outlook)
echo $link->ics();
echo $link->ics(['UID' => 'custom-id']); // Custom UID (to update existing events)
echo $link->ics(['URL' => 'https://my-page.com']); // Custom URL
echo $link->ics(['REMINDER' => []]); // Add the default reminder (for iCal & Outlook)
echo $link->ics(['REMINDER' => ['DESCRIPTION' => 'Remind me', 'TIME' => new \DateTime('tomorrow 12:30 UTC')]]); // Add a custom reminder
echo $link->ics([], ['format' => 'file']); // use file output; e.g. to attach ics as a file to an email.

// Generate a data URI using arbitrary generator:
echo $link->formatWith(new \Your\Generator());

Package principles

1. it should produce a small output (to keep page-size small)
2. it should be fast (no any external heavy dependencies)
3. all Link class features should be supported by at least 2 generators (different services have different features)

Changelog

Please see CHANGELOG for more information., _(*10)

Testing

composer test

Contributing

Please see CONTRIBUTING for details., _(*11)

Security

If you've found a bug regarding security, please mail security@spatie.be instead of using the issue tracker., _(*12)

Postcardware

You're free to use this package (it's MIT-licensed), 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., _(*13)

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium., _(*14)

We publish all received postcards on our company website., _(*15)

Credits

• Sebastian De Deyne
• All Contributors

License

The MIT License (MIT). Please see License File for more information., _(*16)