Merge pull request #2 from aoirontec/trait-timestampable

Add TimestampableTrait

README.md

@@ -17,3 +17,4 @@ Trait for doctrine entities
 * [UpdateTrait](docs/UpdateTrait.md)
 * [UserNameTrait](docs/UserNameTrait.md)
 * [GetToFieldsTrait](docs/GetToFieldsTrait.md)
+* [TimestampableTrait](docs/TimestampableTrait.md)

docs/TimestampableTrait.md

@@ -0,0 +1,23 @@
+# TimestampableTrait
+
+Trait para gestionar la fecha UTC de creación/actualización de una entidad.
+
+````php
+<?php
+
+namespace App\Entity;
+
+use \Irontec\DoctrineEntityTrait\TimestampableTrait;
+
+class MyEntity
+{
+    ...
+    use TimestampableTrait;
+    ...
+}
+````
+
+# Fields
+
++ createdAt
++ updatedAt

traits/TimestampableTrait.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * This file is part of the DoctrineEntityTrait.
+ */
+
+namespace Irontec\DoctrineEntityTrait;
+
+use DateTimeImmutable;
+use DateTimeZone;
+use Doctrine\DBAL\Types\Types;
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
+
+/**
+ * Entities using this Trait must have the
+ * `#[ORM\HasLifecycleCallbacks]` attribute.
+ */
+trait TimestampableTrait
+{
+    #[ORM\Column(type: Types::DATETIME_IMMUTABLE, options: ['default' => 'CURRENT_TIMESTAMP'])]
+    #[Groups(['timestampable'])]
+    protected ?DateTimeImmutable $createdAt = null;
+
+    #[ORM\Column(type: Types::DATETIME_IMMUTABLE, options: ['default' => 'CURRENT_TIMESTAMP'])]
+    #[Groups(['timestampable'])]
+    protected ?DateTimeImmutable $updatedAt = null;
+
+    public function getCreatedAt(): ?DateTimeImmutable
+    {
+        return $this->createdAt;
+    }
+
+    public function getUpdatedAt(): ?DateTimeImmutable
+    {
+        return $this->updatedAt;
+    }
+
+    #[ORM\PrePersist]
+    public function createTimestamps(): void
+    {
+        $now = new DateTimeImmutable('now', timezone: new DateTimeZone('UTC'));
+        $this->createdAt = $now;
+        $this->updatedAt = $now;
+    }
+
+    #[ORM\PreUpdate]
+    public function updateTimestamps(): void
+    {
+        $this->updatedAt = new DateTimeImmutable('now', timezone: new DateTimeZone('UTC'));
+    }
+}