Add event organizer

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+-   Event organizer
+
 ## [2.1.0] - 2021-04-21
 
 ### Fixed

examples/example1.php

@@ -18,8 +18,10 @@
 use Eluceo\iCal\Domain\ValueObject\Alarm;
 use Eluceo\iCal\Domain\ValueObject\Attachment;
 use Eluceo\iCal\Domain\ValueObject\DateTime;
+use Eluceo\iCal\Domain\ValueObject\EmailAddress;
 use Eluceo\iCal\Domain\ValueObject\GeographicPosition;
 use Eluceo\iCal\Domain\ValueObject\Location;
+use Eluceo\iCal\Domain\ValueObject\Organizer;
 use Eluceo\iCal\Domain\ValueObject\TimeSpan;
 use Eluceo\iCal\Domain\ValueObject\Uri;
 use Eluceo\iCal\Presentation\Factory\CalendarFactory;
@@ -31,6 +33,10 @@
 $event
     ->setSummary('Christmas Eve')
     ->setDescription('Lorem Ipsum Dolor...')
+    ->setOrganizer(new Organizer(
+        new EmailAddress('john.doe@example.com'),
+        'John Doe'
+    ))
     ->setLocation(
         (new Location('Neuschwansteinstraße 20, 87645 Schwangau', 'Schloss Neuschwanstein'))
             ->withGeographicPosition(new GeographicPosition(47.557579, 10.749704))

src/Domain/Entity/Event.php

@@ -15,6 +15,7 @@
 use Eluceo\iCal\Domain\ValueObject\Attachment;
 use Eluceo\iCal\Domain\ValueObject\Location;
 use Eluceo\iCal\Domain\ValueObject\Occurrence;
+use Eluceo\iCal\Domain\ValueObject\Organizer;
 use Eluceo\iCal\Domain\ValueObject\Timestamp;
 use Eluceo\iCal\Domain\ValueObject\UniqueIdentifier;
 
@@ -26,6 +27,7 @@ class Event
     private ?string $description = null;
     private ?Occurrence $occurrence = null;
     private ?Location $location = null;
+    private ?Organizer $organizer = null;
 
     /**
      * @var array<Alarm>
@@ -150,6 +152,25 @@ public function hasLocation(): bool
         return $this->location !== null;
     }
 
+    public function getOrganizer(): Organizer
+    {
+        assert($this->organizer !== null);
+
+        return $this->organizer;
+    }
+
+    public function setOrganizer(?Organizer $organizer): self
+    {
+        $this->organizer = $organizer;
+
+        return $this;
+    }
+
+    public function hasOrganizer(): bool
+    {
+        return $this->organizer !== null;
+    }
+
     /**
      * @return Alarm[]
      */

src/Domain/ValueObject/EmailAddress.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the eluceo/iCal package.
+ *
+ * (c) 2021 Markus Poerschke <markus@poerschke.nrw>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Eluceo\iCal\Domain\ValueObject;
+
+use InvalidArgumentException;
+
+final class EmailAddress
+{
+    private string $emailAddress;
+
+    public function __construct(string $emailAddress)
+    {
+        if (!filter_var($emailAddress, FILTER_VALIDATE_EMAIL)) {
+            throw new InvalidArgumentException("$emailAddress is no valid e-mail address");
+        }
+
+        $this->emailAddress = $emailAddress;
+    }
+
+    public function getEmailAddress(): string
+    {
+        return $this->emailAddress;
+    }
+
+    public function toUri(): Uri
+    {
+        return new Uri('mailto:' . urlencode($this->emailAddress));
+    }
+}

src/Domain/ValueObject/Organizer.php

@@ -0,0 +1,83 @@
+<?php
+
+/*
+ * This file is part of the eluceo/iCal package.
+ *
+ * (c) 2021 Markus Poerschke <markus@poerschke.nrw>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Eluceo\iCal\Domain\ValueObject;
+
+final class Organizer
+{
+    private EmailAddress $emailAddress;
+    private ?string $displayName;
+
+    /**
+     * The e-mail address of another user that is acting on behalf of the "Organizer".
+     */
+    private ?EmailAddress $sentBy;
+
+    /**
+     * To specify reference to a directory entry associated wit the calendar user specified by the property.
+     *
+     * @see https://tools.ietf.org/html/rfc5545#section-3.2.6
+     */
+    private ?Uri $directoryEntry;
+
+    public function __construct(
+        EmailAddress $emailAddress,
+        ?string $displayName = null,
+        ?Uri $directoryEntry = null,
+        ?EmailAddress $sentBy = null
+    ) {
+        $this->emailAddress = $emailAddress;
+        $this->displayName = $displayName;
+        $this->directoryEntry = $directoryEntry;
+        $this->sentBy = $sentBy;
+    }
+
+    public function getEmailAddress(): EmailAddress
+    {
+        return $this->emailAddress;
+    }
+
+    public function hasDisplayName(): bool
+    {
+        return $this->displayName !== null;
+    }
+
+    public function getDisplayName(): string
+    {
+        assert($this->displayName !== null);
+
+        return $this->displayName;
+    }
+
+    public function isSentInBehalfOf(): bool
+    {
+        return $this->sentBy !== null;
+    }
+
+    public function getSentBy(): EmailAddress
+    {
+        assert($this->sentBy !== null);
+
+        return $this->sentBy;
+    }
+
+    public function hasDirectoryEntry(): bool
+    {
+        return $this->directoryEntry !== null;
+    }
+
+    public function getDirectoryEntry(): Uri
+    {
+        assert($this->directoryEntry !== null);
+
+        return $this->directoryEntry;
+    }
+}

src/Presentation/Factory/EventFactory.php

@@ -18,6 +18,7 @@
 use Eluceo\iCal\Domain\ValueObject\Attachment;
 use Eluceo\iCal\Domain\ValueObject\MultiDay;
 use Eluceo\iCal\Domain\ValueObject\Occurrence;
+use Eluceo\iCal\Domain\ValueObject\Organizer;
 use Eluceo\iCal\Domain\ValueObject\SingleDay;
 use Eluceo\iCal\Domain\ValueObject\TimeSpan;
 use Eluceo\iCal\Presentation\Component;
@@ -91,6 +92,10 @@ protected function getProperties(Event $event): Generator
             yield from $this->getLocationProperties($event);
         }
 
+        if ($event->hasOrganizer()) {
+            yield $this->getOrganizerProperty($event->getOrganizer());
+        }
+
         foreach ($event->getAttachments() as $attachment) {
             yield from $this->getAttachmentProperties($attachment);
         }
@@ -179,4 +184,23 @@ private function getAttachmentProperties(Attachment $attachment): Generator
             );
         }
     }
+
+    private function getOrganizerProperty(Organizer $organizer): Property
+    {
+        $parameters = [];
+
+        if ($organizer->hasDisplayName()) {
+            $parameters[] = new Parameter('CN', new TextValue($organizer->getDisplayName()));
+        }
+
+        if ($organizer->hasDirectoryEntry()) {
+            $parameters[] = new Parameter('DIR', new UriValue($organizer->getDirectoryEntry()));
+        }
+
+        if ($organizer->isSentInBehalfOf()) {
+            $parameters[] = new Parameter('SENT-BY', new UriValue($organizer->getSentBy()->toUri()));
+        }
+
+        return new Property('ORGANIZER', new UriValue($organizer->getEmailAddress()->toUri()), $parameters);
+    }
 }