Extract entity functionality into traits and interfaces

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

Author: Copilot

src/Entity/Attachments/AttachmentContainingDBElement.php

@@ -24,13 +24,11 @@
 
 use App\Entity\Base\AbstractNamedDBElement;
 use App\Entity\Base\MasterAttachmentTrait;
+use App\Entity\Base\AttachmentsTrait;
 use App\Entity\Contracts\HasAttachmentsInterface;
 use App\Entity\Contracts\HasMasterAttachmentInterface;
 use App\Repository\AttachmentContainingDBElementRepository;
-use Doctrine\Common\Collections\ArrayCollection;
-use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
-use Symfony\Component\Serializer\Annotation\Groups;
 
 /**
  * @template AT of Attachment
@@ -39,83 +37,18 @@
 abstract class AttachmentContainingDBElement extends AbstractNamedDBElement implements HasMasterAttachmentInterface, HasAttachmentsInterface
 {
     use MasterAttachmentTrait;
-
-    /**
-     * @var Collection<int, Attachment>
-     * @phpstan-var Collection<int, AT>
-     * ORM Mapping is done in subclasses (e.g. Part)
-     */
-    #[Groups(['full', 'import'])]
-    protected Collection $attachments;
+    use AttachmentsTrait;
 
     public function __construct()
     {
-        $this->attachments = new ArrayCollection();
+        $this->initializeAttachments();
     }
 
     public function __clone()
     {
-        if ($this->id) {
-            $attachments = $this->attachments;
-            $this->attachments = new ArrayCollection();
-            //Set master attachment is needed
-            foreach ($attachments as $attachment) {
-                $clone = clone $attachment;
-                if ($attachment === $this->master_picture_attachment) {
-                    $this->setMasterPictureAttachment($clone);
-                }
-                $this->addAttachment($clone);
-            }
-        }
+        $this->cloneAttachments();
 
         //Parent has to be last call, as it resets the ID
         parent::__clone();
     }
-
-    /********************************************************************************
-     *
-     *   Getters
-     *
-     *********************************************************************************/
-
-    /**
-     *  Gets all attachments associated with this element.
-     */
-    public function getAttachments(): Collection
-    {
-        return $this->attachments;
-    }
-
-    /**
-     * Adds an attachment to this element.
-     *
-     * @param Attachment $attachment Attachment
-     *
-     * @return $this
-     */
-    public function addAttachment(Attachment $attachment): self
-    {
-        //Attachment must be associated with this element
-        $attachment->setElement($this);
-        $this->attachments->add($attachment);
-
-        return $this;
-    }
-
-    /**
-     * Removes the given attachment from this element.
-     *
-     * @return $this
-     */
-    public function removeAttachment(Attachment $attachment): self
-    {
-        $this->attachments->removeElement($attachment);
-
-        //Check if this is the master attachment -> remove it from master attachment too, or it can not be deleted from DB...
-        if ($attachment === $this->getMasterPictureAttachment()) {
-            $this->setMasterPictureAttachment(null);
-        }
-
-        return $this;
-    }
 }

src/Entity/Base/AbstractCompany.php

@@ -24,11 +24,9 @@
 
 use App\Entity\Attachments\Attachment;
 use App\Entity\Parameters\AbstractParameter;
-use Doctrine\DBAL\Types\Types;
+use App\Entity\Contracts\CompanyInterface;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Serializer\Annotation\Groups;
-use function is_string;
-use Symfony\Component\Validator\Constraints as Assert;
 
 /**
  * This abstract class is used for companies like suppliers or manufacturers.
@@ -38,226 +36,15 @@
  * @extends AbstractPartsContainingDBElement<AT, PT>
  */
 #[ORM\MappedSuperclass]
-abstract class AbstractCompany extends AbstractPartsContainingDBElement
+abstract class AbstractCompany extends AbstractPartsContainingDBElement implements CompanyInterface
 {
+    use CompanyTrait;
+
     #[Groups(['company:read'])]
     protected ?\DateTimeImmutable $addedDate = null;
     #[Groups(['company:read'])]
     protected ?\DateTimeImmutable $lastModified = null;
 
-    /**
-     * @var string The address of the company
-     */
-    #[Groups(['full', 'company:read', 'company:write', 'import', 'extended'])]
-    #[ORM\Column(type: Types::STRING)]
-    #[Assert\Length(max: 255)]
-    protected string $address = '';
-
-    /**
-     * @var string The phone number of the company
-     */
-    #[Groups(['full', 'company:read', 'company:write', 'import', 'extended'])]
-    #[ORM\Column(type: Types::STRING)]
-    #[Assert\Length(max: 255)]
-    protected string $phone_number = '';
-
-    /**
-     * @var string The fax number of the company
-     */
-    #[Groups(['full', 'company:read', 'company:write', 'import', 'extended'])]
-    #[ORM\Column(type: Types::STRING)]
-    #[Assert\Length(max: 255)]
-    protected string $fax_number = '';
-
-    /**
-     * @var string The email address of the company
-     */
-    #[Assert\Email]
-    #[Groups(['full', 'company:read', 'company:write', 'import', 'extended'])]
-    #[ORM\Column(type: Types::STRING)]
-    #[Assert\Length(max: 255)]
-    protected string $email_address = '';
-
-    /**
-     * @var string The website of the company
-     */
-    #[Assert\Url(requireTld: false)]
-    #[Groups(['full', 'company:read', 'company:write', 'import', 'extended'])]
-    #[ORM\Column(type: Types::STRING, length: 2048)]
-    #[Assert\Length(max: 2048)]
-    protected string $website = '';
-
     #[Groups(['company:read', 'company:write', 'import', 'full', 'extended'])]
     protected string $comment = '';
-
-    /**
-     * @var string The link to the website of an article. Use %PARTNUMBER% as placeholder for the part number.
-     */
-    #[ORM\Column(type: Types::STRING, length: 2048)]
-    #[Assert\Length(max: 2048)]
-    #[Groups(['full', 'company:read', 'company:write', 'import', 'extended'])]
-    protected string $auto_product_url = '';
-
-    /********************************************************************************
-     *
-     *   Getters
-     *
-     *********************************************************************************/
-
-    /**
-     * Get the address.
-     *
-     * @return string the address of the company (with "\n" as line break)
-     */
-    public function getAddress(): string
-    {
-        return $this->address;
-    }
-
-    /**
-     * Get the phone number.
-     *
-     * @return string the phone number of the company
-     */
-    public function getPhoneNumber(): string
-    {
-        return $this->phone_number;
-    }
-
-    /**
-     * Get the fax number.
-     *
-     * @return string the fax number of the company
-     */
-    public function getFaxNumber(): string
-    {
-        return $this->fax_number;
-    }
-
-    /**
-     * Get the e-mail address.
-     *
-     * @return string the e-mail address of the company
-     */
-    public function getEmailAddress(): string
-    {
-        return $this->email_address;
-    }
-
-    /**
-     * Get the website.
-     *
-     * @return string the website of the company
-     */
-    public function getWebsite(): string
-    {
-        return $this->website;
-    }
-
-    /**
-     * Get the link to the website of an article.
-     *
-     * @param  string|null  $partnr * NULL for returning the URL with a placeholder for the part number
-     *                       * or the part number for returning the direct URL to the article
-     *
-     * @return string the link to the article
-     */
-    public function getAutoProductUrl(?string $partnr = null): string
-    {
-        if (is_string($partnr)) {
-            return str_replace('%PARTNUMBER%', $partnr, $this->auto_product_url);
-        }
-
-        return $this->auto_product_url;
-    }
-
-    /********************************************************************************
-     *
-     *   Setters
-     *
-     *********************************************************************************/
-
-    /**
-     * Set the addres.
-     *
-     * @param string $new_address the new address (with "\n" as line break)
-     *
-     * @return $this
-     */
-    public function setAddress(string $new_address): self
-    {
-        $this->address = $new_address;
-
-        return $this;
-    }
-
-    /**
-     * Set the phone number.
-     *
-     * @param string $new_phone_number the new phone number
-     *
-     * @return $this
-     */
-    public function setPhoneNumber(string $new_phone_number): self
-    {
-        $this->phone_number = $new_phone_number;
-
-        return $this;
-    }
-
-    /**
-     * Set the fax number.
-     *
-     * @param string $new_fax_number the new fax number
-     *
-     * @return $this
-     */
-    public function setFaxNumber(string $new_fax_number): self
-    {
-        $this->fax_number = $new_fax_number;
-
-        return $this;
-    }
-
-    /**
-     * Set the e-mail address.
-     *
-     * @param string $new_email_address the new e-mail address
-     *
-     * @return $this
-     */
-    public function setEmailAddress(string $new_email_address): self
-    {
-        $this->email_address = $new_email_address;
-
-        return $this;
-    }
-
-    /**
-     * Set the website.
-     *
-     * @param string $new_website the new website
-     *
-     * @return $this
-     */
-    public function setWebsite(string $new_website): self
-    {
-        $this->website = $new_website;
-
-        return $this;
-    }
-
-    /**
-     * Set the link to the website of an article.
-     *
-     * @param string $new_url the new URL with the placeholder %PARTNUMBER% for the part number
-     *
-     * @return $this
-     */
-    public function setAutoProductUrl(string $new_url): self
-    {
-        $this->auto_product_url = $new_url;
-
-        return $this;
-    }
 }