added timezone, and description for event's notes

Signed-off-by: Mua N. Laurent <[email protected]>

Author: muarachmann

src/DataTypes/Calendar.php

@@ -4,6 +4,7 @@
 
 use DateTime;
 use BaconQrCode\Exception\InvalidArgumentException;
+use DateTimeZone;
 use Exception;
 
 class Calendar implements DataTypeInterface
@@ -66,6 +67,14 @@ class Calendar implements DataTypeInterface
      */
     protected $endDateTime;
 
+    /**
+     * Start/End date timezone.
+     * e.g 'Africa/Douala'
+     *
+     * @var string
+     */
+    protected $timezone;
+
     /**
      * The standard format for the [$statDateTime] and [$endDateTime].
      * Gets overridden if user specifies their own formats [$dateTimeFormat].
@@ -81,6 +90,13 @@ class Calendar implements DataTypeInterface
      */
     protected $description;
 
+    /**
+     * Alarm/Reminder. Trigger's before event
+     *
+     * @var string
+     */
+    protected $alarm;
+
     /**
      * Generates the DataType Object and sets all of its properties.
      *
@@ -114,10 +130,18 @@ protected function buildCalendarString()
             $calendar .= "SUMMARY:".$this->summary.$this->separator;
         }
         if (isset($this->startDateTime)) {
-            $calendar .= "DTSTART:".$this->startDateTime.$this->separator;
+            $calendar .= "DTSTART";
+            if (isset($this->timezone)) {
+                $calendar .= $this->timezone;
+            }
+            $calendar .= ":".$this->startDateTime.$this->separator;
         }
         if (isset($this->endDateTime)) {
-            $calendar .= "DTEND:".$this->endDateTime.$this->separator;
+            $calendar .= "DTEND";
+            if (isset($this->timezone)) {
+                $calendar .= $this->timezone;
+            }
+            $calendar .= ":".$this->endDateTime.$this->separator;
         }
         if (isset($this->location)) {
             $calendar .= "LOCATION:".$this->location.$this->separator;
@@ -128,6 +152,12 @@ protected function buildCalendarString()
         if (isset($this->description)) {
             $calendar .= "DESCRIPTION:".$this->description.$this->separator;
         }
+        if (isset($this->alarm)) {
+            $calendar .= "BEGIN:VALARM".$this->separator;
+            $calendar .= "TRIGGER:-PT".$this->alarm.$this->separator;
+            $calendar .= "ACTION:DISPLAY";
+            $calendar .= "END:VALARM".$this->separator;
+        }
 
         $calendar .= $this->suffix;
 
@@ -151,6 +181,9 @@ protected function setProperties(array $arguments)
             if (isset($arguments['dateTimeFormat'])) {
                 $this->dateTimeFormat = $arguments['dateTimeFormat'];
             }
+            if (isset($arguments['timezone'])) {
+                $this->setEventTimeZone($arguments['timezone']);
+            }
 
             $this->summary = $arguments['summary'];
             $this->setEventDateTime($arguments['startDateTime'], "start");
@@ -261,4 +294,57 @@ protected function convertEventDateTimeToString($dateTime)
         }
         return $date->format('yymd\THms');
     }
+
+    /**
+     * Ensures alarm string is valid.
+     * e.g [0M, 20M, 10H, 100H]
+     * Runs before the event (10 minutes before [$startDateTime])
+     *
+     * @param string $alarm
+     *
+     * @return bool
+     */
+    protected function isValidAlarmTime($alarm)
+    {
+        return true;
+    }
+
+    /**
+     * Ensures timezone string is valid. ('Africa/Douala')
+     *
+     * @param string $timezone
+     *
+     * @return bool
+     */
+    protected function isValidTimeZone($timezone)
+    {
+        if (! in_array($timezone, DateTimeZone::listIdentifiers())) {
+            throw new InvalidArgumentException('Invalid timezone provided.');
+        }
+        return true;
+    }
+
+    /**
+     * Sets the timezone property.
+     *
+     * @param $timezone
+     */
+    protected function setEventTimeZone($timezone)
+    {
+        if ($this->isValidTimeZone($timezone)) {
+            $this->timezone = ";TZID=".$timezone;
+        }
+    }
+
+    /**
+     * Sets the alarm property.
+     *
+     * @param $alarm
+     */
+    protected function setAlarm($alarm)
+    {
+        if ($this->isValidAlarmTime($alarm)) {
+            $this->alarm = $alarm;
+        }
+    }
 }

tests/DataTypes/CalendarTest.php

@@ -173,6 +173,7 @@ public function test_it_generates_a_proper_format_with_calendar_parameters()
                 'startDateTime' => '2020-10-08 16:00',
                 'endDateTime' => '2020-10-08 18:00',
                 'location' => 'Foo Location',
+                'timezone' => 'Africa/Douala',
                 'url' => 'https://www.google.com',
                 'dateTimeFormat' => 'Y-m-d H:i',
                 'description' => 'FooBar\'s Event description can be longer than this.'
@@ -181,8 +182,8 @@ public function test_it_generates_a_proper_format_with_calendar_parameters()
 
         $properFormat = "BEGIN:VEVENT".$this->separator.
             "SUMMARY:My FooBar Event".$this->separator.
-            "DTSTART:20201008T161000".$this->separator.
-            "DTEND:20201008T181000".$this->separator.
+            "DTSTART;TZID=Africa/Douala:20201008T161000".$this->separator.
+            "DTEND;TZID=Africa/Douala:20201008T181000".$this->separator.
             "LOCATION:Foo Location".$this->separator.
             "URL:https://www.google.com".$this->separator.
             "DESCRIPTION:FooBar's Event description can be longer than this.".$this->separator.