Merge pull request #178 from S-Braeutigam/ics_reminder

Add reminder functionality to ICS

README.md

@@ -72,6 +72,12 @@ echo $link->ics();
 echo $link->ics(['URL' => 'https://my-page.com', 'UID' => 'custom-id']); // 
 echo $link->ics([], ['format' => 'file']); // e.g. to attach ics as a file to an email.
 
+// Generate a data uri for an ics file with default reminder (for iCal & Outlook)
+echo $link->ics(['REMINDER' => []]);
+
+// Generate a data uri for an ics file with a custom reminder (for iCal & Outlook)
+echo $link->ics(['REMINDER' => ['DESCRIPTION' => 'Remind me', 'TIME' => DateTime::createFromFormat('Y-m-d H:i', '2018-02-01 08:15', new DateTimeZone('UTC'))]]);
+
 // Generate a data URI using arbitrary generator:
 echo $link->formatWith(new \Your\Generator());
 ```

src/Generators/Ics.php

@@ -69,6 +69,24 @@ public function generate(Link $link): string
             $url[] = 'URL;VALUE=URI:'.$this->options['URL'];
         }
 
+        if (isset($this->options['REMINDER'])) {
+            $description = 'Reminder: '.$this->escapeString($link->title);
+            if (isset($this->options['REMINDER']['DESCRIPTION'])) {
+                $description = $this->escapeString($this->options['REMINDER']['DESCRIPTION']);
+            }
+
+            $trigger = '-PT15M';
+            if (isset($this->options[ 'REMINDER'][ 'TIME'])) {
+                $trigger = 'VALUE=DATE-TIME:'.gmdate($dateTimeFormat, $this->options[ 'REMINDER'][ 'TIME']->getTimestamp());
+            }
+
+            $url[] = 'BEGIN:VALARM';
+            $url[] = 'ACTION:DISPLAY';
+            $url[] = 'DESCRIPTION:'.$description;
+            $url[] = 'TRIGGER:'.$trigger;
+            $url[] = 'END:VALARM';
+        }
+
         $url[] = 'END:VEVENT';
         $url[] = 'END:VCALENDAR';
 

tests/Generators/IcsGeneratorTest.php

@@ -2,6 +2,8 @@
 
 namespace Spatie\CalendarLinks\Tests\Generators;
 
+use DateTime;
+use DateTimeZone;
 use Spatie\CalendarLinks\Generator;
 use Spatie\CalendarLinks\Generators\Ics;
 use Spatie\CalendarLinks\Tests\TestCase;
@@ -73,4 +75,23 @@ public function it_correctly_generates_all_day_events_by_dates(): void
             $this->generator()->generate($this->createEventMultipleDaysViaStartEndWithTimezoneLink())
         );
     }
+
+    /** @test */
+    public function it_can_generate_with_a_default_reminder(): void
+    {
+        $this->assertMatchesSnapshot(
+            $this->generator(['REMINDER' => []])->generate($this->createShortEventLink())
+        );
+    }
+
+    /** @test */
+    public function it_can_generate_with_a_custom_reminder(): void
+    {
+        $this->assertMatchesSnapshot(
+            $this->generator(['REMINDER' => [
+                'DESCRIPTION' => 'Party with balloons and cake!',
+                'TIME' => DateTime::createFromFormat('Y-m-d H:i', '2018-02-01 08:15', new DateTimeZone('UTC'))
+            ]])->generate($this->createShortEventLink())
+        );
+    }
 }

tests/Generators/__snapshots__/IcsGeneratorTest__it_can_generate_with_a_custom_reminder__1.txt

@@ -0,0 +1,18 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:Spatie calendar-links
+BEGIN:VEVENT
+UID:94ab75add84a67c019eae57539658036
+SUMMARY:Birthday
+DTSTAMP:20180201T090000Z
+DTSTART:20180201T090000Z
+DTEND:20180201T180000Z
+DESCRIPTION:With balloons\, clowns and stuff\nBring a dog\, bring a frog
+LOCATION:Party Lane 1A\, 1337 Funtown
+BEGIN:VALARM
+ACTION:DISPLAY
+DESCRIPTION:Party with balloons and cake!
+TRIGGER:VALUE=DATE-TIME:20180201T081500Z
+END:VALARM
+END:VEVENT
+END:VCALENDAR

tests/Generators/__snapshots__/IcsGeneratorTest__it_can_generate_with_a_default_reminder__1.txt

@@ -0,0 +1,18 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:Spatie calendar-links
+BEGIN:VEVENT
+UID:94ab75add84a67c019eae57539658036
+SUMMARY:Birthday
+DTSTAMP:20180201T090000Z
+DTSTART:20180201T090000Z
+DTEND:20180201T180000Z
+DESCRIPTION:With balloons\, clowns and stuff\nBring a dog\, bring a frog
+LOCATION:Party Lane 1A\, 1337 Funtown
+BEGIN:VALARM
+ACTION:DISPLAY
+DESCRIPTION:Reminder: Birthday
+TRIGGER:-PT15M
+END:VALARM
+END:VEVENT
+END:VCALENDAR