ReadOnly -> ReadOnlyAnnotation

jean-gui · Dec 6, 2023 · e8cba6f · e8cba6f
1 parent ba908d2
commit e8cba6f
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 16 deletions.
diff --git a/doc/reference/annotations.rst b/doc/reference/annotations.rst
@@ -271,8 +271,8 @@ should be inlined.
 objects with this annotation. Also, AccessorOrder will be using the name of the property
 to determine the order.
 
-@ReadOnly
-~~~~~~~~~
+@ReadOnlyAnnotation
+~~~~~~~~~~~~~~~~~~~
 This annotation can be defined on a property to indicate that the data of the property
 is read only and cannot be set during deserialization.
 

diff --git a/src/JMS/Serializer/Annotation/ReadOnly.php → ...ializer/Annotation/ReadOnlyAnnotation.php b/src/JMS/Serializer/Annotation/ReadOnly.php → ...ializer/Annotation/ReadOnlyAnnotation.php
@@ -6,7 +6,7 @@
  * @Annotation
  * @Target({"CLASS","PROPERTY"})
  */
-final class ReadOnly
+final class ReadOnlyAnnotation
 {
     /**
      * @var boolean

diff --git a/src/JMS/Serializer/Metadata/Driver/AnnotationDriver.php b/src/JMS/Serializer/Metadata/Driver/AnnotationDriver.php
@@ -18,7 +18,7 @@
 use JMS\Serializer\Annotation\PostDeserialize;
 use JMS\Serializer\Annotation\PostSerialize;
 use JMS\Serializer\Annotation\PreSerialize;
-use JMS\Serializer\Annotation\ReadOnly;
+use JMS\Serializer\Annotation\ReadOnlyAnnotation;
 use JMS\Serializer\Annotation\SerializedName;
 use JMS\Serializer\Annotation\Since;
 use JMS\Serializer\Annotation\SkipWhenEmpty;
@@ -77,7 +77,7 @@ public function loadMetadataForClass(\ReflectionClass $class)
                 $excludeAll = true;
             } elseif ($annot instanceof AccessType) {
                 $classAccessType = $annot->type;
-            } elseif ($annot instanceof ReadOnly) {
+            } elseif ($annot instanceof ReadOnlyAnnotation) {
                 $readOnlyClass = true;
             } elseif ($annot instanceof AccessorOrder) {
                 $classMetadata->setAccessorOrder($annot->order, $annot->custom);
@@ -196,7 +196,7 @@ public function loadMetadataForClass(\ReflectionClass $class)
                         $propertyMetadata->xmlElementCData = $annot->cdata;
                     } elseif ($annot instanceof AccessType) {
                         $accessType = $annot->type;
-                    } elseif ($annot instanceof ReadOnly) {
+                    } elseif ($annot instanceof ReadOnlyAnnotation) {
                         $propertyMetadata->readOnly = $annot->readOnly;
                     } elseif ($annot instanceof Accessor) {
                         $accessor = array($annot->getter, $annot->setter);

diff --git a/tests/Fixtures/AuthorReadOnly.php b/tests/Fixtures/AuthorReadOnly.php
@@ -3,7 +3,7 @@
 namespace JMS\Serializer\Tests\Fixtures;
 
 use JMS\Serializer\Annotation\Accessor;
-use JMS\Serializer\Annotation\ReadOnly;
+use JMS\Serializer\Annotation\ReadOnlyAnnotation;
 use JMS\Serializer\Annotation\SerializedName;
 use JMS\Serializer\Annotation\Type;
 use JMS\Serializer\Annotation\XmlRoot;
@@ -12,7 +12,7 @@
 class AuthorReadOnly
 {
     /**
-     * @ReadOnly
+     * @ReadOnlyAnnotation
      * @SerializedName("id")
      */
     private $id;

diff --git a/tests/Fixtures/AuthorReadOnlyPerClass.php b/tests/Fixtures/AuthorReadOnlyPerClass.php
@@ -3,19 +3,19 @@
 namespace JMS\Serializer\Tests\Fixtures;
 
 use JMS\Serializer\Annotation\Accessor;
-use JMS\Serializer\Annotation\ReadOnly;
+use JMS\Serializer\Annotation\ReadOnlyAnnotation;
 use JMS\Serializer\Annotation\SerializedName;
 use JMS\Serializer\Annotation\Type;
 use JMS\Serializer\Annotation\XmlRoot;
 
 /**
  * @XmlRoot("author")
- * @ReadOnly
+ * @ReadOnlyAnnotation
  */
 class AuthorReadOnlyPerClass
 {
     /**
-     * @ReadOnly
+     * @ReadOnlyAnnotation
      * @SerializedName("id")
      */
     private $id;
@@ -24,7 +24,7 @@ class AuthorReadOnlyPerClass
      * @Type("string")
      * @SerializedName("full_name")
      * @Accessor("getName")
-     * @ReadOnly(false)
+     * @ReadOnlyAnnotation(false)
      */
     private $name;
 

diff --git a/tests/Fixtures/ExcludePublicAccessor.php b/tests/Fixtures/ExcludePublicAccessor.php
@@ -4,14 +4,14 @@
 
 use JMS\Serializer\Annotation\AccessType;
 use JMS\Serializer\Annotation\Exclude;
-use JMS\Serializer\Annotation\ReadOnly;
+use JMS\Serializer\Annotation\ReadOnlyAnnotation;
 
 /**
  */
 
 /**
  * @AccessType("public_method")
- * @ReadOnly
+ * @ReadOnlyAnnotation
  */
 class ExcludePublicAccessor
 {

diff --git a/tests/Fixtures/GetSetObject.php b/tests/Fixtures/GetSetObject.php
@@ -4,7 +4,7 @@
 
 use JMS\Serializer\Annotation\AccessType;
 use JMS\Serializer\Annotation\Exclude;
-use JMS\Serializer\Annotation\ReadOnly;
+use JMS\Serializer\Annotation\ReadOnlyAnnotation;
 use JMS\Serializer\Annotation\Type;
 
 /** @AccessType("public_method") */
@@ -17,7 +17,7 @@ class GetSetObject
     private $name = 'Foo';
 
     /**
-     * @ReadOnly
+     * @ReadOnlyAnnotation
      */
     private $readOnlyProperty = 42;