Merge pull request #12 from Prometee/master

Allows entities to be extended by a custom parent class
monsieurbiz · Jun 24, 2024 · 5e2c450 · 5e2c450
2 parents 1f1415b + 905ddc8
commit 5e2c450
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 100 deletions.
diff --git a/composer.json b/composer.json
@@ -42,7 +42,8 @@
         "symfony/dotenv": "^4.4",
         "symfony/flex": "^1.7",
         "symfony/web-profiler-bundle": "^4.4",
-        "phpmd/phpmd": "@stable"
+        "phpmd/phpmd": "@stable",
+        "http-interop/http-factory-guzzle": "^1.2"
     },
     "prefer-stable": true,
     "autoload": {

diff --git a/src/Entity/Message.php b/src/Entity/Message.php
@@ -16,8 +16,6 @@
 use DateTimeInterface;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
-use Doctrine\ORM\Mapping as ORM;
-use Gedmo\Mapping\Annotation as Gedmo;
 use Gedmo\Timestampable\Timestampable;
 use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Resource\Model\ResourceInterface;
@@ -28,10 +26,6 @@
 use Sylius\Component\Resource\Model\TranslatableInterface;
 use Sylius\Component\Resource\Model\TranslatableTrait;
 
-/**
- * @ORM\Entity
- * @ORM\Table(name="mbiz_alert_message")
- */
 class Message implements ResourceInterface, TimestampableInterface, ToggleableInterface, TranslatableInterface, Timestampable
 {
     use TimestampableTrait;
@@ -44,81 +38,22 @@ class Message implements ResourceInterface, TimestampableInterface, ToggleableIn
         getTranslation as private doGetTranslation;
     }
 
-    /**
-     * @var int|null
-     *
-     * @ORM\Id
-     * @ORM\GeneratedValue
-     * @ORM\Column(type="integer")
-     */
-    private $id;
+    protected ?int $id = null;
 
-    /**
-     * @var bool
-     * @ORM\Column(type="boolean", options={"default"=true})
-     */
-    protected $enabled = true;
-
-    /**
-     * @var bool
-     * @ORM\Column(name="customers_only", type="boolean", options={"default"=false})
-     */
-    protected $customersOnly = false;
-
-    /**
-     * @var string|null
-     * @ORM\Column(type="string")
-     */
-    protected $name;
-
-    /**
-     * @var string|null
-     * @ORM\Column(type="string", nullable=true)
-     */
-    protected $description;
+    protected bool $customersOnly = false;
 
-    /**
-     * @var Collection<int, ChannelInterface>
-     * @ORM\ManyToMany(targetEntity="\Sylius\Component\Core\Model\ChannelInterface")
-     * @ORM\JoinTable(
-     *     name="mbiz_alert_message_channels",
-     *     joinColumns={@ORM\JoinColumn(name="message_id", referencedColumnName="id")},
-     *     inverseJoinColumns={@ORM\JoinColumn(name="channel_id", referencedColumnName="id")}
-     * )
-     */
-    private $channels;
+    protected ?string $name = null;
 
-    /**
-     * @var DateTimeInterface|null
-     * @ORM\Column(name="created_at", type="datetime_immutable")
-     * @Gedmo\Timestampable(on="create")
-     */
-    protected $createdAt;
+    protected ?string $description = null;
 
-    /**
-     * @var DateTimeInterface|null
-     * @ORM\Column(name="updated_at", type="datetime")
-     * @Gedmo\Timestampable(on="update")
-     */
-    protected $updatedAt;
+    /** @var Collection<int, ChannelInterface> */
+    protected Collection $channels;
 
-    /**
-     * @var string|null
-     * @ORM\Column(name="template_html", type="text", nullable=true)
-     */
-    private $templateHtml;
+    protected ?string $templateHtml = null;
 
-    /**
-     * @var DateTimeInterface|null
-     * @ORM\Column(name="from_date", type="datetime", nullable=true)
-     */
-    private $fromDate;
+    protected ?DateTimeInterface $fromDate = null;
 
-    /**
-     * @var DateTimeInterface|null
-     * @ORM\Column(name="to_date", type="datetime", nullable=true)
-     */
-    private $toDate;
+    protected ?DateTimeInterface $toDate = null;
 
     /**
      * Message constructor.

diff --git a/src/Entity/MessageTranslation.php b/src/Entity/MessageTranslation.php
@@ -13,37 +13,16 @@
 
 namespace MonsieurBiz\SyliusAlertMessagePlugin\Entity;
 
-use Doctrine\ORM\Mapping as ORM;
 use Sylius\Component\Resource\Model\AbstractTranslation;
 use Sylius\Component\Resource\Model\ResourceInterface;
-use Sylius\Component\Resource\Model\TranslationInterface;
 
-/**
- * @ORM\Entity
- * @ORM\Table(name="mbiz_alert_message_translation")
- */
-class MessageTranslation extends AbstractTranslation implements TranslationInterface, ResourceInterface
+class MessageTranslation extends AbstractTranslation implements ResourceInterface
 {
-    /**
-     * @var int|null
-     *
-     * @ORM\Id
-     * @ORM\Column(type="integer")
-     * @ORM\GeneratedValue
-     */
-    private $id;
+    protected ?int $id = null;
 
-    /**
-     * @var string|null
-     * @ORM\Column(type="string", nullable=true)
-     */
-    private $title;
+    protected ?string $title = null;
 
-    /**
-     * @var string|null
-     * @ORM\Column(type="text")
-     */
-    private $message;
+    protected ?string $message = null;
 
     public function getId(): ?int
     {

diff --git a/src/Resources/config/doctrine/Message.orm.xml b/src/Resources/config/doctrine/Message.orm.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<doctrine-mapping
+    xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
+    xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
+                            http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd"
+>
+
+    <mapped-superclass name="MonsieurBiz\SyliusAlertMessagePlugin\Entity\Message" table="mbiz_alert_message">
+        <id name="id" column="id" type="integer">
+            <generator strategy="AUTO" />
+        </id>
+        <field name="enabled" column="enabled" type="boolean">
+            <options>
+                <option name="default">1</option>
+            </options>
+        </field>
+
+        <field name="customersOnly" column="customers_only" type="boolean">
+            <options>
+                <option name="default">0</option>
+            </options>
+        </field>
+
+        <field name="name" column="name" type="string" />
+        <field name="description" column="description" type="string" nullable="true" />
+
+        <many-to-many field="channels" target-entity="Sylius\Component\Core\Model\ChannelInterface">
+            <join-table name="mbiz_alert_message_channels">
+                <join-columns>
+                    <join-column name="message_id" />
+                </join-columns>
+                <inverse-join-columns>
+                    <join-column name="channel_id" />
+                </inverse-join-columns>
+            </join-table>
+        </many-to-many>
+
+        <field name="createdAt" column="created_at" type="datetime_immutable">
+            <gedmo:timestampable on="create"/>
+        </field>
+
+        <field name="updatedAt" column="updated_at" type="datetime">
+            <gedmo:timestampable on="update"/>
+        </field>
+
+        <field name="templateHtml" column="template_html" type="text" nullable="true" />
+        <field name="fromDate" column="from_date" type="datetime" nullable="true" />
+        <field name="toDate" column="to_date" type="datetime" nullable="true" />
+    </mapped-superclass>
+
+</doctrine-mapping>
diff --git a/src/Resources/config/doctrine/MessageTranslation.orm.xml b/src/Resources/config/doctrine/MessageTranslation.orm.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<doctrine-mapping
+    xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
+                            http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd"
+>
+
+    <mapped-superclass name="MonsieurBiz\SyliusAlertMessagePlugin\Entity\MessageTranslation" table="mbiz_alert_message_translation">
+        <id name="id" column="id" type="integer">
+            <generator strategy="AUTO" />
+        </id>
+
+        <field name="title" column="title" type="string" nullable="true" />
+        <field name="message" column="message" type="text" />
+    </mapped-superclass>
+
+</doctrine-mapping>