ISSUE-345: relation to template in message

Author: tatevikg1

Diff for: src/Domain/Model/Messaging/Message.php

@@ -49,13 +49,18 @@ class Message implements DomainModel, Identity, ModificationDate
     #[ORM\JoinColumn(name: 'owner', referencedColumnName: 'id', nullable: true)]
     private ?Administrator $owner;
 
+    #[ORM\ManyToOne(targetEntity: Template::class)]
+    #[ORM\JoinColumn(name: 'template', referencedColumnName: 'id', nullable: true, onDelete: 'SET NULL')]
+    private ?Template $template = null;
+
     public function __construct(
         MessageFormat $format,
         MessageSchedule $schedule,
         MessageMetadata $metadata,
         MessageContent $content,
         MessageOptions $options,
-        ?Administrator $owner = null
+        ?Administrator $owner,
+        ?Template $template = null,
     ) {
         $this->format = $format;
         $this->schedule = $schedule;
@@ -64,6 +69,7 @@ public function __construct(
         $this->options = $options;
         $this->uuid = bin2hex(random_bytes(18));
         $this->owner = $owner;
+        $this->template = $template;
     }
 
     public function getFormat(): MessageFormat
@@ -100,4 +106,9 @@ public function getOwner(): ?Administrator
     {
         return $this->owner;
     }
+
+    public function getTemplate(): ?Template
+    {
+        return $this->template;
+    }
 }

Diff for: src/Domain/Model/Messaging/Message/MessageFormat.php

@@ -5,6 +5,7 @@
 namespace PhpList\Core\Domain\Model\Messaging\Message;
 
 use Doctrine\ORM\Mapping as ORM;
+use InvalidArgumentException;
 
 #[ORM\Embeddable]
 class MessageFormat
@@ -16,36 +17,43 @@ class MessageFormat
     private ?string $sendFormat = null;
 
     #[ORM\Column(name: 'astext', type: 'integer', options: ['default' => 0])]
-    private bool $asText;
+    private bool $asText = false;
 
     #[ORM\Column(name: 'ashtml', type: 'integer', options: ['default' => 0])]
-    private bool $asHtml;
+    private bool $asHtml = false;
 
     #[ORM\Column(name: 'aspdf', type: 'integer', options: ['default' => 0])]
-    private bool $asPdf;
+    private bool $asPdf = false;
 
     #[ORM\Column(name: 'astextandhtml', type: 'integer', options: ['default' => 0])]
-    private bool $asTextAndHtml;
+    private bool $asTextAndHtml = false;
 
     #[ORM\Column(name: 'astextandpdf', type: 'integer', options: ['default' => 0])]
-    private bool $asTextAndPdf;
+    private bool $asTextAndPdf = false;
+
+    public const FORMAT_TEXT = 'text';
+    public const FORMAT_HTML = 'html';
+    public const FORMAT_PDF = 'pdf';
 
     public function __construct(
         bool $htmlFormatted,
-        string $sendFormat = null,
-        bool $asText = false,
-        bool $asHtml = false,
-        bool $asPdf = false,
-        bool $asTextAndHtml = false,
-        bool $asTextAndPdf = false,
+        ?string $sendFormat,
+        array $formatOptions = []
     ) {
         $this->htmlFormatted = $htmlFormatted;
         $this->sendFormat = $sendFormat;
-        $this->asText = $asText;
-        $this->asHtml = $asHtml;
-        $this->asPdf = $asPdf;
-        $this->asTextAndHtml = $asTextAndHtml;
-        $this->asTextAndPdf = $asTextAndPdf;
+
+        foreach ($formatOptions as $option) {
+            match ($option) {
+                self::FORMAT_TEXT => $this->asText = true,
+                self::FORMAT_HTML => $this->asHtml = true,
+                self::FORMAT_PDF => $this->asPdf = true,
+                default => throw new InvalidArgumentException('Invalid format option: ' . $option)
+            };
+        }
+
+        $this->asTextAndHtml = $this->asText && $this->asHtml;
+        $this->asTextAndPdf = $this->asText && $this->asPdf;
     }
 
     public function isHtmlFormatted(): bool

Diff for: src/Domain/Model/Messaging/Message/MessageMetadata.php

@@ -13,11 +13,11 @@ class MessageMetadata
     #[ORM\Column(type: 'string', length: 255, nullable: true)]
     private ?string $status = null;
 
-    #[ORM\Column(type: 'integer', options: ['unsigned' => true, 'default' => 0])]
-    private int $processed;
+    #[ORM\Column(type: 'boolean', options: ['unsigned' => true, 'default' => false])]
+    private bool $processed;
 
-    #[ORM\Column(type: 'integer', options: ['default' => 0])]
-    private int $viewed;
+    #[ORM\Column(type: 'boolean', options: ['default' => false])]
+    private bool $viewed = false;
 
     #[ORM\Column(name: 'bouncecount', type: 'integer', options: ['default' => 0])]
     private int $bounceCount;
@@ -30,15 +30,13 @@ class MessageMetadata
 
     public function __construct(
         ?string $status = null,
-        int $processed = 0,
-        int $viewed = 0,
         int $bounceCount = 0,
         ?DateTime $entered = null,
         ?DateTime $sent = null,
     ) {
         $this->status = $status;
-        $this->processed = $processed;
-        $this->viewed = $viewed;
+        $this->processed = false;
+        $this->viewed = false;
         $this->bounceCount = $bounceCount;
         $this->entered = $entered ?? new DateTime();
         $this->sent = $sent;
@@ -49,18 +47,24 @@ public function getStatus(): ?string
         return $this->status;
     }
 
-    public function getProcessed(): int
+    public function isProcessed(): bool
     {
         return $this->processed;
     }
 
-    public function setProcessed(int $processed): self
+    public function setProcessed(bool $processed): self
     {
         $this->processed = $processed;
         return $this;
     }
 
-    public function getViewed(): int
+    public function setViewed(bool $viewed): self
+    {
+        $this->viewed = $viewed;
+        return $this;
+    }
+
+    public function isViewed(): bool
     {
         return $this->viewed;
     }

Diff for: src/Domain/Model/Messaging/Message/MessageOptions.php

@@ -25,9 +25,6 @@ class MessageOptions
     #[ORM\Column(name: 'userselection', type: 'text', nullable: true)]
     private ?string $userSelection;
 
-    #[ORM\Column(type: 'integer', nullable: true)]
-    private ?int $template;
-
     #[ORM\Column(name: 'sendstart', type: 'datetime', nullable: true)]
     private ?DateTime $sendStart;
 
@@ -40,7 +37,6 @@ public function __construct(
         string $replyTo = '',
         ?DateTime $embargo = null,
         ?string $userSelection = null,
-        ?int $template = null,
         ?DateTime $sendStart = null,
         ?string $rssTemplate = null
     ) {
@@ -49,7 +45,6 @@ public function __construct(
         $this->replyTo = $replyTo;
         $this->embargo = $embargo;
         $this->userSelection = $userSelection;
-        $this->template = $template;
         $this->sendStart = $sendStart;
         $this->rssTemplate = $rssTemplate;
     }
@@ -79,11 +74,6 @@ public function getUserSelection(): ?string
         return $this->userSelection;
     }
 
-    public function getTemplate(): ?int
-    {
-        return $this->template;
-    }
-
     public function getSendStart(): ?DateTime
     {
         return $this->sendStart;

Diff for: src/Domain/Model/Messaging/Template.php

@@ -22,10 +22,10 @@ class Template implements DomainModel, Identity
     private string $title;
 
     #[ORM\Column(name: 'template', type: 'blob', nullable: true)]
-    private ?string $template = null;
+    private mixed $template;
 
     #[ORM\Column(name: 'template_text', type: 'blob', nullable: true)]
-    private ?string $templateText = null;
+    private mixed $templateText;
 
     #[ORM\Column(name: 'listorder', type: 'integer', nullable: true)]
     private ?int $listOrder = null;
@@ -50,12 +50,12 @@ public function getTitle(): string
 
     public function getTemplate(): ?string
     {
-        return $this->template;
+        return is_resource($this->template) ? stream_get_contents($this->template) : $this->template;
     }
 
     public function getTemplateText(): ?string
     {
-        return $this->templateText;
+        return is_resource($this->templateText) ? stream_get_contents($this->templateText) : $this->templateText;
     }
 
     public function getListOrder(): ?int
@@ -76,13 +76,14 @@ public function setTitle(string $title): self
 
     public function setTemplate(?string $template): self
     {
-        $this->template = $template;
+        $this->template = $template !== null ? fopen('data://text/plain,' . $template, 'r') : null;
         return $this;
     }
 
+
     public function setTemplateText(?string $templateText): self
     {
-        $this->templateText = $templateText;
+        $this->templateText = $templateText !== null ? fopen('data://text/plain,' . $templateText, 'r') : null;
         return $this;
     }
 

Diff for: tests/Integration/Domain/Repository/Fixtures/MessageFixture.php

@@ -14,6 +14,7 @@
 use PhpList\Core\Domain\Model\Messaging\Message\MessageMetadata;
 use PhpList\Core\Domain\Model\Messaging\Message\MessageOptions;
 use PhpList\Core\Domain\Model\Messaging\Message\MessageSchedule;
+use PhpList\Core\Domain\Model\Messaging\Template;
 use PhpList\Core\TestingSupport\Traits\ModelTestTrait;
 use RuntimeException;
 
@@ -36,6 +37,7 @@ public function load(ObjectManager $manager): void
 
         $headers = fgetcsv($handle);
         $adminRepository = $manager->getRepository(Administrator::class);
+        $templateRepository = $manager->getRepository(Template::class);
 
         do {
             $data = fgetcsv($handle);
@@ -44,15 +46,16 @@ public function load(ObjectManager $manager): void
             }
             $row = array_combine($headers, $data);
             $admin = $adminRepository->find($row['owner']);
+            $template = $templateRepository->find($row['template']);
 
             $format = new MessageFormat(
                 $row['htmlformatted'],
                 $row['sendformat'],
-                (bool)$row['astext'],
-                (bool)$row['ashtml'],
-                (bool)$row['aspdf'],
-                (bool)$row['astextandhtml'],
-                (bool)$row['astextandpdf']
+                array_keys(array_filter([
+                    MessageFormat::FORMAT_TEXT => $row['astext'],
+                    MessageFormat::FORMAT_HTML => $row['ashtml'],
+                    MessageFormat::FORMAT_PDF => $row['aspdf'],
+                ]))
             );
 
             $schedule = new MessageSchedule(
@@ -63,12 +66,12 @@ public function load(ObjectManager $manager): void
             );
             $metadata = new MessageMetadata(
                 $row['status'],
-                $row['processed'],
-                $row['viewed'],
                 $row['bouncecount'],
                 $row['entered'],
                 $row['sent']
             );
+            $metadata->setProcessed((bool) $row['processed']);
+            $metadata->setViewed((bool)$row['viewed']);
             $content = new MessageContent(
                 $row['subject'],
                 $row['message'],
@@ -81,7 +84,6 @@ public function load(ObjectManager $manager): void
                 $row['replyto'],
                 $row['embargo'],
                 $row['userselection'],
-                $row['template'],
                 $row['sendstart'],
                 $row['rsstemplate'],
             );
@@ -93,6 +95,7 @@ public function load(ObjectManager $manager): void
                 $content,
                 $options,
                 $admin,
+                $template,
             );
             $this->setSubjectId($message, (int)$row['id']);
             $this->setSubjectProperty($message, 'uuid', $row['uuid']);

Diff for: tests/Integration/Domain/Repository/Messaging/MessageRepositoryTest.php

@@ -46,7 +46,7 @@ public function testMessageIsPersistedAndFetchedCorrectly(): void
         $this->entityManager->persist($admin);
 
         $message = new Message(
-            new MessageFormat(true),
+            new MessageFormat(true, 'text'),
             new MessageSchedule(1, null, 3, null),
             new MessageMetadata('done'),
             new MessageContent('Hello world!'),
@@ -75,7 +75,7 @@ public function testGetByOwnerIdReturnsOnlyOwnedMessages(): void
         $this->entityManager->persist($admin2);
 
         $msg1 = new Message(
-            new MessageFormat(true),
+            new MessageFormat(true, MessageFormat::FORMAT_TEXT),
             new MessageSchedule(1, null, 3, null),
             new MessageMetadata('done'),
             new MessageContent('Owned by Admin 1!'),
@@ -84,7 +84,7 @@ public function testGetByOwnerIdReturnsOnlyOwnedMessages(): void
         );
 
         $msg2 = new Message(
-            new MessageFormat(true),
+            new MessageFormat(true, MessageFormat::FORMAT_TEXT),
             new MessageSchedule(1, null, 3, null),
             new MessageMetadata(null),
             new MessageContent('Owned by Admin 2!'),
@@ -93,7 +93,7 @@ public function testGetByOwnerIdReturnsOnlyOwnedMessages(): void
         );
 
         $msg3 = new Message(
-            new MessageFormat(true),
+            new MessageFormat(true, MessageFormat::FORMAT_TEXT),
             new MessageSchedule(1, null, 3, null),
             new MessageMetadata(null),
             new MessageContent('Hello world!'),
@@ -118,7 +118,7 @@ public function testMessageTimestampsAreSetOnPersist(): void
         $expectedDate = new DateTime();
 
         $message = new Message(
-            new MessageFormat(true),
+            new MessageFormat(true, MessageFormat::FORMAT_TEXT),
             new MessageSchedule(1, null, 3, null),
             new MessageMetadata(null),
             new MessageContent('Hello world!'),

Diff for: tests/Unit/Domain/Model/Messaging/MessageTest.php

@@ -29,7 +29,7 @@ class MessageTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->format = new MessageFormat(true);
+        $this->format = new MessageFormat(true, MessageFormat::FORMAT_TEXT);
         $this->schedule = new MessageSchedule(1, new DateTime(), 2, new DateTime());
         $this->metadata = new MessageMetadata();
         $this->content = new MessageContent('This is the body');