Feat - Introduce readonly properties

src/Entity/DateDimension.php

@@ -58,7 +58,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.id',
     ])]
-    private UuidInterface $id;
+    private readonly UuidInterface $id;
 
     #[ORM\Column(
         name: 'year',
@@ -71,7 +71,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.year',
     ])]
-    private int $year;
+    private readonly int $year;
 
     #[ORM\Column(
         name: 'month',
@@ -84,7 +84,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.month',
     ])]
-    private int $month;
+    private readonly int $month;
 
     #[ORM\Column(
         name: 'day',
@@ -97,7 +97,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.day',
     ])]
-    private int $day;
+    private readonly int $day;
 
     #[ORM\Column(
         name: 'quarter',
@@ -110,7 +110,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.quarter',
     ])]
-    private int $quarter;
+    private readonly int $quarter;
 
     #[ORM\Column(
         name: 'week_number',
@@ -123,7 +123,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.weekNumber',
     ])]
-    private int $weekNumber;
+    private readonly int $weekNumber;
 
     #[ORM\Column(
         name: 'day_number_of_week',
@@ -136,7 +136,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.dayNumber',
     ])]
-    private int $dayNumberOfWeek;
+    private readonly int $dayNumberOfWeek;
 
     #[ORM\Column(
         name: 'day_number_of_year',
@@ -149,7 +149,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.dayNumberOfYear',
     ])]
-    private int $dayNumberOfYear;
+    private readonly int $dayNumberOfYear;
 
     #[ORM\Column(
         name: 'leap_year',
@@ -162,7 +162,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.leapYear',
     ])]
-    private bool $leapYear;
+    private readonly bool $leapYear;
 
     #[ORM\Column(
         name: 'week_numbering_year',
@@ -175,7 +175,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.weekNumberingYear',
     ])]
-    private int $weekNumberingYear;
+    private readonly int $weekNumberingYear;
 
     #[ORM\Column(
         name: 'unix_time',
@@ -188,7 +188,7 @@ class DateDimension implements EntityInterface
         'DateDimension',
         'DateDimension.unixTime',
     ])]
-    private int $unixTime;
+    private readonly int $unixTime;
 
     public function __construct(
         #[ORM\Column(
@@ -199,7 +199,7 @@ public function __construct(
             'DateDimension',
             'DateDimension.date',
         ])]
-        private DateTimeImmutable $date
+        private readonly DateTimeImmutable $date
     ) {
         $this->id = $this->createUuid();
 

src/Entity/Healthz.php

@@ -50,25 +50,23 @@ class Healthz implements EntityInterface
     ])]
     private UuidInterface $id;
 
-    #[ORM\Column(
-        name: 'timestamp',
-        type: Types::DATETIME_IMMUTABLE,
-    )]
-    #[Groups([
-        'Healthz',
-        'Healthz.timestamp',
-    ])]
-    private DateTimeImmutable $timestamp;
-
     /**
      * Healthz constructor.
      *
      * @throws Throwable
      */
-    public function __construct()
-    {
+    public function __construct(
+        #[ORM\Column(
+            name: 'timestamp',
+            type: Types::DATETIME_IMMUTABLE,
+        )]
+        #[Groups([
+            'Healthz',
+            'Healthz.timestamp',
+        ])]
+        private readonly DateTimeImmutable $timestamp = new DateTimeImmutable(timezone: new DateTimeZone('UTC')),
+    ) {
         $this->id = $this->createUuid();
-        $this->timestamp = new DateTimeImmutable(timezone: new DateTimeZone('UTC'));
     }
 
     public function getId(): string
@@ -81,13 +79,6 @@ public function getTimestamp(): DateTimeImmutable
         return $this->getCreatedAt();
     }
 
-    public function setTimestamp(DateTimeImmutable $timestamp): self
-    {
-        $this->timestamp = $timestamp;
-
-        return $this;
-    }
-
     public function getCreatedAt(): DateTimeImmutable
     {
         return $this->timestamp;

src/Entity/Traits/LogEntityTrait.php → src/Entity/LogEntity.php

@@ -1,14 +1,13 @@
 <?php
 declare(strict_types = 1);
 /**
- * /src/Entity/Traits/LogEntityTrait.php
+ * /src/Entity/LogEntity.php
  *
  * @author TLe, Tarmo Leppänen <[email protected]>
  */
 
-namespace App\Entity\Traits;
+namespace App\Entity;
 
-use App\Entity\User;
 use DateTimeImmutable;
 use DateTimeZone;
 use Doctrine\DBAL\Types\Types;
@@ -18,14 +17,13 @@
 use Throwable;
 
 /**
- * Trait LogEntityTrait
+ * Class LogEntity
  *
- * @package App\Entity\Traits
+ * @package App\Entity
  * @author TLe, Tarmo Leppänen <[email protected]>
- *
- * @property User|null $user
  */
-trait LogEntityTrait
+#[ORM\MappedSuperclass]
+abstract class LogEntity
 {
     #[ORM\Column(
         name: 'time',
@@ -38,7 +36,7 @@ trait LogEntityTrait
         'LogRequest',
         'LogRequest.time',
     ])]
-    protected DateTimeImmutable $time;
+    protected readonly DateTimeImmutable $time;
 
     #[ORM\Column(
         name: '`date`',
@@ -51,7 +49,7 @@ trait LogEntityTrait
         'LogRequest',
         'LogRequest.date',
     ])]
-    protected DateTimeImmutable $date;
+    protected readonly DateTimeImmutable $date;
 
     #[ORM\Column(
         name: 'agent',
@@ -64,7 +62,7 @@ trait LogEntityTrait
         'LogRequest',
         'LogRequest.agent',
     ])]
-    protected string $agent = '';
+    protected readonly string $agent;
 
     #[ORM\Column(
         name: 'http_host',
@@ -78,7 +76,7 @@ trait LogEntityTrait
         'LogRequest',
         'LogRequest.httpHost',
     ])]
-    protected string $httpHost = '';
+    protected readonly string $httpHost;
 
     #[ORM\Column(
         name: 'client_ip',
@@ -92,7 +90,21 @@ trait LogEntityTrait
         'LogRequest',
         'LogRequest.clientIp',
     ])]
-    private string $clientIp = '';
+    protected readonly string $clientIp;
+
+    /**
+     * @throws Throwable
+     */
+    public function __construct(?Request $request)
+    {
+        $now = new DateTimeImmutable(timezone: new DateTimeZone('UTC'));
+
+        $this->time = $now;
+        $this->date = $now;
+        $this->clientIp = $request?->getClientIp() ?? '';
+        $this->httpHost = $request?->getHttpHost() ?? '';
+        $this->agent = $request?->headers->get('User-Agent') ?? '';
+    }
 
     public function getTime(): DateTimeImmutable
     {
@@ -123,23 +135,4 @@ public function getCreatedAt(): ?DateTimeImmutable
     {
         return $this->getDate();
     }
-
-    private function processRequestData(Request $request): void
-    {
-        $this->clientIp = $request->getClientIp() ?? '';
-        $this->httpHost = $request->getHttpHost();
-        $this->agent = $request->headers->get('User-Agent') ?? '';
-    }
-
-    /**
-     * @throws Throwable
-     */
-    #[ORM\PrePersist]
-    private function processTimeAndDate(): void
-    {
-        $now = new DateTimeImmutable(timezone: new DateTimeZone('UTC'));
-
-        $this->time = $now;
-        $this->date = $now;
-    }
 }