bnomei/kirby3-ics

Generate ICS Files

1.0.7 2023-08-02 10:29 UTC

Requires

• php: >=8.0
• getkirby/composer-installer: ^1.1
• kigkonsult/icalcreator: ^2.27

Requires (Dev)

• getkirby/cms: ^3.2
• php-coveralls/php-coveralls: ^2.1
• phpunit/phpunit: ^8.3

Suggests

• bnomei/kirby3-calendar: Build customizable structures for calendar events
• bnomei/kirby3-janitor: Provides tools to add a custom Panel button to trigger download of ICS/CSV/QRCode Files

MIT

• Bruno Meilick

• event
• calendar
• events
• iCalendar
• ics
• ical
• Organizer
• attendee
• alarm
• rfc2445
• rfc5545
• kirby3
• kirby3-cms
• kirby3-plugin

README

Generate ICS Files.

Commerical Usage

Support open source!

This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?

Be kind. Share a little. Thanks.

‐ Bruno
 

M	O	N	E	Y
Github sponsor	Patreon	Buy Me a Coffee	Paypal dontation	Hire me

Installation

• unzip master.zip as folder site/plugins/kirby3-ics or
• git submodule add https://github.com/bnomei/kirby3-ics.git site/plugins/kirby3-ics or
• composer require bnomei/kirby3-ics

Usecase

Plain PHP

// automatic id
$ics = new \Bnomei\ICS();
$id = $ics->id();

// or use custom id
$id = sha1('myUniqueID');

// provide custom options
$ics = new \Bnomei\ICS([
    Vcalendar::UNIQUE_ID => $id,
]);

// maybe reuse a static object identified by id
// otherwise it will be created now
$ics = \Bnomei\ICS::createOrLoad($id);

// get Vcalendar object...
$vcalendar = $ics->vcalendar();
// ... apply your ics data (see docs of lib)
// then retrieve the ics string
echo $ics;

Page Method

Use the ics()->vcalendar()-method to retrieve the Vcalender Object then add properties, events and alarms. Please read the original docs of used lib for an overview about what is possible.

site/templates/default.php

$vcalendar = $page->ics()->vcalendar();

$vcalendar->setXprop(Vcalendar::X_WR_CALDESC, "This is a demo calendar");

$event1 = $vcalendar->newVevent()
    ->setTransp( Vcalendar::OPAQUE )
    ->setClass( Vcalendar::P_BLIC )
    ->setSequence( 1 )
    // describe the event
    ->setSummary( 'Scheduled meeting with five occurrences' )
    ->setDescription(
         'Agenda for the the meeting...',
         [ Vcalendar::ALTREP => 
             'CID:<FFFF__=[e-mail]>' ]
    )
    ->setComment( 'It\'s going to be fun..' )
    // place the event
    ->setLocation( 'Kafé Ekorren Stockholm' )
    ->setGeo( '59.32206', '18.12485' )
    // set the time
    ->setDtstart(
        new DateTime(
            '20190421T090000',
            new DateTimezone( 'Europe/Stockholm' )
        )
    )
    ->setDtend(
        new DateTime(
            '20190421T100000',
            new DateTimezone( 'Europe/Stockholm' )
        )
    );

echo $page->ics();

TIP: You can retrieve the static unique object for a page using the page method $page->ics(). This makes it possible to prepare the ICS in a page model or page controller and just display the data in your template or content representation. Check out the tests for an example.

Content Representations

Assuming you prepared your ics data in a model or controller your content representation could be as short as this example.

site/templates/default.ics.php

$page->ics()->download(
    $page->slug() . '.ics'
);

Dependencies

• iCalcreator/iCalcreator

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.

Credits

based on V2 versions of

• https://github.com/moritzz/Kirby-Calendar