From 26dc0e6ce4bb839557b88161da03e1fc45aa903d Mon Sep 17 00:00:00 2001 From: Oliver Klee Date: Wed, 28 Feb 2018 12:53:15 +0100 Subject: [PATCH] [CLEANUP] Reduce the number of Doctrine-related imports --- src/Domain/Model/Identity/Administrator.php | 10 +++--- .../Model/Identity/AdministratorToken.php | 16 ++++------ .../Model/Interfaces/ModificationDate.php | 7 ++-- src/Domain/Model/Messaging/SubscriberList.php | 32 ++++++++----------- src/Domain/Model/Subscription/Subscriber.php | 27 ++++++---------- .../Model/Subscription/Subscription.php | 31 +++++++++--------- src/Domain/Model/Traits/IdentityTrait.php | 10 +++--- .../Model/Traits/ModificationDateTrait.php | 7 ++-- 8 files changed, 60 insertions(+), 80 deletions(-) diff --git a/src/Domain/Model/Identity/Administrator.php b/src/Domain/Model/Identity/Administrator.php index f1de55bc..2433155e 100644 --- a/src/Domain/Model/Identity/Administrator.php +++ b/src/Domain/Model/Identity/Administrator.php @@ -3,10 +3,8 @@ namespace PhpList\PhpList4\Domain\Model\Identity; +use Doctrine\ORM\Mapping; use Doctrine\ORM\Mapping\Column; -use Doctrine\ORM\Mapping\Entity; -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; @@ -19,9 +17,9 @@ * This class represents an administrator who can log to the system, is allowed to administer * selected lists (as the owner), send campaigns to these lists and edit subscribers. * - * @Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Identity\AdministratorRepository") - * @Table(name="phplist_admin") - * @HasLifecycleCallbacks + * @Mapping\Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Identity\AdministratorRepository") + * @Mapping\Table(name="phplist_admin") + * @Mapping\HasLifecycleCallbacks * * @author Oliver Klee */ diff --git a/src/Domain/Model/Identity/AdministratorToken.php b/src/Domain/Model/Identity/AdministratorToken.php index 5c7a3965..9b2cdab3 100644 --- a/src/Domain/Model/Identity/AdministratorToken.php +++ b/src/Domain/Model/Identity/AdministratorToken.php @@ -3,12 +3,8 @@ namespace PhpList\PhpList4\Domain\Model\Identity; +use Doctrine\ORM\Mapping; use Doctrine\ORM\Mapping\Column; -use Doctrine\ORM\Mapping\Entity; -use Doctrine\ORM\Mapping\JoinColumn; -use Doctrine\ORM\Mapping\ManyToOne; -use Doctrine\ORM\Mapping\PrePersist; -use Doctrine\ORM\Mapping\Table; use Doctrine\ORM\Proxy\Proxy; use JMS\Serializer\Annotation\ExclusionPolicy; use JMS\Serializer\Annotation\Expose; @@ -20,8 +16,8 @@ /** * This class represents an API authentication token for an administrator. * - * @Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Identity\AdministratorTokenRepository") - * @Table(name="phplist_admintoken") + * @Mapping\Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Identity\AdministratorTokenRepository") + * @Mapping\Table(name="phplist_admintoken") * @ExclusionPolicy("all") * * @author Oliver Klee @@ -57,8 +53,8 @@ class AdministratorToken implements DomainModel, Identity, CreationDate /** * @var Administrator|Proxy - * @ManyToOne(targetEntity="PhpList\PhpList4\Domain\Model\Identity\Administrator") - * @JoinColumn(name="adminid") + * @Mapping\ManyToOne(targetEntity="PhpList\PhpList4\Domain\Model\Identity\Administrator") + * @Mapping\JoinColumn(name="adminid") */ private $administrator = null; @@ -98,7 +94,7 @@ private function setCreationDate(\DateTime $creationDate) /** * Updates the creation date to now. * - * @PrePersist + * @Mapping\PrePersist * * @return void */ diff --git a/src/Domain/Model/Interfaces/ModificationDate.php b/src/Domain/Model/Interfaces/ModificationDate.php index 5407f96b..c09bb24a 100644 --- a/src/Domain/Model/Interfaces/ModificationDate.php +++ b/src/Domain/Model/Interfaces/ModificationDate.php @@ -3,8 +3,7 @@ namespace PhpList\PhpList4\Domain\Model\Interfaces; -use Doctrine\ORM\Mapping\PrePersist; -use Doctrine\ORM\Mapping\PreUpdate; +use Doctrine\ORM\Mapping; /** * This interface communicates that a domain model has a modification date. @@ -23,8 +22,8 @@ public function getModificationDate(); /** * Updates the modification date to now. * - * @PrePersist - * @PreUpdate + * @Mapping\PrePersist + * @Mapping\PreUpdate * * @return void */ diff --git a/src/Domain/Model/Messaging/SubscriberList.php b/src/Domain/Model/Messaging/SubscriberList.php index 4c3989ce..b58ddbee 100644 --- a/src/Domain/Model/Messaging/SubscriberList.php +++ b/src/Domain/Model/Messaging/SubscriberList.php @@ -5,15 +5,8 @@ use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Collections\Collection; +use Doctrine\ORM\Mapping; use Doctrine\ORM\Mapping\Column; -use Doctrine\ORM\Mapping\Entity; -use Doctrine\ORM\Mapping\HasLifecycleCallbacks; -use Doctrine\ORM\Mapping\JoinColumn; -use Doctrine\ORM\Mapping\JoinTable; -use Doctrine\ORM\Mapping\ManyToMany; -use Doctrine\ORM\Mapping\ManyToOne; -use Doctrine\ORM\Mapping\OneToMany; -use Doctrine\ORM\Mapping\Table; use Doctrine\ORM\Proxy\Proxy; use JMS\Serializer\Annotation\ExclusionPolicy; use JMS\Serializer\Annotation\Expose; @@ -30,9 +23,9 @@ * This class represents an administrator who can log to the system, is allowed to administer * selected lists (as the owner), send campaigns to these lists and edit subscribers. * - * @Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Messaging\SubscriberListRepository") - * @Table(name="phplist_list") - * @HasLifecycleCallbacks + * @Mapping\Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Messaging\SubscriberListRepository") + * @Mapping\Table(name="phplist_list") + * @Mapping\HasLifecycleCallbacks * @ExclusionPolicy("all") * * @author Oliver Klee @@ -100,14 +93,14 @@ class SubscriberList implements DomainModel, Identity, CreationDate, Modificatio /** * @var Administrator - * @ManyToOne(targetEntity="PhpList\PhpList4\Domain\Model\Identity\Administrator") - * @JoinColumn(name="owner") + * @Mapping\ManyToOne(targetEntity="PhpList\PhpList4\Domain\Model\Identity\Administrator") + * @Mapping\JoinColumn(name="owner") */ private $owner = null; /** * @var Collection - * @OneToMany( + * @Mapping\OneToMany( * targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscription", * mappedBy="subscriberList", * cascade={"remove"} @@ -117,10 +110,13 @@ class SubscriberList implements DomainModel, Identity, CreationDate, Modificatio /** * @var Collection - * @ManyToMany(targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscriber", inversedBy="subscribedLists") - * @JoinTable(name="phplist_listuser", - * joinColumns={@JoinColumn(name="listid")}, - * inverseJoinColumns={@JoinColumn(name="userid")} + * @Mapping\ManyToMany( + * targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscriber", + * inversedBy="subscribedLists" + * ) + * @Mapping\JoinTable(name="phplist_listuser", + * joinColumns={@Mapping\JoinColumn(name="listid")}, + * inverseJoinColumns={@Mapping\JoinColumn(name="userid")} * ) */ private $subscribers = null; diff --git a/src/Domain/Model/Subscription/Subscriber.php b/src/Domain/Model/Subscription/Subscriber.php index 12b99567..ea7974b9 100644 --- a/src/Domain/Model/Subscription/Subscriber.php +++ b/src/Domain/Model/Subscription/Subscriber.php @@ -5,15 +5,8 @@ use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Collections\Collection; +use Doctrine\ORM\Mapping; use Doctrine\ORM\Mapping\Column; -use Doctrine\ORM\Mapping\Entity; -use Doctrine\ORM\Mapping\HasLifecycleCallbacks; -use Doctrine\ORM\Mapping\JoinColumn; -use Doctrine\ORM\Mapping\JoinTable; -use Doctrine\ORM\Mapping\ManyToMany; -use Doctrine\ORM\Mapping\OneToMany; -use Doctrine\ORM\Mapping\PrePersist; -use Doctrine\ORM\Mapping\Table; use JMS\Serializer\Annotation\ExclusionPolicy; use JMS\Serializer\Annotation\Expose; use PhpList\PhpList4\Domain\Model\Interfaces\CreationDate; @@ -28,9 +21,9 @@ * This class represents asubscriber who can subscribe to multiple subscriber lists and can receive email messages from * campaigns for those subscriber lists. * - * @Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Subscription\SubscriberRepository") - * @Table(name="phplist_user_user") - * @HasLifecycleCallbacks + * @Mapping\Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Subscription\SubscriberRepository") + * @Mapping\Table(name="phplist_user_user") + * @Mapping\HasLifecycleCallbacks * @ExclusionPolicy("all") * * @author Oliver Klee @@ -108,7 +101,7 @@ class Subscriber implements DomainModel, Identity, CreationDate, ModificationDat /** * @var Collection - * @OneToMany( + * @Mapping\OneToMany( * targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscription", * mappedBy="subscriber", * cascade={"remove"} @@ -118,10 +111,10 @@ class Subscriber implements DomainModel, Identity, CreationDate, ModificationDat /** * @var Collection - * @ManyToMany(targetEntity="PhpList\PhpList4\Domain\Model\Messaging\SubscriberList", inversedBy="subscribers") - * @JoinTable(name="phplist_listuser", - * joinColumns={@JoinColumn(name="userid")}, - * inverseJoinColumns={@JoinColumn(name="listid")} + * @Mapping\ManyToMany(targetEntity="PhpList\PhpList4\Domain\Model\Messaging\SubscriberList", inversedBy="subscribers") + * @Mapping\JoinTable(name="phplist_listuser", + * joinColumns={@Mapping\JoinColumn(name="userid")}, + * inverseJoinColumns={@Mapping\JoinColumn(name="listid")} * ) */ private $subscribedLists = null; @@ -220,7 +213,7 @@ public function setUniqueId(string $uniqueId) /** * Generates and sets a (new) random unique ID. * - * @PrePersist + * @Mapping\PrePersist * * @return void */ diff --git a/src/Domain/Model/Subscription/Subscription.php b/src/Domain/Model/Subscription/Subscription.php index 222fe9b5..59290dfd 100644 --- a/src/Domain/Model/Subscription/Subscription.php +++ b/src/Domain/Model/Subscription/Subscription.php @@ -3,13 +3,8 @@ namespace PhpList\PhpList4\Domain\Model\Subscription; +use Doctrine\ORM\Mapping; use Doctrine\ORM\Mapping\Column; -use Doctrine\ORM\Mapping\Entity; -use Doctrine\ORM\Mapping\HasLifecycleCallbacks; -use Doctrine\ORM\Mapping\Id; -use Doctrine\ORM\Mapping\JoinColumn; -use Doctrine\ORM\Mapping\ManyToOne; -use Doctrine\ORM\Mapping\Table; use Doctrine\ORM\Proxy\Proxy; use JMS\Serializer\Annotation\ExclusionPolicy; use JMS\Serializer\Annotation\Expose; @@ -24,9 +19,9 @@ * This class represents asubscriber who can subscribe to multiple subscriber lists and can receive email messages from * campaigns for those subscriber lists. * - * @Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Subscription\SubscriptionRepository") - * @Table(name="phplist_listuser") - * @HasLifecycleCallbacks + * @Mapping\Entity(repositoryClass="PhpList\PhpList4\Domain\Repository\Subscription\SubscriptionRepository") + * @Mapping\Table(name="phplist_listuser") + * @Mapping\HasLifecycleCallbacks * @ExclusionPolicy("all") * * @author Oliver Klee @@ -51,17 +46,23 @@ class Subscription implements DomainModel, CreationDate, ModificationDate /** * @var Subscriber|Proxy|null - * @Id - * @ManyToOne(targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscriber", inversedBy="subscriptions") - * @JoinColumn(name="userid") + * @Mapping\Id + * @Mapping\ManyToOne( + * targetEntity="PhpList\PhpList4\Domain\Model\Subscription\Subscriber", + * inversedBy="subscriptions" + * ) + * @Mapping\JoinColumn(name="userid") */ private $subscriber = null; /** * @var SubscriberList|Proxy|null - * @Id - * @ManyToOne(targetEntity="PhpList\PhpList4\Domain\Model\Messaging\SubscriberList", inversedBy="subscriptions") - * @JoinColumn(name="listid") + * @Mapping\Id + * @Mapping\ManyToOne( + * targetEntity="PhpList\PhpList4\Domain\Model\Messaging\SubscriberList", + * inversedBy="subscriptions" + * ) + * @Mapping\JoinColumn(name="listid") */ private $subscriberList = null; diff --git a/src/Domain/Model/Traits/IdentityTrait.php b/src/Domain/Model/Traits/IdentityTrait.php index c3c14d49..8b2204cf 100644 --- a/src/Domain/Model/Traits/IdentityTrait.php +++ b/src/Domain/Model/Traits/IdentityTrait.php @@ -3,9 +3,7 @@ namespace PhpList\PhpList4\Domain\Model\Traits; -use Doctrine\ORM\Mapping\Column; -use Doctrine\ORM\Mapping\GeneratedValue; -use Doctrine\ORM\Mapping\Id; +use Doctrine\ORM\Mapping; use JMS\Serializer\Annotation\Expose; /** @@ -19,9 +17,9 @@ trait IdentityTrait { /** * @var int - * @Id - * @Column(type="integer") - * @GeneratedValue + * @Mapping\Id + * @Mapping\Column(type="integer") + * @Mapping\GeneratedValue * @Expose */ private $id = 0; diff --git a/src/Domain/Model/Traits/ModificationDateTrait.php b/src/Domain/Model/Traits/ModificationDateTrait.php index 012702d3..a6698a33 100644 --- a/src/Domain/Model/Traits/ModificationDateTrait.php +++ b/src/Domain/Model/Traits/ModificationDateTrait.php @@ -3,8 +3,7 @@ namespace PhpList\PhpList4\Domain\Model\Traits; -use Doctrine\ORM\Mapping\PrePersist; -use Doctrine\ORM\Mapping\PreUpdate; +use Doctrine\ORM\Mapping; /** * This trait provides an automatic modification date for models. @@ -39,8 +38,8 @@ private function setModificationDate(\DateTime $modificationDate) /** * Updates the modification date to now. * - * @PrePersist - * @PreUpdate + * @Mapping\PrePersist + * @Mapping\PreUpdate * * @return void */