Support PHP8 attribute mapping for doctrine/mongodb-odm

Author: franmomu

CHANGELOG.md

@@ -20,6 +20,7 @@ a release.
 
 ## [Unreleased]
 ### Added
+- PHP 8 Attributes support for Doctrine MongoDB to document & traits
 - Support for doctrine/dbal >=3.2
 - Timestampable: Support to use annotations as attributes on PHP >= 8.0.
 

src/Blameable/Traits/BlameableDocument.php

@@ -10,6 +10,7 @@
 namespace Gedmo\Blameable\Traits;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 use Gedmo\Mapping\Annotation as Gedmo;
 
 /**
@@ -24,13 +25,15 @@ trait BlameableDocument
      * @Gedmo\Blameable(on="create")
      * @ODM\Field(type="string")
      */
+    #[ODM\Field(type: Type::STRING)]
     protected $createdBy;
 
     /**
      * @var string
      * @Gedmo\Blameable(on="update")
      * @ODM\Field(type="string")
      */
+    #[ODM\Field(type: Type::STRING)]
     protected $updatedBy;
 
     /**

src/IpTraceable/Traits/IpTraceableDocument.php

@@ -10,6 +10,7 @@
 namespace Gedmo\IpTraceable\Traits;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 use Gedmo\Mapping\Annotation as Gedmo;
 
 /**
@@ -24,13 +25,15 @@ trait IpTraceableDocument
      * @Gedmo\IpTraceable(on="create")
      * @ODM\Field(type="string")
      */
+    #[ODM\Field(type: Type::STRING)]
     protected $createdFromIp;
 
     /**
      * @var string
      * @Gedmo\IpTraceable(on="update")
      * @ODM\Field(type="string")
      */
+    #[ODM\Field(type: Type::STRING)]
     protected $updatedFromIp;
 
     /**

src/Loggable/Document/LogEntry.php

@@ -10,6 +10,7 @@
 namespace Gedmo\Loggable\Document;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoODM;
+use Gedmo\Loggable\Document\Repository\LogEntryRepository;
 
 /**
  * Gedmo\Loggable\Document\LogEntry
@@ -24,6 +25,11 @@
  *     }
  * )
  */
+#[MongoODM\Document(repositoryClass: LogEntryRepository::class)]
+#[MongoODM\Index(keys: ['objectId' => 'asc', 'objectClass' => 'asc', 'version' => 'asc'])]
+#[MongoODM\Index(keys: ['loggedAt' => 'asc'])]
+#[MongoODM\Index(keys: ['objectClass' => 'asc'])]
+#[MongoODM\Index(keys: ['username' => 'asc'])]
 class LogEntry extends MappedSuperclass\AbstractLogEntry
 {
     /*

src/Loggable/Document/MappedSuperclass/AbstractLogEntry.php

@@ -10,68 +10,78 @@
 namespace Gedmo\Loggable\Document\MappedSuperclass;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 
 /**
  * Gedmo\Loggable\Document\MappedSuperclass\AbstractLogEntry
  *
  * @MongoODM\MappedSuperclass
  */
+#[MongoODM\MappedSuperclass]
 abstract class AbstractLogEntry
 {
     /**
      * @var int
      *
      * @MongoODM\Id
      */
+    #[MongoODM\Id]
     protected $id;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $action;
 
     /**
      * @var \DateTime
      *
      * @MongoODM\Field(type="date")
      */
+    #[MongoODM\Field(type: Type::DATE)]
     protected $loggedAt;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string", nullable=true)
      */
+    #[MongoODM\Field(type: Type::STRING, nullable: true)]
     protected $objectId;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $objectClass;
 
     /**
      * @var int
      *
      * @MongoODM\Field(type="int")
      */
+    #[MongoODM\Field(type: Type::INT)]
     protected $version;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="hash", nullable=true)
      */
+    #[MongoODM\Field(type: Type::HASH, nullable: true)]
     protected $data;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string", nullable=true)
      */
+    #[MongoODM\Field(type: Type::STRING, nullable: true)]
     protected $username;
 
     /**

src/SoftDeleteable/Traits/SoftDeleteableDocument.php

@@ -11,6 +11,7 @@
 
 use DateTime;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 
 /**
  * A soft deletable trait you can apply to your MongoDB entities.
@@ -25,6 +26,7 @@ trait SoftDeleteableDocument
      *
      * @var DateTime|null
      */
+    #[ODM\Field(type: Type::DATE)]
     protected $deletedAt;
 
     /**

src/Timestampable/Traits/TimestampableDocument.php

@@ -10,6 +10,7 @@
 namespace Gedmo\Timestampable\Traits;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 use Gedmo\Mapping\Annotation as Gedmo;
 
 /**
@@ -24,13 +25,17 @@ trait TimestampableDocument
      * @Gedmo\Timestampable(on="create")
      * @ODM\Field(type="date")
      */
+    #[Gedmo\Timestampable(on: 'create')]
+    #[ODM\Field(type: Type::DATE)]
     protected $createdAt;
 
     /**
      * @var \DateTime
      * @Gedmo\Timestampable(on="update")
      * @ODM\Field(type="date")
      */
+    #[Gedmo\Timestampable(on: 'update')]
+    #[ODM\Field(type: Type::DATE)]
     protected $updatedAt;
 
     /**

src/Translatable/Document/MappedSuperclass/AbstractPersonalTranslation.php

@@ -10,26 +10,30 @@
 namespace Gedmo\Translatable\Document\MappedSuperclass;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 
 /**
  * Gedmo\Translatable\Document\AbstractPersonalTranslation
  *
  * @MongoODM\MappedSuperclass
  */
+#[MongoODM\MappedSuperclass]
 abstract class AbstractPersonalTranslation
 {
     /**
      * @var string|null
      *
      * @MongoODM\Id
      */
+    #[MongoODM\Id]
     protected $id;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $locale;
 
     /**
@@ -45,13 +49,15 @@ abstract class AbstractPersonalTranslation
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $field;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $content;
 
     /**

src/Translatable/Document/MappedSuperclass/AbstractTranslation.php

@@ -10,54 +10,62 @@
 namespace Gedmo\Translatable\Document\MappedSuperclass;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 
 /**
  * Gedmo\Translatable\Document\MappedSuperclass\AbstractTranslation
  *
  * @MongoODM\MappedSuperclass
  */
+#[MongoODM\MappedSuperclass]
 abstract class AbstractTranslation
 {
     /**
      * @var int
      *
      * @MongoODM\Id
      */
+    #[MongoODM\Id]
     protected $id;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $locale;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $objectClass;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $field;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string", name="foreign_key")
      */
+    #[MongoODM\Field(name: 'foreign_key', type: Type::STRING)]
     protected $foreignKey;
 
     /**
      * @var string
      *
      * @MongoODM\Field(type="string")
      */
+    #[MongoODM\Field(type: Type::STRING)]
     protected $content;
 
     /**

src/Translatable/Document/Translation.php

@@ -9,26 +9,28 @@
 
 namespace Gedmo\Translatable\Document;
 
-use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
-use Doctrine\ODM\MongoDB\Mapping\Annotations\Index;
-use Doctrine\ODM\MongoDB\Mapping\Annotations\UniqueIndex;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Gedmo\Translatable\Document\Repository\TranslationRepository;
 
 /**
  * Gedmo\Translatable\Document\Translation
  *
- * @Document(repositoryClass="Gedmo\Translatable\Document\Repository\TranslationRepository")
- * @UniqueIndex(name="lookup_unique_idx", keys={
+ * @ODM\Document(repositoryClass="Gedmo\Translatable\Document\Repository\TranslationRepository")
+ * @ODM\UniqueIndex(name="lookup_unique_idx", keys={
  *         "locale" = "asc",
  *         "object_class" = "asc",
  *         "foreign_key" = "asc",
  *         "field" = "asc"
  * })
- * @Index(name="translations_lookup_idx", keys={
+ * @ODM\Index(name="translations_lookup_idx", keys={
  *      "locale" = "asc",
  *      "object_class" = "asc",
  *      "foreign_key" = "asc"
  * })
  */
+#[ODM\Document(repositoryClass: TranslationRepository::class)]
+#[ODM\UniqueIndex(name: 'lookup_unique_idx', keys: ['locale' => 'asc', 'object_class' => 'asc', 'foreign_key' => 'asc', 'field' => 'asc'])]
+#[ODM\Index(name: 'translations_lookup_idx', keys: ['locale' => 'asc', 'object_class' => 'asc', 'foreign_key' => 'asc'])]
 class Translation extends MappedSuperclass\AbstractTranslation
 {
     /*