Skip to content

Latest commit

 

History

History
110 lines (74 loc) · 4.13 KB

README.md

File metadata and controls

110 lines (74 loc) · 4.13 KB
Raw

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

Latest Version on Packagist Build Status SensioLabsInsight Quality Score StyleCI Total Downloads

Using this package you can generate links to add events to calendar systems. Here's a quick example:

(new Link(
   '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:

If you follow that link (and are authenticated with Google) you'll see a screen to add the event to your calendar.

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.

Installation

You can install the package via composer:

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

// General link properties
$link = Link::create('Sebastian\'s birthday', $from, $to)
    ->description('Cookies & cocktails!')
    ->address('Samberstraat 69D, 2060 Antwerpen')

    // Google calendar likn extra fields
    ->timezone('Europe/Bucharest')

    // ICS extra fields
    ->prodid('-//Company//ICS Link//EN')
    ->uid(3)
    ->status('Some status')
    ->dtstamp(DateTime::now())
    ->attendee('Attendee name 1', 'Attendee email 2')
    ->attendee('Attendee name 2', 'Attendee email 2')
    ->attendee('Attendee name 3', 'Attendee email 3')
    ->organizer('Organizer name', 'Organizer email')

// 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 data uri for an ics file (for iCal & Outlook)
echo $link->ics();

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

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.

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

We publish all received postcards on our company website.

Credits

Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.

License

The MIT License (MIT). Please see License File for more information.