[FEATURE] Interface for domain models (#274)

This interface removes the need to have the generic "object" type
for methods that use a domain model. It also will allow subscriptions
to get saved using the Repository.save method.

Author: oliverklee

CHANGELOG.md

@@ -7,6 +7,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ## x.y.z
 
 ### Added
+- Interface for domain models (#274)
 - Trait for database tests and abstract web test (#264)
 - Repository methods for querying subscriptions (#253)
 - Bidirectional m:n association Subscribers/SubscriberLists (#254)

src/Domain/Model/Identity/Administrator.php

@@ -8,6 +8,7 @@
 use Doctrine\ORM\Mapping\HasLifecycleCallbacks;
 use Doctrine\ORM\Mapping\Table;
 use PhpList\PhpList4\Domain\Model\Interfaces\CreationDate;
+use PhpList\PhpList4\Domain\Model\Interfaces\DomainModel;
 use PhpList\PhpList4\Domain\Model\Interfaces\Identity;
 use PhpList\PhpList4\Domain\Model\Interfaces\ModificationDate;
 use PhpList\PhpList4\Domain\Model\Traits\CreationDateTrait;
@@ -24,7 +25,7 @@
  *
  * @author Oliver Klee <[email protected]>
  */
-class Administrator implements Identity, CreationDate, ModificationDate
+class Administrator implements DomainModel, Identity, CreationDate, ModificationDate
 {
     use IdentityTrait;
     use CreationDateTrait;

src/Domain/Model/Identity/AdministratorToken.php

@@ -13,6 +13,7 @@
 use JMS\Serializer\Annotation\ExclusionPolicy;
 use JMS\Serializer\Annotation\Expose;
 use PhpList\PhpList4\Domain\Model\Interfaces\CreationDate;
+use PhpList\PhpList4\Domain\Model\Interfaces\DomainModel;
 use PhpList\PhpList4\Domain\Model\Interfaces\Identity;
 use PhpList\PhpList4\Domain\Model\Traits\IdentityTrait;
 
@@ -25,7 +26,7 @@
  *
  * @author Oliver Klee <[email protected]>
  */
-class AdministratorToken implements Identity, CreationDate
+class AdministratorToken implements DomainModel, Identity, CreationDate
 {
     use IdentityTrait;
 

src/Domain/Model/Interfaces/DomainModel.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace PhpList\PhpList4\Domain\Model\Interfaces;
+
+/**
+ * This is the interface all domain models (entities) should implement.
+ *
+ * This allows methods that work with domain models to have a narrow type hinting
+ * instead of the generic "object".
+ *
+ * @author Oliver Klee <[email protected]>
+ */
+interface DomainModel
+{
+}

src/Domain/Model/Messaging/SubscriberList.php

@@ -19,6 +19,7 @@
 use JMS\Serializer\Annotation\Expose;
 use PhpList\PhpList4\Domain\Model\Identity\Administrator;
 use PhpList\PhpList4\Domain\Model\Interfaces\CreationDate;
+use PhpList\PhpList4\Domain\Model\Interfaces\DomainModel;
 use PhpList\PhpList4\Domain\Model\Interfaces\Identity;
 use PhpList\PhpList4\Domain\Model\Interfaces\ModificationDate;
 use PhpList\PhpList4\Domain\Model\Traits\CreationDateTrait;
@@ -36,7 +37,7 @@
  *
  * @author Oliver Klee <[email protected]>
  */
-class SubscriberList implements Identity, CreationDate, ModificationDate
+class SubscriberList implements DomainModel, Identity, CreationDate, ModificationDate
 {
     use IdentityTrait;
     use CreationDateTrait;

src/Domain/Model/Subscription/Subscriber.php

@@ -17,6 +17,7 @@
 use JMS\Serializer\Annotation\ExclusionPolicy;
 use JMS\Serializer\Annotation\Expose;
 use PhpList\PhpList4\Domain\Model\Interfaces\CreationDate;
+use PhpList\PhpList4\Domain\Model\Interfaces\DomainModel;
 use PhpList\PhpList4\Domain\Model\Interfaces\Identity;
 use PhpList\PhpList4\Domain\Model\Interfaces\ModificationDate;
 use PhpList\PhpList4\Domain\Model\Traits\CreationDateTrait;
@@ -34,7 +35,7 @@
  *
  * @author Oliver Klee <[email protected]>
  */
-class Subscriber implements Identity, CreationDate, ModificationDate
+class Subscriber implements DomainModel, Identity, CreationDate, ModificationDate
 {
     use IdentityTrait;
     use CreationDateTrait;

src/Domain/Model/Subscription/Subscription.php

@@ -14,6 +14,7 @@
 use JMS\Serializer\Annotation\ExclusionPolicy;
 use JMS\Serializer\Annotation\Expose;
 use PhpList\PhpList4\Domain\Model\Interfaces\CreationDate;
+use PhpList\PhpList4\Domain\Model\Interfaces\DomainModel;
 use PhpList\PhpList4\Domain\Model\Interfaces\ModificationDate;
 use PhpList\PhpList4\Domain\Model\Messaging\SubscriberList;
 use PhpList\PhpList4\Domain\Model\Traits\CreationDateTrait;
@@ -30,7 +31,7 @@
  *
  * @author Oliver Klee <[email protected]>
  */
-class Subscription implements CreationDate, ModificationDate
+class Subscription implements DomainModel, CreationDate, ModificationDate
 {
     use CreationDateTrait;
     use ModificationDateTrait;

src/Domain/Repository/AbstractRepository.php

@@ -4,7 +4,7 @@
 namespace PhpList\PhpList4\Domain\Repository;
 
 use Doctrine\ORM\EntityRepository;
-use PhpList\PhpList4\Domain\Model\Interfaces\Identity;
+use PhpList\PhpList4\Domain\Model\Interfaces\DomainModel;
 
 /**
  * Base class for repositories.
@@ -14,16 +14,16 @@
 abstract class AbstractRepository extends EntityRepository
 {
     /**
-     * Persists and $model and flushes the entity manager change list.
+     * Persists $model and flushes the entity manager change list.
      *
      * This method allows controllers to not depend on the entity manager, but only on the repositories instead,
      * following the Law of Demeter.
      *
-     * @param Identity $model
+     * @param DomainModel $model
      *
      * @return void
      */
-    public function save(Identity $model)
+    public function save(DomainModel $model)
     {
         $this->getEntityManager()->persist($model);
         $this->getEntityManager()->flush();

tests/Unit/Domain/Model/Identity/AdministratorTest.php

@@ -4,6 +4,7 @@
 namespace PhpList\PhpList4\Tests\Unit\Domain\Model\Identity;
 
 use PhpList\PhpList4\Domain\Model\Identity\Administrator;
+use PhpList\PhpList4\Domain\Model\Interfaces\DomainModel;
 use PhpList\PhpList4\TestingSupport\Traits\ModelTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
 use PHPUnit\Framework\TestCase;
@@ -28,6 +29,14 @@ protected function setUp()
         $this->subject = new Administrator();
     }
 
+    /**
+     * @test
+     */
+    public function isDomainModel()
+    {
+        static::assertInstanceOf(DomainModel::class, $this->subject);
+    }
+
     /**
      * @test
      */

tests/Unit/Domain/Model/Identity/AdministratorTokenTest.php

@@ -5,6 +5,7 @@
 
 use PhpList\PhpList4\Domain\Model\Identity\Administrator;
 use PhpList\PhpList4\Domain\Model\Identity\AdministratorToken;
+use PhpList\PhpList4\Domain\Model\Interfaces\DomainModel;
 use PhpList\PhpList4\TestingSupport\Traits\ModelTestTrait;
 use PhpList\PhpList4\TestingSupport\Traits\SimilarDatesAssertionTrait;
 use PHPUnit\Framework\TestCase;
@@ -29,6 +30,14 @@ protected function setUp()
         $this->subject = new AdministratorToken();
     }
 
+    /**
+     * @test
+     */
+    public function isDomainModel()
+    {
+        static::assertInstanceOf(DomainModel::class, $this->subject);
+    }
+
     /**
      * @test
      */