Added annotations and MetadataAwareNormalizer

symfony · Nyholm · Jul 15, 2016 · Jul 17, 2016 · Jul 17, 2016 · Jul 17, 2016
commit 489a8d8079d8bee72ee0c45dc572628f959a2776
diff --git a/src/Symfony/Component/Serializer/Annotation/Accessor.php b/src/Symfony/Component/Serializer/Annotation/Accessor.php
@@ -0,0 +1,65 @@
+<?php
+
+namespace Symfony\Component\Serializer\Annotation;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY"})
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class Accessor
+{
+    /**
+     * @var string
+     */
+    private $getter;
+    /**
+     * @var string
+     */
+    private $setter;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+            if (empty($data)) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', get_class($this)));
+        }
+
+        foreach (array('getter', 'setter') as $parameter) {
+            if (!isset($data[$parameter]) || !$data[$parameter]) {
+                continue;
+            }
+
+            if (!is_string($data[$parameter])) {
+                throw new InvalidArgumentException(sprintf('Parameter "%s" of annotation "%s" must be a string.', $parameter, get_class($this)));
+            }
+
+            $this->$parameter = $data[$parameter];
+        }
+
+        if (null === $this->getter && null === $this->setter) {
+            throw new InvalidArgumentException(sprintf('Either option "getter" or "setter" must be given for annotation %s', get_class($this)));
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getGetter()
+    {
+        return $this->getter;
+    }
+
+    /**
+     * @return string
+     */
+    public function getSetter()
+    {
+        return $this->setter;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Annotation/Exclude.php b/src/Symfony/Component/Serializer/Annotation/Exclude.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Symfony\Component\Serializer\Annotation;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY"})
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class Exclude
+{
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data = array())
+    {
+        if (!empty($data)) {
+            throw new InvalidArgumentException(sprintf('No parameter is allowed for annotation "%s".', get_class($this)));
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    public function getValue()
+    {
+        return true;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Annotation/ExclusionPolicy.php b/src/Symfony/Component/Serializer/Annotation/ExclusionPolicy.php
@@ -0,0 +1,50 @@
+<?php
+
+namespace Symfony\Component\Serializer\Annotation;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * @Annotation
+ * @Target({"CLASS"})
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class ExclusionPolicy
+{
+    const NONE = 'NONE';
+    const ALL = 'ALL';
+
+    /**
+     * @var string
+     */
+    private $policy;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+        if (!isset($data['value']) || !$data['value']) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', get_class($this)));
+        }
+
+        if (!is_string($data['value'])) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a string.', get_class($this)));
+        }
+
+        $this->policy = strtoupper($data['value']);
+
+        if (self::NONE !== $this->policy && self::ALL !== $this->policy) {
+            throw new InvalidArgumentException('Exclusion policy must either be "ALL", or "NONE".');
+        }
+    }
+
+    /**
+     * @return string
+     */
+    public function getPolicy()
+    {
+        return $this->policy;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Annotation/Expose.php b/src/Symfony/Component/Serializer/Annotation/Expose.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace Symfony\Component\Serializer\Annotation;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY", "METHOD"})
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class Expose
+{
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data = array())
+    {
+        if (!empty($data)) {
+            throw new InvalidArgumentException(sprintf('No parameter is allowed for annotation "%s".', get_class($this)));
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    public function getValue()
+    {
+        return true;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Annotation/MaxDepth.php b/src/Symfony/Component/Serializer/Annotation/MaxDepth.php
@@ -28,6 +28,9 @@ class MaxDepth
      */
     private $maxDepth;
 
+    /**
+     * @param array $data
+     */
     public function __construct(array $data)
     {
         if (!isset($data['value'])) {
@@ -41,6 +44,9 @@ public function __construct(array $data)
         $this->maxDepth = $data['value'];
     }
 
+    /**
+     * @return int
+     */
     public function getMaxDepth()
     {
         return $this->maxDepth;

diff --git a/src/Symfony/Component/Serializer/Annotation/ReadOnly.php b/src/Symfony/Component/Serializer/Annotation/ReadOnly.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace Symfony\Component\Serializer\Annotation;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY", "CLASS"})
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class ReadOnly
+{
+    /**
+     * @var bool
+     */
+    private $readOnly;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data = array())
+    {
+        if (empty($data) || !isset($data['value'])) {
+            $this->readOnly = true;
+            return;
+        }
+
+        if (!is_bool($data['value'])) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a boolean.', get_class($this)));
+        }
+
+        $this->readOnly = $data['value'];
+    }
+
+    /**
+     * @return bool
+     */
+    public function getReadOnly()
+    {
+        return $this->readOnly;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Annotation/SerializedName.php b/src/Symfony/Component/Serializer/Annotation/SerializedName.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace Symfony\Component\Serializer\Annotation;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY", "METHOD"})
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class SerializedName
+{
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+        if (!isset($data['value']) || !$data['value']) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', get_class($this)));
+        }
+
+        if (!is_string($data['value'])) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a string.', get_class($this)));
+        }
+
+        $this->name = $data['value'];
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+}
diff --git a/src/Symfony/Component/Serializer/Annotation/Type.php b/src/Symfony/Component/Serializer/Annotation/Type.php
@@ -0,0 +1,52 @@
+<?php
+
+namespace Symfony\Component\Serializer\Annotation;
+
+use Symfony\Component\Serializer\Exception\InvalidArgumentException;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY"})
+ *
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+final class Type
+{
+    /**
+     * @var string
+     */
+    private $type;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+        if (!isset($data['value']) || !$data['value']) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', get_class($this)));
+        }
+
+        if (!is_string($data['value'])) {
+            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a string.', get_class($this)));
+        }
+
+        $type = $data['value'];
+
+        if (false !== $pos = strpos($type, '\\')) {
+            // This is a referencet to a class
+            if ($pos !== 0) {
+                throw new InvalidArgumentException(sprintf('When referring to an class you you must begin the type with backslash (\\) you provided "%s" for annotation "%s".', $type, get_class($this)));
+            }
+        }
+
+        $this->type = $data['value'];
+    }
+
+    /**
+     * @return string
+     */
+    public function getType()
+    {
+        return $this->type;
+    }
+}