Add annotation -> attribute aliases

Author: wouterj

Annotation/Context.php

@@ -11,63 +11,13 @@
 
 namespace Symfony\Component\Serializer\Annotation;
 
-use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+// do not deprecate in 6.4/7.0, to make it easier for the ecosystem to support 6.4, 7.4 and 8.0 simultaneously
 
-/**
- * Annotation class for @Context().
- *
- * @Annotation
- * @NamedArgumentConstructor
- * @Target({"PROPERTY", "METHOD"})
- *
- * @author Maxime Steinhausser <[email protected]>
- */
-#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
-class Context
-{
-    private array $groups;
-
-    /**
-     * @param string|string[] $groups
-     *
-     * @throws InvalidArgumentException
-     */
-    public function __construct(
-        private readonly array $context = [],
-        private readonly array $normalizationContext = [],
-        private readonly array $denormalizationContext = [],
-        string|array $groups = [],
-    ) {
-        if (!$context && !$normalizationContext && !$denormalizationContext) {
-            throw new InvalidArgumentException(sprintf('At least one of the "context", "normalizationContext", or "denormalizationContext" options must be provided as a non-empty array to "%s".', static::class));
-        }
-
-        $this->groups = (array) $groups;
-
-        foreach ($this->groups as $group) {
-            if (!\is_string($group)) {
-                throw new InvalidArgumentException(sprintf('Parameter "groups" given to "%s" must be a string or an array of strings, "%s" given.', static::class, get_debug_type($group)));
-            }
-        }
-    }
-
-    public function getContext(): array
-    {
-        return $this->context;
-    }
-
-    public function getNormalizationContext(): array
-    {
-        return $this->normalizationContext;
-    }
-
-    public function getDenormalizationContext(): array
-    {
-        return $this->denormalizationContext;
-    }
+class_exists(\Symfony\Component\Serializer\Attribute\Context::class);
 
-    public function getGroups(): array
+if (false) {
+    #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+    class Context
     {
-        return $this->groups;
     }
 }

Annotation/DiscriminatorMap.php

@@ -11,40 +11,11 @@
 
 namespace Symfony\Component\Serializer\Annotation;
 
-use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+class_exists(\Symfony\Component\Serializer\Attribute\DiscriminatorMap::class);
 
-/**
- * Annotation class for @DiscriminatorMap().
- *
- * @Annotation
- * @NamedArgumentConstructor
- * @Target({"CLASS"})
- *
- * @author Samuel Roze <[email protected]>
- */
-#[\Attribute(\Attribute::TARGET_CLASS)]
-class DiscriminatorMap
-{
-    public function __construct(
-        private readonly string $typeProperty,
-        private readonly array $mapping,
-    ) {
-        if (empty($typeProperty)) {
-            throw new InvalidArgumentException(sprintf('Parameter "typeProperty" given to "%s" cannot be empty.', static::class));
-        }
-
-        if (empty($mapping)) {
-            throw new InvalidArgumentException(sprintf('Parameter "mapping" given to "%s" cannot be empty.', static::class));
-        }
-    }
-
-    public function getTypeProperty(): string
-    {
-        return $this->typeProperty;
-    }
-
-    public function getMapping(): array
+if (false) {
+    #[\Attribute(\Attribute::TARGET_CLASS)]
+    class DiscriminatorMap
     {
-        return $this->mapping;
     }
 }

Annotation/Groups.php

@@ -11,48 +11,11 @@
 
 namespace Symfony\Component\Serializer\Annotation;
 
-use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+class_exists(\Symfony\Component\Serializer\Attribute\Groups::class);
 
-/**
- * Annotation class for @Groups().
- *
- * @Annotation
- * @NamedArgumentConstructor
- * @Target({"PROPERTY", "METHOD", "CLASS"})
- *
- * @author Kévin Dunglas <[email protected]>
- */
-#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY | \Attribute::TARGET_CLASS)]
-class Groups
-{
-    /**
-     * @var string[]
-     */
-    private readonly array $groups;
-
-    /**
-     * @param string|string[] $groups
-     */
-    public function __construct(string|array $groups)
-    {
-        $this->groups = (array) $groups;
-
-        if (!$this->groups) {
-            throw new InvalidArgumentException(sprintf('Parameter given to "%s" cannot be empty.', static::class));
-        }
-
-        foreach ($this->groups as $group) {
-            if (!\is_string($group) || '' === $group) {
-                throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a string or an array of non-empty strings.', static::class));
-            }
-        }
-    }
-
-    /**
-     * @return string[]
-     */
-    public function getGroups(): array
+if (false) {
+    #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY | \Attribute::TARGET_CLASS)]
+    class Groups
     {
-        return $this->groups;
     }
 }

Annotation/Ignore.php

@@ -11,15 +11,11 @@
 
 namespace Symfony\Component\Serializer\Annotation;
 
-/**
- * Annotation class for @Ignore().
- *
- * @Annotation
- * @Target({"PROPERTY", "METHOD"})
- *
- * @author Kévin Dunglas <[email protected]>
- */
-#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class Ignore
-{
+class_exists(\Symfony\Component\Serializer\Attribute\Ignore::class);
+
+if (false) {
+    #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
+    final class Ignore
+    {
+    }
 }

Annotation/MaxDepth.php

@@ -11,32 +11,11 @@
 
 namespace Symfony\Component\Serializer\Annotation;
 
-use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+class_exists(\Symfony\Component\Serializer\Attribute\MaxDepth::class);
 
-/**
- * Annotation class for @MaxDepth().
- *
- * @Annotation
- * @NamedArgumentConstructor
- * @Target({"PROPERTY", "METHOD"})
- *
- * @author Kévin Dunglas <[email protected]>
- */
-#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-class MaxDepth
-{
-    public function __construct(private readonly int $maxDepth)
-    {
-        if ($maxDepth <= 0) {
-            throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a positive integer.', static::class));
-        }
-    }
-
-    /**
-     * @return int
-     */
-    public function getMaxDepth()
+if (false) {
+    #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
+    class MaxDepth
     {
-        return $this->maxDepth;
     }
 }

Annotation/SerializedName.php

@@ -11,29 +11,11 @@
 
 namespace Symfony\Component\Serializer\Annotation;
 
-use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+class_exists(\Symfony\Component\Serializer\Attribute\SerializedName::class);
 
-/**
- * Annotation class for @SerializedName().
- *
- * @Annotation
- * @NamedArgumentConstructor
- * @Target({"PROPERTY", "METHOD"})
- *
- * @author Fabien Bourigault <[email protected]>
- */
-#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class SerializedName
-{
-    public function __construct(private readonly string $serializedName)
-    {
-        if ('' === $serializedName) {
-            throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a non-empty string.', self::class));
-        }
-    }
-
-    public function getSerializedName(): string
+if (false) {
+    #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
+    final class SerializedName
     {
-        return $this->serializedName;
     }
 }

Annotation/SerializedPath.php

@@ -11,35 +11,11 @@
 
 namespace Symfony\Component\Serializer\Annotation;
 
-use Symfony\Component\PropertyAccess\Exception\InvalidPropertyPathException;
-use Symfony\Component\PropertyAccess\PropertyPath;
-use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+class_exists(\Symfony\Component\Serializer\Attribute\SerializedPath::class);
 
-/**
- * Annotation class for @SerializedPath().
- *
- * @Annotation
- * @NamedArgumentConstructor
- * @Target({"PROPERTY", "METHOD"})
- *
- * @author Tobias Bönner <[email protected]>
- */
-#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
-final class SerializedPath
-{
-    private PropertyPath $serializedPath;
-
-    public function __construct(string $serializedPath)
-    {
-        try {
-            $this->serializedPath = new PropertyPath($serializedPath);
-        } catch (InvalidPropertyPathException $pathException) {
-            throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a valid property path.', self::class));
-        }
-    }
-
-    public function getSerializedPath(): PropertyPath
+if (false) {
+    #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
+    final class SerializedPath
     {
-        return $this->serializedPath;
     }
 }

Attribute/Context.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Serializer\Attribute;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * Annotation class for @Context().
+ *
+ * @Annotation
+ * @NamedArgumentConstructor
+ * @Target({"PROPERTY", "METHOD"})
+ *
+ * @author Maxime Steinhausser <[email protected]>
+ */
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+class Context
+{
+    private array $groups;
+
+    /**
+     * @param string|string[] $groups
+     *
+     * @throws InvalidArgumentException
+     */
+    public function __construct(
+        private readonly array $context = [],
+        private readonly array $normalizationContext = [],
+        private readonly array $denormalizationContext = [],
+        string|array $groups = [],
+    ) {
+        if (!$context && !$normalizationContext && !$denormalizationContext) {
+            throw new InvalidArgumentException(sprintf('At least one of the "context", "normalizationContext", or "denormalizationContext" options must be provided as a non-empty array to "%s".', static::class));
+        }
+
+        $this->groups = (array) $groups;
+
+        foreach ($this->groups as $group) {
+            if (!\is_string($group)) {
+                throw new InvalidArgumentException(sprintf('Parameter "groups" given to "%s" must be a string or an array of strings, "%s" given.', static::class, get_debug_type($group)));
+            }
+        }
+    }
+
+    public function getContext(): array
+    {
+        return $this->context;
+    }
+
+    public function getNormalizationContext(): array
+    {
+        return $this->normalizationContext;
+    }
+
+    public function getDenormalizationContext(): array
+    {
+        return $this->denormalizationContext;
+    }
+
+    public function getGroups(): array
+    {
+        return $this->groups;
+    }
+}
+
+if (!class_exists(\Symfony\Component\Serializer\Annotation\Context::class, false)) {
+    class_alias(Context::class, \Symfony\Component\Serializer\Annotation\Context::class);
+}