Allow to use Loggable extension with attributes

Author: franmomu

CHANGELOG.md

@@ -23,6 +23,7 @@ a release.
 - 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.
+- Loggable: Support to use annotations as attributes on PHP >= 8.0.
 
 ### Changes
 - Translatable: Dropped support for other values than "true", "false", "1" and "0" in the `fallback` attribute of the XML mapping.

doc/loggable.md

@@ -9,7 +9,7 @@ Features:
 - ORM and ODM support using same listener
 - Can be nested with other behaviors
 - Objects can be reverted to previous versions
-- Annotation, Yaml and Xml mapping support for extensions
+- Attributes, Annotation, Yaml and Xml mapping support for extensions
 
 Update **2011-04-04**
 
@@ -47,6 +47,12 @@ on how to setup and use the extensions in most optimized way.
 will store logs to optionally specified **logEntryClass**. You will still need to specify versioned fields with the following annotation.
 - **@Gedmo\Mapping\Annotation\Versioned** tracks annotated property for changes
 
+### Loggable annotations:
+
+- **\#[Gedmo\Mapping\Annotation\Loggable(logEntryClass: MyClass::class]** this class attribute
+will store logs to optionally specified **logEntryClass**. You will still need to specify versioned fields with the following attribute.
+- **\#[Gedmo\Mapping\Annotation\Versioned]** tracks attributed property for changes
+
 ### Loggable username:
 
 In order to set the username, when adding the loggable listener you need to set it this way:
@@ -65,30 +71,41 @@ $evm->addEventSubscriber($loggableListener);
 you need to identify entity as being Loggable. The metadata is loaded only once when
 cache is active
 
+**Note:** this example is using annotations and attributes for mapping, you should use
+one of them, not both.
+
 ``` php
 <?php
 namespace Entity;
 
 use Gedmo\Mapping\Annotation as Gedmo;
+use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
  * @ORM\Entity
  * @Gedmo\Loggable
  */
+#[ORM\Entity]
+#[Gedmo\Loggable]
 class Article
 {
     /**
      * @ORM\Column(name="id", type="integer")
      * @ORM\Id
      * @ORM\GeneratedValue(strategy="IDENTITY")
      */
+    #[ORM\Id]
+    #[ORM\Column(name: 'id', type: Types::INTEGER)]
+    #[ORM\GeneratedValue(strategy: 'IDENTITY')]
     private $id;
 
     /**
      * @Gedmo\Versioned
      * @ORM\Column(name="title", type="string", length=8)
      */
+    #[Gedmo\Versioned]
+    #[ORM\Column(name: 'title', type: Types::STRING, length: 8)]
     private $title;
 
     public function getId()
@@ -118,20 +135,26 @@ namespace Document;
 
 use Gedmo\Mapping\Annotation as Gedmo;
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 
 /**
  * @ODM\Document(collection="articles")
  * @Gedmo\Loggable
  */
+#[Gedmo\Loggable]
+#[ODM\Document(collection: 'articles')]
 class Article
 {
     /** @ODM\Id */
+    #[ODM\Id]
     private $id;
 
     /**
      * @ODM\Field(type="string")
      * @Gedmo\Versioned
      */
+    #[Gedmo\Versioned]
+    #[ODM\Field(type: Type::STRING)]
     private $title;
 
     public function __toString()

doc/timestampable.md

@@ -11,7 +11,7 @@ Features:
 - Specific annotations for properties, and no interface required
 - Can react to specific property or relation changes to specific value
 - Can be nested with other behaviors
-- Annotation, Yaml and Xml mapping support for extensions
+- Attribute, Annotation, Yaml and Xml mapping support for extensions
 
 Update **2012-06-26**
 

doc/translatable.md

@@ -12,7 +12,7 @@ Features:
 - Automatic translation of Entity or Document fields when loaded
 - ORM query can use **hint** to translate all records without issuing additional queries
 - Can be nested with other behaviors
-- Annotation, Yaml and Xml mapping support for extensions
+- Attribute, Annotation, Yaml and Xml mapping support for extensions
 
 **2012-01-28**
 

src/Loggable/Mapping/Driver/Attribute.php

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Doctrine Behavioral Extensions package.
+ * (c) Gediminas Morkevicius <[email protected]> http://www.gediminasm.org
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gedmo\Loggable\Mapping\Driver;
+
+/**
+ * This is an attribute mapping driver for Loggable
+ * behavioral extension. Used for extraction of extended
+ * metadata from attributes specifically for Loggable
+ * extension.
+ */
+final class Attribute extends Annotation
+{
+}

src/Mapping/Annotation/Loggable.php

@@ -9,18 +9,40 @@
 
 namespace Gedmo\Mapping\Annotation;
 
+use Attribute;
 use Doctrine\Common\Annotations\Annotation;
+use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
  * Loggable annotation for Loggable behavioral extension
  *
  * @Annotation
+ * @NamedArgumentConstructor
  * @Target("CLASS")
  *
  * @author Gediminas Morkevicius <[email protected]>
  */
-final class Loggable extends Annotation
+#[Attribute(Attribute::TARGET_CLASS)]
+final class Loggable implements GedmoAnnotation
 {
-    /** @var string */
+    /**
+     * @var string|null
+     * @phpstan-var class-string|null
+     */
     public $logEntryClass;
+
+    /**
+     * @phpstan-param class-string|null $logEntryClass
+     */
+    public function __construct(array $data = [], ?string $logEntryClass = null)
+    {
+        if ([] !== $data) {
+            @trigger_error(sprintf(
+                'Passing an array as first argument to "%s()" is deprecated. Use named arguments instead.',
+                __METHOD__
+            ), E_USER_DEPRECATED);
+        }
+
+        $this->logEntryClass = $data['logEntryClass'] ?? $logEntryClass;
+    }
 }

src/Mapping/Annotation/Versioned.php

@@ -9,16 +9,20 @@
 
 namespace Gedmo\Mapping\Annotation;
 
+use Attribute;
 use Doctrine\Common\Annotations\Annotation;
+use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
  * Versioned annotation for Loggable behavioral extension
  *
  * @Annotation
+ * @NamedArgumentConstructor
  * @Target("PROPERTY")
  *
  * @author Gediminas Morkevicius <[email protected]>
  */
-final class Versioned extends Annotation
+#[Attribute(Attribute::TARGET_PROPERTY)]
+final class Versioned implements GedmoAnnotation
 {
 }

tests/Gedmo/Loggable/Fixture/Document/Article.php

@@ -12,55 +12,68 @@
 namespace Gedmo\Tests\Loggable\Fixture\Document;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 use Gedmo\Mapping\Annotation as Gedmo;
 
 /**
  * @ODM\Document(collection="articles")
  * @Gedmo\Loggable
  */
+#[ODM\Document(collection: 'articles')]
+#[Gedmo\Loggable]
 class Article
 {
-    /** @ODM\Id */
+    /**
+     * @var string|null
+     * @ODM\Id
+     */
+    #[ODM\Id]
     private $id;
 
     /**
+     * @var string|null
      * @Gedmo\Versioned
      * @ODM\Field(type="string")
      */
+    #[ODM\Field(type: Type::STRING)]
+    #[Gedmo\Versioned]
     private $title;
 
     /**
+     * @var Author|null
      * @ODM\EmbedOne(targetDocument="Gedmo\Tests\Loggable\Fixture\Document\Author")
      * @Gedmo\Versioned
      */
+    #[ODM\EmbedOne(targetDocument: Author::class)]
+    #[Gedmo\Versioned]
     private $author;
 
     public function __toString()
     {
         return $this->title;
     }
 
-    public function getId()
+    public function getId(): ?string
     {
         return $this->id;
     }
 
-    public function setTitle($title)
+    public function setTitle(?string $title): void
     {
         $this->title = $title;
     }
 
-    public function getTitle()
+    public function getTitle(): ?string
     {
         return $this->title;
     }
 
-    public function setAuthor($author)
+    public function setAuthor(?Author $author): void
     {
         $this->author = $author;
     }
 
-    public function getAuthor()
+    public function getAuthor(): ?Author
     {
         return $this->author;
     }

tests/Gedmo/Loggable/Fixture/Document/Author.php

@@ -12,47 +12,56 @@
 namespace Gedmo\Tests\Loggable\Fixture\Document;
 
 use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+use Doctrine\ODM\MongoDB\Types\Type;
 use Gedmo\Mapping\Annotation as Gedmo;
 
 /**
  * @ODM\EmbeddedDocument
  * @Gedmo\Loggable
  */
+#[ODM\EmbeddedDocument]
+#[Gedmo\Loggable]
 class Author
 {
     /**
+     * @var string|null
      * @Gedmo\Versioned
      * @ODM\Field(type="string")
      */
+    #[ODM\Field(type: Type::STRING)]
+    #[Gedmo\Versioned]
     private $name;
 
     /**
+     * @var string|null
      * @Gedmo\Versioned
      * @ODM\Field(type="string")
      */
+    #[ODM\Field(type: Type::STRING)]
+    #[Gedmo\Versioned]
     private $email;
 
     public function __toString()
     {
-        return $this->getName();
+        return (string) $this->getName();
     }
 
-    public function setName($name)
+    public function setName(?string $name): void
     {
         $this->name = $name;
     }
 
-    public function getName()
+    public function getName(): ?string
     {
         return $this->name;
     }
 
-    public function setEmail($email)
+    public function setEmail(?string $email): void
     {
         $this->email = $email;
     }
 
-    public function getEmail()
+    public function getEmail(): ?string
     {
         return $this->email;
     }