Merge pull request #544 from Simperfit/hotfix/property-to-apiproporty

hotfix: Change @Property annotation to @ApiProperty

Author: dunglas

src/Annotation/Property.php renamed to src/Annotation/ApiProperty.php

@@ -19,7 +19,7 @@
  * @Annotation
  * @Target({"METHOD", "PROPERTY"})
  */
-final class Property
+final class ApiProperty
 {
     /**
      * @var string

src/Metadata/Property/Factory/AnnotationPropertyMetadataFactory.php

@@ -11,7 +11,7 @@
 
 namespace ApiPlatform\Core\Metadata\Property\Factory;
 
-use ApiPlatform\Core\Annotation\Property;
+use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Exception\PropertyNotFoundException;
 use ApiPlatform\Core\Metadata\Property\PropertyMetadata;
 use ApiPlatform\Core\Util\Reflection;
@@ -54,7 +54,7 @@ public function create(string $resourceClass, string $property, array $options =
         }
 
         if ($reflectionClass->hasProperty($property)) {
-            $annotation = $this->reader->getPropertyAnnotation($reflectionClass->getProperty($property), Property::class);
+            $annotation = $this->reader->getPropertyAnnotation($reflectionClass->getProperty($property), ApiProperty::class);
 
             if (null !== $annotation) {
                 return $this->createMetadata($annotation, $parentPropertyMetadata);
@@ -74,7 +74,7 @@ public function create(string $resourceClass, string $property, array $options =
                 continue;
             }
 
-            $annotation = $this->reader->getMethodAnnotation($reflectionMethod, Property::class);
+            $annotation = $this->reader->getMethodAnnotation($reflectionMethod, ApiProperty::class);
             if (null !== $annotation) {
                 return $this->createMetadata($annotation, $parentPropertyMetadata);
             }
@@ -103,7 +103,7 @@ private function handleNotFound(PropertyMetadata $parentPropertyMetadata = null,
         throw new PropertyNotFoundException(sprintf('Property "%s" of class "%s" not found.', $property, $resourceClass));
     }
 
-    private function createMetadata(Property $annotation, PropertyMetadata $parentPropertyMetadata = null) : PropertyMetadata
+    private function createMetadata(ApiProperty $annotation, PropertyMetadata $parentPropertyMetadata = null) : PropertyMetadata
     {
         if (!$parentPropertyMetadata) {
             return new PropertyMetadata(

src/Metadata/Property/Factory/AnnotationPropertyNameCollectionFactory.php

@@ -11,7 +11,7 @@
 
 namespace ApiPlatform\Core\Metadata\Property\Factory;
 
-use ApiPlatform\Core\Annotation\Property;
+use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Exception\ResourceClassNotFoundException;
 use ApiPlatform\Core\Metadata\Property\PropertyNameCollection;
 use ApiPlatform\Core\Util\Reflection;
@@ -62,7 +62,7 @@ public function create(string $resourceClass, array $options = []) : PropertyNam
 
         // Properties
         foreach ($reflectionClass->getProperties() as $reflectionProperty) {
-            if ($this->reader->getPropertyAnnotation($reflectionProperty, Property::class)) {
+            if ($this->reader->getPropertyAnnotation($reflectionProperty, ApiProperty::class)) {
                 $propertyNames[$reflectionProperty->name] = true;
             }
         }
@@ -71,7 +71,7 @@ public function create(string $resourceClass, array $options = []) : PropertyNam
         foreach ($reflectionClass->getMethods(\ReflectionMethod::IS_PUBLIC) as $reflectionMethod) {
             $propertyName = $this->reflection->getProperty($reflectionMethod->name);
 
-            if ($propertyName && $this->reader->getMethodAnnotation($reflectionMethod, Property::class)) {
+            if ($propertyName && $this->reader->getMethodAnnotation($reflectionMethod, ApiProperty::class)) {
                 $propertyNames[$propertyName] = true;
             }
         }

tests/Annotation/PropertyTest.php

@@ -11,7 +11,7 @@
 
 namespace ApiPlatform\Core\Tests\Annotation;
 
-use ApiPlatform\Core\Annotation\Property;
+use ApiPlatform\Core\Annotation\ApiProperty;
 
 /**
  * @author Kévin Dunglas <[email protected]>
@@ -20,7 +20,7 @@ class PropertyTest extends \PHPUnit_Framework_TestCase
 {
     public function testAssignation()
     {
-        $property = new Property();
+        $property = new ApiProperty();
         $property->description = 'description';
         $property->readable = true;
         $property->writable = true;

tests/Fixtures/TestBundle/Entity/AbstractDummy.php

@@ -11,9 +11,9 @@
 
 namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
 
+use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Annotation\ApiResource;
 use ApiPlatform\Core\Annotation\Iri;
-use ApiPlatform\Core\Annotation\Property;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Validator\Constraints as Assert;
 
@@ -44,7 +44,7 @@ abstract class AbstractDummy
      *
      * @ORM\Column
      * @Assert\NotBlank
-     * @Property(iri="http://schema.org/name")
+     * @ApiProperty(iri="http://schema.org/name")
      */
     private $name;
 

tests/Fixtures/TestBundle/Entity/CustomNormalizedDummy.php

@@ -11,8 +11,8 @@
 
 namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
 
+use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Annotation\ApiResource;
-use ApiPlatform\Core\Annotation\Property;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Serializer\Annotation\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -44,7 +44,7 @@ class CustomNormalizedDummy
      *
      * @ORM\Column
      * @Assert\NotBlank
-     * @Property(iri="http://schema.org/name")
+     * @ApiProperty(iri="http://schema.org/name")
      * @Groups({"input", "output"})
      */
     private $name;
@@ -53,7 +53,7 @@ class CustomNormalizedDummy
      * @var string The dummy name alias.
      *
      * @ORM\Column(nullable=true)
-     * @Property(iri="https://schema.org/alternateName")
+     * @ApiProperty(iri="https://schema.org/alternateName")
      * @Groups({"input", "output"})
      */
     private $alias;

tests/Fixtures/TestBundle/Entity/Dummy.php

@@ -11,8 +11,8 @@
 
 namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
 
+use ApiPlatform\Core\Annotation\ApiProperty;
 use ApiPlatform\Core\Annotation\ApiResource;
-use ApiPlatform\Core\Annotation\Property;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Validator\Constraints as Assert;
@@ -41,15 +41,15 @@ class Dummy
      *
      * @ORM\Column
      * @Assert\NotBlank
-     * @Property(iri="http://schema.org/name")
+     * @ApiProperty(iri="http://schema.org/name")
      */
     private $name;
 
     /**
      * @var string The dummy name alias.
      *
      * @ORM\Column(nullable=true)
-     * @Property(iri="https://schema.org/alternateName")
+     * @ApiProperty(iri="https://schema.org/alternateName")
      */
     private $alias;
 
@@ -62,7 +62,7 @@ class Dummy
      * @var string A short description of the item.
      *
      * @ORM\Column(nullable=true)
-     * @Property(iri="https://schema.org/description")
+     * @ApiProperty(iri="https://schema.org/description")
      */
     public $description;