Use a separate attribute for versioned fields

Author: mbabker

doc/annotations.md

@@ -527,11 +527,11 @@ use Gedmo\Mapping\Annotation as Gedmo;
 class Article {}
 ```
 
-#### `@Gedmo\Mapping\Annotation\Versioned`
+#### `@Gedmo\Mapping\Annotation\KeepRevisions`
 
-The `Versioned` annotation is a property annotation used to identify properties whose changes should be logged.
+The `KeepRevisions` annotation is a property annotation used to identify properties whose changes should be logged.
 This annotation can be set for properties with a single value (i.e. a scalar type or an object such as
-`DateTimeInterface`), but not for collections. Versioned fields can be restored to an earlier version.
+`DateTimeInterface`), but not for collections. Fields with revisions can be restored to an earlier version.
 
 Example:
 
@@ -557,13 +557,13 @@ class Comment
 
     /**
      * @ORM\ManyToOne(targetEntity="App\Entity\Article", inversedBy="comments")
-     * @Gedmo\Versioned
+     * @Gedmo\KeepRevisions
      */
     public ?Article $article = null;
 
     /**
      * @ORM\Column(type="string")
-     * @Gedmo\Versioned
+     * @Gedmo\KeepRevisions
      */
     public ?string $body = null;
 }

doc/attributes.md

@@ -470,11 +470,11 @@ use Gedmo\Mapping\Annotation as Gedmo;
 class Article {}
 ```
 
-#### `#[Gedmo\Mapping\Annotation\Versioned]`
+#### `#[Gedmo\Mapping\Annotation\KeepRevisions]`
 
-The `Versioned` attribute is a property attribute used to identify properties whose changes should be logged.
+The `KeepRevisions` attribute is a property attribute used to identify properties whose changes should be logged.
 This attribute can be set for properties with a single value (i.e. a scalar type or an object such as
-`DateTimeInterface`), but not for collections. Versioned fields can be restored to an earlier version.
+`DateTimeInterface`), but not for collections. Fields with revisions can be restored to an earlier version.
 
 Example:
 
@@ -496,11 +496,11 @@ class Comment
     public ?int $id = null;
 
     #[ORM\ManyToOne(targetEntity: Article::class, inversedBy: 'comments')]
-    #[Gedmo\Versioned]
+    #[Gedmo\KeepRevisions]
     public ?Article $article = null;
 
     #[ORM\Column(type: Types::STRING)]
-    #[Gedmo\Versioned]
+    #[Gedmo\KeepRevisions]
     public ?string $body = null;
 }
 ```

doc/revisionable.md

@@ -114,7 +114,7 @@ class Article
     public bool $published = false;
 
     #[ORM\Column(type: Types::STRING)]
-    #[Gedmo\Versioned]
+    #[Gedmo\KeepRevisions]
     public ?string $title = null;
 }
 ```
@@ -134,7 +134,7 @@ class Article
         <field name="published" type="boolean"/>
 
         <field name="title" type="string">
-            <gedmo:versioned/>
+            <gedmo:keep-revisions/>
         </field>
 
         <gedmo:revisionable/>
@@ -174,7 +174,7 @@ class Article
 
     /**
      * @ORM\Column(type="string")
-     * @Gedmo\Versioned
+     * @Gedmo\KeepRevisions
      */
     public ?string $title = null;
 }

schemas/orm/doctrine-extensions-mapping-2-2.xsd

@@ -38,6 +38,7 @@
   <xs:element name="blameable" type="gedmo:blameable"/>
   <xs:element name="ip-traceable" type="gedmo:ip-traceable"/>
   <xs:element name="versioned" type="gedmo:emptyType"/>
+  <xs:element name="keep-revisions" type="gedmo:emptyType"/>
   <xs:element name="tree-left" type="gedmo:emptyType"/>
   <xs:element name="tree-right" type="gedmo:emptyType"/>
   <xs:element name="tree-level" type="gedmo:emptyType"/>

src/Mapping/Annotation/KeepRevisions.php

@@ -0,0 +1,29 @@
+<?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\Mapping\Annotation;
+
+use Doctrine\Common\Annotations\Annotation;
+use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
+
+/**
+ * Versioned annotation for use with the Revisionable extension
+ *
+ * @Annotation
+ *
+ * @NamedArgumentConstructor
+ *
+ * @Target("PROPERTY")
+ *
+ * @author Gediminas Morkevicius <[email protected]>
+ */
+#[\Attribute(\Attribute::TARGET_PROPERTY)]
+final class KeepRevisions implements GedmoAnnotation
+{
+}

src/Mapping/Annotation/Versioned.php

@@ -13,7 +13,7 @@
 use Gedmo\Mapping\Annotation\Annotation as GedmoAnnotation;
 
 /**
- * Versioned annotation for use with the Loggable and Revisionable extensions
+ * Versioned annotation for use with the Loggable extension
  *
  * @Annotation
  *

src/Revisionable/Mapping/Driver/Attribute.php

@@ -13,8 +13,8 @@
 use Doctrine\ORM\Mapping\ClassMetadata as ORMClassMetadata;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Gedmo\Exception\InvalidMappingException;
+use Gedmo\Mapping\Annotation\KeepRevisions;
 use Gedmo\Mapping\Annotation\Revisionable;
-use Gedmo\Mapping\Annotation\Versioned;
 use Gedmo\Mapping\Driver\AbstractAnnotationDriver;
 
 /**
@@ -60,7 +60,7 @@ public function readExtendedMetadata($meta, array &$config)
         foreach ($class->getProperties() as $property) {
             $field = $property->getName();
 
-            if ($this->reader->getPropertyAnnotation($property, Versioned::class)) {
+            if ($this->reader->getPropertyAnnotation($property, KeepRevisions::class)) {
                 if ($meta->isCollectionValuedAssociation($field)) {
                     throw new InvalidMappingException(sprintf('Cannot version field %s::$%s, collection valued associations are not supported.', $meta->getName(), $field));
                 }
@@ -103,7 +103,7 @@ public function readExtendedMetadata($meta, array &$config)
         if (!$meta->isMappedSuperclass && $config) {
             // The revisionable flag must be set, except for embedded models, and the versioned config should be a non-empty array
             if (isset($config['versionedFields']) && !isset($config['revisionable']) && !$this->isEmbed($meta)) {
-                throw new InvalidMappingException(sprintf('Class "%s" has "%s" annotated fields but is missing the "%s" class annotation.', $meta->getName(), Versioned::class, Revisionable::class));
+                throw new InvalidMappingException(sprintf('Class "%s" has "%s" annotated fields but is missing the "%s" class annotation.', $meta->getName(), KeepRevisions::class, Revisionable::class));
             }
         }
 
@@ -121,7 +121,7 @@ public function readExtendedMetadata($meta, array &$config)
     private function inspectEmbeddedForVersioned(string $field, array $config, ORMClassMetadata $meta): array
     {
         foreach ((new \ReflectionClass($meta->embeddedClasses[$field]['class']))->getProperties() as $property) {
-            if ($this->reader->getPropertyAnnotation($property, Versioned::class)) {
+            if ($this->reader->getPropertyAnnotation($property, KeepRevisions::class)) {
                 $embeddedField = $field.'.'.$property->getName();
 
                 if (isset($meta->embeddedClasses[$embeddedField])) {

src/Revisionable/Mapping/Driver/Xml.php

@@ -68,7 +68,7 @@ public function readExtendedMetadata($meta, array &$config)
         if (!$meta->isMappedSuperclass && $config) {
             // The revisionable flag must be set, except for embedded models, and the versioned config should be a non-empty array
             if (isset($config['versionedFields']) && (!$this->isEmbed($meta) && !isset($config['revisionable']))) {
-                throw new InvalidMappingException(sprintf("Class '%s' has fields with the 'gedmo:versioned' element but the class does not have the 'gedmo:revisionable' element.", $meta->getName()));
+                throw new InvalidMappingException(sprintf("Class '%s' has fields with the 'gedmo:keep-revisions' element but the class does not have the 'gedmo:revisionable' element.", $meta->getName()));
             }
         }
 
@@ -127,7 +127,7 @@ private function inspectElementForVersioned(\SimpleXMLElement $element, array $c
         foreach ($element as $mappingDoctrine) {
             $mapping = $mappingDoctrine->children(self::GEDMO_NAMESPACE_URI);
 
-            if (!isset($mapping->versioned)) {
+            if (!isset($mapping->{'keep-revisions'})) {
                 continue;
             }
 

src/Revisionable/Mapping/Driver/Yaml.php

@@ -67,7 +67,7 @@ public function readExtendedMetadata($meta, array &$config)
         if (!$meta->isMappedSuperclass && $config) {
             // The revisionable flag must be set, except for embedded models, and the versioned config should be a non-empty array
             if (isset($config['versionedFields']) && !isset($config['revisionable'])) {
-                throw new InvalidMappingException(sprintf("Class '%s' has fields marked as versioned but the class does not have the 'revisionable' configuration.", $meta->getName()));
+                throw new InvalidMappingException(sprintf("Class '%s' has fields marked with the 'keepRevisions' property but the class does not have the 'revisionable' configuration.", $meta->getName()));
             }
         }
 
@@ -140,7 +140,7 @@ private function inspectConfigurationForVersioned(array $mapping, array $config,
                 continue;
             }
 
-            if (in_array('versioned', $fieldMapping['gedmo'], true)) {
+            if (in_array('keepRevisions', $fieldMapping['gedmo'], true)) {
                 if ($meta->isCollectionValuedAssociation($field)) {
                     throw new InvalidMappingException(sprintf('Cannot version field %s::$%s, collection valued associations are not supported.', $meta->getName(), $field));
                 }

tests/Gedmo/Mapping/Driver/Xml/Gedmo.Tests.Mapping.Fixture.Xml.EmbeddedRevisionable.dcm.xml

@@ -2,7 +2,7 @@
 <doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping" xmlns:gedmo="http://gediminasm.org/schemas/orm/doctrine-extensions-mapping">
     <embeddable name="Gedmo\Tests\Mapping\Fixture\Xml\EmbeddedRevisionable">
         <field name="subtitle" type="string" length="191">
-            <gedmo:versioned/>
+            <gedmo:keep-revisions/>
         </field>
     </embeddable>
 </doctrine-mapping>