From 27192ef2ffe9faa600bb38334d0e24e2f2e12d9d Mon Sep 17 00:00:00 2001
From: Mathieu Ducrot <mathieu.ducrot@smartbooster.io>
Date: Mon, 25 Mar 2024 16:40:45 +0100
Subject: [PATCH] Add common entity trait/interface

---
 src/Entity/AddressInterface.php        | 14 +++++
 src/Entity/AddressTrait.php            | 76 ++++++++++++++++++++++++++
 src/Entity/EmailInterface.php          | 10 ++++
 src/Entity/EmailTrait.php              | 30 ++++++++++
 src/Entity/NameableInterface.php       | 10 ++++
 src/Entity/NameableTrait.php           | 26 +++++++++
 src/Entity/OrganizationInterface.php   | 12 ++++
 src/Entity/OrganizationTrait.php       | 42 ++++++++++++++
 src/Entity/PersonNameableInterface.php | 18 ++++++
 src/Entity/PersonNameableTrait.php     | 60 ++++++++++++++++++++
 src/Entity/PhoneInterface.php          | 10 ++++
 src/Entity/PhoneTrait.php              | 27 +++++++++
 src/Entity/SirenInterface.php          | 10 ++++
 src/Entity/SirenTrait.php              | 27 +++++++++
 src/Entity/WebsiteInterface.php        | 10 ++++
 src/Entity/WebsiteTrait.php            | 26 +++++++++
 16 files changed, 408 insertions(+)
 create mode 100644 src/Entity/AddressInterface.php
 create mode 100644 src/Entity/AddressTrait.php
 create mode 100644 src/Entity/EmailInterface.php
 create mode 100644 src/Entity/EmailTrait.php
 create mode 100644 src/Entity/NameableInterface.php
 create mode 100644 src/Entity/NameableTrait.php
 create mode 100644 src/Entity/OrganizationInterface.php
 create mode 100644 src/Entity/OrganizationTrait.php
 create mode 100644 src/Entity/PersonNameableInterface.php
 create mode 100644 src/Entity/PersonNameableTrait.php
 create mode 100644 src/Entity/PhoneInterface.php
 create mode 100644 src/Entity/PhoneTrait.php
 create mode 100644 src/Entity/SirenInterface.php
 create mode 100644 src/Entity/SirenTrait.php
 create mode 100644 src/Entity/WebsiteInterface.php
 create mode 100644 src/Entity/WebsiteTrait.php

diff --git a/src/Entity/AddressInterface.php b/src/Entity/AddressInterface.php
new file mode 100644
index 0000000..9434c95
--- /dev/null
+++ b/src/Entity/AddressInterface.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+interface AddressInterface
+{
+    public function getAddress(): ?string;
+
+    public function getAdditionalAddress(): ?string;
+
+    public function getPostalCode(): ?string;
+
+    public function getCity(): ?string;
+}
diff --git a/src/Entity/AddressTrait.php b/src/Entity/AddressTrait.php
new file mode 100644
index 0000000..b7beebe
--- /dev/null
+++ b/src/Entity/AddressTrait.php
@@ -0,0 +1,76 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+
+trait AddressTrait
+{
+    #[ORM\Column(length: 255, nullable: true)]
+    #[Assert\Length(max: 255)]
+    private ?string $address = null;
+
+    #[ORM\Column(length: 255, nullable: true)]
+    #[Assert\Length(max: 255)]
+    private ?string $additionalAddress = null;
+
+    #[ORM\Column(length: 10, nullable: true)]
+    #[Assert\Length(max: 10)]
+    private ?string $postalCode = null;
+
+    #[ORM\Column(length: 255, nullable: true)]
+    #[Assert\Length(max: 255)]
+    private ?string $city = null;
+
+    public function getAddress(): ?string
+    {
+        return $this->address;
+    }
+
+    public function setAddress(?string $address): self
+    {
+        $this->address = $address;
+
+        return $this;
+    }
+
+    public function getAdditionalAddress(): ?string
+    {
+        return $this->additionalAddress;
+    }
+
+    public function setAdditionalAddress(?string $additionalAddress): self
+    {
+        $this->additionalAddress = $additionalAddress;
+
+        return $this;
+    }
+
+    public function getPostalCode(): ?string
+    {
+        return $this->postalCode;
+    }
+
+    public function setPostalCode(?string $postalCode): self
+    {
+        if (strlen($postalCode) === 4) {
+            $postalCode = '0' . $postalCode;
+        }
+        $this->postalCode = $postalCode;
+
+        return $this;
+    }
+
+    public function getCity(): ?string
+    {
+        return $this->city;
+    }
+
+    public function setCity(?string $city): self
+    {
+        $this->city = $city;
+
+        return $this;
+    }
+}
diff --git a/src/Entity/EmailInterface.php b/src/Entity/EmailInterface.php
new file mode 100644
index 0000000..4fda2c6
--- /dev/null
+++ b/src/Entity/EmailInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+interface EmailInterface
+{
+    public function getEmail(): ?string;
+
+    public function setEmail(?string $email): self;
+}
diff --git a/src/Entity/EmailTrait.php b/src/Entity/EmailTrait.php
new file mode 100644
index 0000000..35dc64a
--- /dev/null
+++ b/src/Entity/EmailTrait.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+
+trait EmailTrait
+{
+    #[ORM\Column(length: 255, nullable: true)]
+    #[Assert\Length(max: 255)]
+    #[Assert\Email]
+    private ?string $email = null;
+
+    public function getEmail(): ?string
+    {
+        return $this->email;
+    }
+
+    public function setEmail(?string $email): self
+    {
+        $email = strtolower($email);
+        if ($email === '') {
+            $email = null;
+        }
+        $this->email = $email;
+
+        return $this;
+    }
+}
diff --git a/src/Entity/NameableInterface.php b/src/Entity/NameableInterface.php
new file mode 100644
index 0000000..a992776
--- /dev/null
+++ b/src/Entity/NameableInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+interface NameableInterface
+{
+    public function getName(): ?string;
+
+    public function setName(string $name): self;
+}
diff --git a/src/Entity/NameableTrait.php b/src/Entity/NameableTrait.php
new file mode 100644
index 0000000..7578993
--- /dev/null
+++ b/src/Entity/NameableTrait.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+
+trait NameableTrait
+{
+    #[ORM\Column(length: 255)]
+    #[Assert\Length(max: 255)]
+    #[Assert\NotBlank]
+    private ?string $name = null;
+
+    public function getName(): ?string
+    {
+        return $this->name;
+    }
+
+    public function setName(string $name): self
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+}
diff --git a/src/Entity/OrganizationInterface.php b/src/Entity/OrganizationInterface.php
new file mode 100644
index 0000000..eb92f9f
--- /dev/null
+++ b/src/Entity/OrganizationInterface.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+interface OrganizationInterface extends NameableInterface, SirenInterface, AddressInterface, PhoneInterface
+{
+    public function getId(): ?int;
+
+    public function getOrganizationEmail(): ?string;
+
+    public function setOrganizationEmail(?string $organizationEmail): static;
+}
diff --git a/src/Entity/OrganizationTrait.php b/src/Entity/OrganizationTrait.php
new file mode 100644
index 0000000..a2edc3a
--- /dev/null
+++ b/src/Entity/OrganizationTrait.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Smart\CoreBundle\Entity\AddressTrait;
+use Symfony\Component\Validator\Constraints as Assert;
+
+trait OrganizationTrait
+{
+    use NameableTrait;
+    use SirenTrait;
+    use AddressTrait;
+    use PhoneTrait;
+    use WebsiteTrait;
+
+    #[ORM\Id]
+    #[ORM\GeneratedValue]
+    #[ORM\Column]
+    private ?int $id = null;
+
+    #[ORM\Column(length: 255, nullable: true)]
+    #[Assert\Length(max: 255)]
+    private ?string $organizationEmail = null;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getOrganizationEmail(): ?string
+    {
+        return $this->organizationEmail;
+    }
+
+    public function setOrganizationEmail(?string $organizationEmail): static
+    {
+        $this->organizationEmail = $organizationEmail;
+
+        return $this;
+    }
+}
diff --git a/src/Entity/PersonNameableInterface.php b/src/Entity/PersonNameableInterface.php
new file mode 100644
index 0000000..c31c11b
--- /dev/null
+++ b/src/Entity/PersonNameableInterface.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+interface PersonNameableInterface
+{
+    public function getFullName(): ?string;
+
+    public function getInitial(): string;
+
+    public function getFirstName(): ?string;
+
+    public function setFirstName(?string $firstName): self;
+
+    public function getLastName(): ?string;
+
+    public function setLastName(?string $lastName): self;
+}
diff --git a/src/Entity/PersonNameableTrait.php b/src/Entity/PersonNameableTrait.php
new file mode 100644
index 0000000..8d3b7db
--- /dev/null
+++ b/src/Entity/PersonNameableTrait.php
@@ -0,0 +1,60 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+
+trait PersonNameableTrait
+{
+    #[ORM\Column(length: 100, nullable: true)]
+    #[Assert\Length(max: 100)]
+    protected ?string $firstName = null;
+
+    #[ORM\Column(length: 100, nullable: true)]
+    #[Assert\Length(max: 100)]
+    protected ?string $lastName = null;
+
+    public function getFullName(): ?string
+    {
+        $toReturn = trim(sprintf('%s %s', $this->getFirstName(), $this->getLastName()));
+        if ($toReturn === '') {
+            return null;
+        }
+
+        return $toReturn;
+    }
+
+    public function getInitial(): string
+    {
+        return sprintf(
+            '%s%s',
+            substr(trim($this->getFirstName()), 0, 1),
+            substr(trim($this->getLastName()), 0, 1)
+        );
+    }
+
+    public function getFirstName(): ?string
+    {
+        return $this->firstName;
+    }
+
+    public function setFirstName(?string $firstName): self
+    {
+        $this->firstName = $firstName;
+
+        return $this;
+    }
+
+    public function getLastName(): ?string
+    {
+        return $this->lastName;
+    }
+
+    public function setLastName(?string $lastName): self
+    {
+        $this->lastName = $lastName;
+
+        return $this;
+    }
+}
diff --git a/src/Entity/PhoneInterface.php b/src/Entity/PhoneInterface.php
new file mode 100644
index 0000000..84e5106
--- /dev/null
+++ b/src/Entity/PhoneInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+interface PhoneInterface
+{
+    public function getPhone(): ?string;
+
+    public function setPhone(?string $phone): static;
+}
diff --git a/src/Entity/PhoneTrait.php b/src/Entity/PhoneTrait.php
new file mode 100644
index 0000000..91fe6c5
--- /dev/null
+++ b/src/Entity/PhoneTrait.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+use Smart\CoreBundle\Utils\RegexUtils;
+
+trait PhoneTrait
+{
+    #[ORM\Column(length: 20, nullable: true)]
+    #[Assert\Length(max: 20)]
+    #[Assert\Regex(pattern: RegexUtils::PHONE_PATTERN, message: RegexUtils::PHONE_MESSAGE)]
+    private ?string $phone = null;
+
+    public function getPhone(): ?string
+    {
+        return $this->phone;
+    }
+
+    public function setPhone(?string $phone): static
+    {
+        $this->phone = $phone;
+
+        return $this;
+    }
+}
diff --git a/src/Entity/SirenInterface.php b/src/Entity/SirenInterface.php
new file mode 100644
index 0000000..787a841
--- /dev/null
+++ b/src/Entity/SirenInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+interface SirenInterface
+{
+    public function getSiren(): ?string;
+
+    public function setSiren(?string $siren): static;
+}
diff --git a/src/Entity/SirenTrait.php b/src/Entity/SirenTrait.php
new file mode 100644
index 0000000..00d6913
--- /dev/null
+++ b/src/Entity/SirenTrait.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+use Smart\CoreBundle\Utils\RegexUtils;
+
+trait SirenTrait
+{
+    #[ORM\Column(length: 20, nullable: true)]
+    #[Assert\Length(max: 20)]
+    #[Assert\Regex(pattern: RegexUtils::SIREN_PATTERN, message: RegexUtils::SIREN_MESSAGE)]
+    private ?string $siren = null;
+
+    public function getSiren(): ?string
+    {
+        return $this->siren;
+    }
+
+    public function setSiren(?string $siren): static
+    {
+        $this->siren = $siren;
+
+        return $this;
+    }
+}
diff --git a/src/Entity/WebsiteInterface.php b/src/Entity/WebsiteInterface.php
new file mode 100644
index 0000000..cf61bb8
--- /dev/null
+++ b/src/Entity/WebsiteInterface.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+interface WebsiteInterface
+{
+    public function getWebsite(): ?string;
+
+    public function setWebsite(?string $website): static;
+}
diff --git a/src/Entity/WebsiteTrait.php b/src/Entity/WebsiteTrait.php
new file mode 100644
index 0000000..7d066b8
--- /dev/null
+++ b/src/Entity/WebsiteTrait.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Smart\CoreBundle\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+
+trait WebsiteTrait
+{
+    #[ORM\Column(length: 300, nullable: true)]
+    #[Assert\Length(max: 300)]
+    #[Assert\Url]
+    private ?string $website = null;
+
+    public function getWebsite(): ?string
+    {
+        return $this->website;
+    }
+
+    public function setWebsite(?string $website): static
+    {
+        $this->website = $website;
+
+        return $this;
+    }
+}