ISSUE-345: adjust entities and repos to rest-api use cases

* ISSUE-345: add relation to subscriber attributes

* ISSUE-345: return self after set

* ISSUE-345: fix traits

* ISSUE-345: add method in SubscriptionRepository

* ISSUE-345: message repository

* ISSUE-345: message fixture

* ISSUE-345: message fixture + test

* ISSUE-345: column name fix

* ISSUE-345: remove prefix

* ISSUE-345: make format props bool

* ISSUE-345: relation to template in message

* ISSUE-345: update runner

* ISSUE-345: template repo

* ISSUE-345: move to dirs

* ISSUE-345: add test + fix template

* ISSUE-345: message setters

* ISSUE-345: tests

* ISSUE-345: set message embedded elements

* ISSUE-345: sendstart in metadata

* ISSUE-345: EmbeddableInterface interface

* ISSUE-345: image data resource fix

* ISSUE-345: update template property names

* ISSUE-345: TemplateImageRepository

* ISSUE-345: update admin prop name (email)

* ISSUE-345: createdAt/updatedAt

* ISSUE-345: add missing repos + cursor trait

* ISSUE-345: modifiedBy getter/setter

* ISSUE-345: PaginatableRepositoryInterface

* ISSUE-345: filter

* ISSUE-345: subscriber filter + refactor

---------

Co-authored-by: Tatevik <[email protected]>

Author: TatevikGr

.github/workflows/ci.yml

@@ -3,7 +3,7 @@ on: [push, pull_request]
 jobs:
   main:
     name: phpList on PHP ${{ matrix.php-versions }} [Build, Test]
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     env:
       DB_DATABASE: phplist
       DB_USERNAME: root

.github/workflows/core-docs.yml

@@ -3,7 +3,7 @@ on: [push, pull_request]
 jobs:
   make-restapi-docs:
     name: Checkout phpList core and generate docs using `phpDocumentor`
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -41,7 +41,7 @@ jobs:
           path: phpdocumentor.zip
   deploy-docs:
     name: Deploy Core Docs
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     needs: make-restapi-docs
     steps:
       - name: Checkout phplist/core-docs

config/repositories.yml

@@ -11,10 +11,10 @@ services:
         arguments:
             - PhpList\Core\Domain\Model\Identity\AdministratorToken
 
-    PhpList\Core\Domain\Repository\Messaging\SubscriberListRepository:
+    PhpList\Core\Domain\Repository\Subscription\SubscriberListRepository:
         parent: PhpList\Core\Domain\Repository
         arguments:
-            - PhpList\Core\Domain\Model\Messaging\SubscriberList
+            - PhpList\Core\Domain\Model\Subscription\SubscriberList
 
     PhpList\Core\Domain\Repository\Subscription\SubscriberRepository:
         parent: PhpList\Core\Domain\Repository
@@ -25,3 +25,18 @@ services:
         parent: PhpList\Core\Domain\Repository
         arguments:
             - PhpList\Core\Domain\Model\Subscription\Subscription
+
+    PhpList\Core\Domain\Repository\Messaging\MessageRepository:
+        parent: PhpList\Core\Domain\Repository
+        arguments:
+            - PhpList\Core\Domain\Model\Messaging\Message
+
+    PhpList\Core\Domain\Repository\Messaging\TemplateRepository:
+        parent: PhpList\Core\Domain\Repository
+        arguments:
+            - PhpList\Core\Domain\Model\Messaging\Template
+
+    PhpList\Core\Domain\Repository\Messaging\TemplateImageRepository:
+        parent: PhpList\Core\Domain\Repository
+        arguments:
+            - PhpList\Core\Domain\Model\Messaging\TemplateImage

src/Domain/Filter/FilterRequestInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Filter;
+
+interface FilterRequestInterface
+{
+
+}

src/Domain/Filter/MessageFilter.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Filter;
+
+use PhpList\Core\Domain\Model\Identity\Administrator;
+
+class MessageFilter implements FilterRequestInterface
+{
+    private ?Administrator $owner = null;
+
+    public function getOwner(): ?Administrator
+    {
+        return $this->owner;
+    }
+
+    public function setOwner(?Administrator $admin): self
+    {
+        $this->owner = $admin;
+        return $this;
+    }
+}

src/Domain/Filter/SubscriberFilter.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Filter;
+
+class SubscriberFilter implements FilterRequestInterface
+{
+    private ?int $listId = null;
+
+    public function setListId(?int $listId): self
+    {
+        $this->listId = $listId;
+        return $this;
+    }
+
+    public function getListId(): ?int
+    {
+        return $this->listId;
+    }
+}

src/Domain/Model/Analytics/LinkTrackForward.php

@@ -7,7 +7,6 @@
 use Doctrine\ORM\Mapping as ORM;
 use PhpList\Core\Domain\Model\Interfaces\DomainModel;
 use PhpList\Core\Domain\Model\Interfaces\Identity;
-use PhpList\Core\Domain\Model\Traits\IdentityTrait;
 use PhpList\Core\Domain\Repository\Analytics\LinkTrackForwardRepository;
 
 #[ORM\Entity(repositoryClass: LinkTrackForwardRepository::class)]
@@ -17,7 +16,10 @@
 #[ORM\Index(name: 'uuididx', columns: ['uuid'])]
 class LinkTrackForward implements DomainModel, Identity
 {
-    use IdentityTrait;
+    #[ORM\Id]
+    #[ORM\Column(type: 'integer')]
+    #[ORM\GeneratedValue]
+    private ?int $id = null;
 
     #[ORM\Column(type: 'string', length: 2083, nullable: true)]
     private ?string $url = null;
@@ -31,6 +33,11 @@ class LinkTrackForward implements DomainModel, Identity
     #[ORM\Column(type: 'boolean', nullable: true, options: ['default' => 0])]
     private bool $personalise = false;
 
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
     public function getUrl(): ?string
     {
         return $this->url;

src/Domain/Model/Analytics/LinkTrackUmlClick.php

@@ -8,7 +8,6 @@
 use Doctrine\ORM\Mapping as ORM;
 use PhpList\Core\Domain\Model\Interfaces\DomainModel;
 use PhpList\Core\Domain\Model\Interfaces\Identity;
-use PhpList\Core\Domain\Model\Traits\IdentityTrait;
 use PhpList\Core\Domain\Repository\Analytics\LinkTrackUmlClickRepository;
 
 #[ORM\Entity(repositoryClass: LinkTrackUmlClickRepository::class)]
@@ -19,7 +18,10 @@
 #[ORM\Index(name: 'uidindex', columns: ['userid'])]
 class LinkTrackUmlClick implements DomainModel, Identity
 {
-    use IdentityTrait;
+    #[ORM\Id]
+    #[ORM\Column(type: 'integer')]
+    #[ORM\GeneratedValue]
+    private ?int $id = null;
 
     #[ORM\Column(name: 'messageid', type: 'integer')]
     private int $messageId;
@@ -45,6 +47,11 @@ class LinkTrackUmlClick implements DomainModel, Identity
     #[ORM\Column(name: 'textclicked', type: 'integer', nullable: true, options: ['default' => 0])]
     private ?int $textClicked = 0;
 
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
     public function getMessageId(): int
     {
         return $this->messageId;

src/Domain/Model/Analytics/UserMessageView.php

@@ -8,16 +8,19 @@
 use Doctrine\ORM\Mapping as ORM;
 use PhpList\Core\Domain\Model\Interfaces\DomainModel;
 use PhpList\Core\Domain\Model\Interfaces\Identity;
-use PhpList\Core\Domain\Model\Traits\IdentityTrait;
+use PhpList\Core\Domain\Repository\Analytics\UserMessageViewRepository;
 
-#[ORM\Entity]
+#[ORM\Entity(repositoryClass: UserMessageViewRepository::class)]
 #[ORM\Table(name: 'phplist_user_message_view')]
 #[ORM\Index(name: 'msgidx', columns: ['messageid'])]
 #[ORM\Index(name: 'useridx', columns: ['userid'])]
 #[ORM\Index(name: 'usermsgidx', columns: ['userid', 'messageid'])]
 class UserMessageView implements DomainModel, Identity
 {
-    use IdentityTrait;
+    #[ORM\Id]
+    #[ORM\Column(type: 'integer')]
+    #[ORM\GeneratedValue]
+    private ?int $id = null;
 
     #[ORM\Column(name: 'messageid', type: 'integer')]
     private int $messageId;
@@ -34,6 +37,11 @@ class UserMessageView implements DomainModel, Identity
     #[ORM\Column(name: 'data', type: 'text', nullable: true)]
     private ?string $data = null;
 
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
     public function getMessageId(): int
     {
         return $this->messageId;

src/Domain/Model/Analytics/UserStats.php

@@ -7,9 +7,9 @@
 use Doctrine\ORM\Mapping as ORM;
 use PhpList\Core\Domain\Model\Interfaces\DomainModel;
 use PhpList\Core\Domain\Model\Interfaces\Identity;
-use PhpList\Core\Domain\Model\Traits\IdentityTrait;
+use PhpList\Core\Domain\Repository\Analytics\UserStatsRepository;
 
-#[ORM\Entity]
+#[ORM\Entity(repositoryClass: UserStatsRepository::class)]
 #[ORM\Table(name: 'phplist_userstats')]
 #[ORM\UniqueConstraint(name: 'entry', columns: ['unixdate', 'item', 'listid'])]
 #[ORM\Index(name: 'dateindex', columns: ['unixdate'])]
@@ -18,7 +18,10 @@
 #[ORM\Index(name: 'listindex', columns: ['listid'])]
 class UserStats implements DomainModel, Identity
 {
-    use IdentityTrait;
+    #[ORM\Id]
+    #[ORM\Column(type: 'integer')]
+    #[ORM\GeneratedValue]
+    private ?int $id = null;
 
     #[ORM\Column(name: 'unixdate', type: 'integer', nullable: true)]
     private ?int $unixDate = null;
@@ -32,6 +35,11 @@ class UserStats implements DomainModel, Identity
     #[ORM\Column(name: 'value', type: 'integer', options: ['default' => 0])]
     private int $value = 0;
 
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
     public function getUnixDate(): ?int
     {
         return $this->unixDate;