Added method annotation for virtual properties

symfony · lrlopez · Mar 4, 2016 · Mar 6, 2016 · Mar 16, 2016 · Mar 17, 2016
commit e46df9834db8811660ba22cac18bffe9929e1c36
diff --git a/src/Symfony/Component/PropertyAccess/Annotation/Adder.php b/src/Symfony/Component/PropertyAccess/Annotation/Adder.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyAccess\Annotation;
+
+/**
+ * Property accessor adder configuration annotation.
+ *
+ * @Annotation
+ * @Target({"METHOD"})
+ *
+ * @author Luis Ramón López <lrlopez@gmail.com>
+ */
+class Adder
+{
+    /**
+     * Associates this method to the setter of this property.
+     *
+     * @var string
+     */
+    public $property;
+}
diff --git a/src/Symfony/Component/PropertyAccess/Annotation/Getter.php b/src/Symfony/Component/PropertyAccess/Annotation/Getter.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyAccess\Annotation;
+
+/**
+ * Property accessor getter configuration annotation.
+ *
+ * @Annotation
+ * @Target({"METHOD"})
+ *
+ * @author Luis Ramón López <lrlopez@gmail.com>
+ */
+class Getter
+{
+    /**
+     * Associates this method to the getter of this property.
+     *
+     * @var string
+     */
+    public $property;
+}
diff --git a/src/Symfony/Component/PropertyAccess/Annotation/Remover.php b/src/Symfony/Component/PropertyAccess/Annotation/Remover.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyAccess\Annotation;
+
+/**
+ * Property accessor remover configuration annotation.
+ *
+ * @Annotation
+ * @Target({"METHOD"})
+ *
+ * @author Luis Ramón López <lrlopez@gmail.com>
+ */
+class Remover
+{
+    /**
+     * Associates this method to the setter of this property.
+     *
+     * @var string
+     */
+    public $property;
+}
diff --git a/src/Symfony/Component/PropertyAccess/Annotation/Setter.php b/src/Symfony/Component/PropertyAccess/Annotation/Setter.php
@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\PropertyAccess\Annotation;
+
+/**
+ * Property accessor setter configuration annotation.
+ *
+ * @Annotation
+ * @Target({"METHOD"})
+ *
+ * @author Luis Ramón López <lrlopez@gmail.com>
+ */
+class Setter
+{
+    /**
+     * Associates this method to the setter of this property.
+     *
+     * @var string
+     */
+    public $property;
+}
diff --git a/src/Symfony/Component/PropertyAccess/Mapping/Loader/AnnotationLoader.php b/src/Symfony/Component/PropertyAccess/Mapping/Loader/AnnotationLoader.php
@@ -12,7 +12,11 @@
 namespace Symfony\Component\PropertyAccess\Mapping\Loader;

 use Doctrine\Common\Annotations\Reader;
+use Symfony\Component\PropertyAccess\Annotation\Adder;
+use Symfony\Component\PropertyAccess\Annotation\Getter;
 use Symfony\Component\PropertyAccess\Annotation\Property;
+use Symfony\Component\PropertyAccess\Annotation\Remover;
+use Symfony\Component\PropertyAccess\Annotation\Setter;
 use Symfony\Component\PropertyAccess\Mapping\PropertyMetadata;
 use Symfony\Component\PropertyAccess\Mapping\ClassMetadata;

@@ -68,6 +72,44 @@ public function loadClassMetadata(ClassMetadata $classMetadata)
            }
        }

+        foreach ($reflectionClass->getMethods() as $method) {
+            if ($method->getDeclaringClass()->name === $className) {
+
+                foreach ($this->reader->getMethodAnnotations($method) as $annotation) {
+                    if ($annotation instanceof Getter) {
+                        if (!isset($propertiesMetadata[$annotation->property])) {
+                            $propertiesMetadata[$annotation->property] = new PropertyMetadata($annotation->property);
+                            $classMetadata->addPropertyMetadata($propertiesMetadata[$annotation->property]);
+                        }
+                        $propertiesMetadata[$annotation->property]->setGetter($method->getName());
+                    }
+                    if ($annotation instanceof Setter) {
+                        if (!isset($propertiesMetadata[$annotation->property])) {
+                            $propertiesMetadata[$annotation->property] = new PropertyMetadata($annotation->property);
+                            $classMetadata->addPropertyMetadata($propertiesMetadata[$annotation->property]);
+                        }
+                        $propertiesMetadata[$annotation->property]->setSetter($method->getName());
+                    }
+                    if ($annotation instanceof Adder) {
+                        if (!isset($propertiesMetadata[$annotation->property])) {
+                            $propertiesMetadata[$annotation->property] = new PropertyMetadata($annotation->property);
+                            $classMetadata->addPropertyMetadata($propertiesMetadata[$annotation->property]);
+                        }
+                        $propertiesMetadata[$annotation->property]->setAdder($method->getName());
+                    }
+                    if ($annotation instanceof Remover) {
+                        if (!isset($propertiesMetadata[$annotation->property])) {
+                            $propertiesMetadata[$annotation->property] = new PropertyMetadata($annotation->property);
+                            $classMetadata->addPropertyMetadata($propertiesMetadata[$annotation->property]);
+                        }
+                        $propertiesMetadata[$annotation->property]->setRemover($method->getName());
+                    }
+
+                    $loaded = true;
+                }
+            }
+        }
+
        return $loaded;
    }
 }
diff --git a/src/Symfony/Component/PropertyAccess/PropertyAccessor.php b/src/Symfony/Component/PropertyAccess/PropertyAccessor.php
@@ -562,7 +562,7 @@ private function getReadAccessInfo($class, $property)
        $hasProperty = $reflClass->hasProperty($property);
        $access[self::ACCESS_HAS_PROPERTY] = $hasProperty;

-        if ($hasProperty && $this->classMetadataFactory) {
+        if ($this->classMetadataFactory) {
            $metadata = $this->classMetadataFactory->getMetadataFor($class)->getPropertiesMetadata();
            $metadata = isset($metadata[$property]) ? $metadata[$property] : null;
        }
@@ -753,7 +753,7 @@ private function getWriteAccessInfo($class, $property, $value)
        $transversable = is_array($value) || $value instanceof \Traversable;
        $done = false;

-        if ($hasProperty && $this->classMetadataFactory) {
+        if ($this->classMetadataFactory) {
            $metadata = $this->classMetadataFactory->getMetadataFor($class)->getPropertiesMetadata();
            $metadata = isset($metadata[$property]) ? $metadata[$property] : null;


diff --git a/src/Symfony/Component/PropertyAccess/Tests/Fixtures/TestClass.php b/src/Symfony/Component/PropertyAccess/Tests/Fixtures/TestClass.php
@@ -12,6 +12,8 @@
 namespace Symfony\Component\PropertyAccess\Tests\Fixtures;

 use Symfony\Component\PropertyAccess\Annotation\Property;
+use Symfony\Component\PropertyAccess\Annotation\Getter;
+use Symfony\Component\PropertyAccess\Annotation\Setter;

 class TestClass
 {
@@ -29,12 +31,14 @@ class TestClass
    private $publicGetter;
    private $date;

+    private $quantity;
+
    /**
     * @Property(getter="customGetterTest", setter="customSetterTest")
     */
    private $customGetterSetter;

-    public function __construct($value)
+    public function __construct($value, $quantity = 2, $pricePerUnit = 10)
    {
        $this->publicProperty = $value;
        $this->publicAccessor = $value;
@@ -47,6 +51,8 @@ public function __construct($value)
        $this->publicHasAccessor = $value;
        $this->publicGetter = $value;
        $this->customGetterSetter = $value;
+        $this->quantity = $quantity;
+        $this->pricePerUnit = $pricePerUnit;
    }

    public function setPublicAccessor($value)
@@ -201,4 +207,30 @@ public function customSetterTest($value)
    {
        $this->customGetterSetter = $value;
    }
+
+    /**
+     * @return int
+     */
+    public function getQuantity()
+    {
+        return $this->quantity;
+    }
+
+    /**
+     * @Getter(property="total")
+     */
+    public function getTotal()
+    {
+        return $this->quantity * $this->pricePerUnit;
+    }
+
+    /**
+     * @Setter(property="total")
+     *
+     * @param mixed $total
+     */
+    public function setTotal($total)
+    {
+        $this->quantity = $total / $this->pricePerUnit;
+    }
 }
diff --git a/src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorCollectionTest.php b/src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorCollectionTest.php
@@ -13,6 +13,9 @@

 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Common\Annotations\AnnotationRegistry;
+use Symfony\Component\PropertyAccess\Annotation\Adder;
+use Symfony\Component\PropertyAccess\Annotation\Getter;
+use Symfony\Component\PropertyAccess\Annotation\Remover;
 use Symfony\Component\PropertyAccess\Mapping\Factory\ClassMetadataFactory;
 use Symfony\Component\PropertyAccess\Mapping\Loader\AnnotationLoader;
 use Symfony\Component\PropertyAccess\PropertyAccessor;
@@ -39,6 +42,10 @@ public function addAxis($axis)
    }

    // In the test, use a name that StringUtil can't uniquely singularify
+    /**
+     * @Adder(property="customVirtualAxes")
+     * @param $axis
+     */
    public function addAxisTest($axis)
    {
        $this->customAxes[] = $axis;
@@ -55,6 +62,10 @@ public function removeAxis($axis)
        }
    }

+    /**
+     * @Remover(property="customVirtualAxes")
+     * @param $axis
+     */
    public function removeAxisTest($axis)
    {
        foreach ($this->customAxes as $key => $value) {
@@ -71,6 +82,10 @@ public function getAxes()
        return $this->axes;
    }

+    /**
+     * @Getter(property="customVirtualAxes")
+     * @return null
+     */
    public function getCustomAxes()
    {
        return $this->customAxes;
@@ -202,6 +217,28 @@ public function testSetValueCallsCustomAdderAndRemoverForCollections()
        $this->assertEquals($axesMergedCopy, $axesMerged);
    }

+    public function testSetValueCallsCustomAdderAndRemoverForCollectionsMethodAnnotation()
+    {
+        $axesBefore = $this->getContainer(array(1 => 'second', 3 => 'fourth', 4 => 'fifth'));
+        $axesMerged = $this->getContainer(array(1 => 'first', 2 => 'second', 3 => 'third'));
+        $axesAfter = $this->getContainer(array(1 => 'second', 5 => 'first', 6 => 'third'));
+        $axesMergedCopy = is_object($axesMerged) ? clone $axesMerged : $axesMerged;
+
+        // Don't use a mock in order to test whether the collections are
+        // modified while iterating them
+        $car = new PropertyAccessorCollectionTest_Car($axesBefore);
+
+        AnnotationRegistry::registerAutoloadNamespace('Symfony\Component\PropertyAccess\Annotation', __DIR__.'/../../../..');
+        $this->propertyAccessor = new PropertyAccessor(false, false, new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())));
+
+        $this->propertyAccessor->setValue($car, 'customVirtualAxes', $axesMerged);
+
+        $this->assertEquals($axesAfter, $car->getCustomAxes());
+
+        // The passed collection was not modified
+        $this->assertEquals($axesMergedCopy, $axesMerged);
+    }
+
    /**
     * @expectedException \Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException
     * @expectedExceptionMessage Neither the property "axes" nor one of the methods "addAx()"/"removeAx()", "addAxe()"/"removeAxe()", "addAxis()"/"removeAxis()", "setAxes()", "axes()", "__set()" or "__call()" exist and have public access in class "Mock_PropertyAccessorCollectionTest_CarNoAdderAndRemover

diff --git a/src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorTest.php b/src/Symfony/Component/PropertyAccess/Tests/PropertyAccessorTest.php
@@ -209,6 +209,13 @@ public function testGetWithCustomGetter()
        $this->assertSame('webmozart', $this->propertyAccessor->getValue(new TestClass('webmozart'), 'customGetterSetter'));
    }

+    public function testGetWithCustomGetterMethodAnnotation()
+    {
+        AnnotationRegistry::registerAutoloadNamespace('Symfony\Component\PropertyAccess\Annotation', __DIR__.'/../../../..');
+        $this->propertyAccessor = new PropertyAccessor(false, false, new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())));
+        $this->assertSame(200, $this->propertyAccessor->getValue(new TestClass('webmozart', 10, 20), 'total'));
+    }
+
    /**
     * @dataProvider getValidPropertyPaths
     */
@@ -321,6 +328,18 @@ public function testSetValueWithCustomSetter()
        $this->assertEquals('it works!', $custom->customGetterTest());
    }

+    public function testSetValueWithCustomSetterMethodAnnotation()
+    {
+        AnnotationRegistry::registerAutoloadNamespace('Symfony\Component\PropertyAccess\Annotation', __DIR__.'/../../../..');
+        $this->propertyAccessor = new PropertyAccessor(false, false, new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())));
+
+        $custom = new TestClass('webmozart', 10, 20);
+
+        $this->propertyAccessor->setValue($custom, 'total', 5);
+
+        $this->assertEquals(5, $custom->getTotal());
+    }
+
    public function testGetValueWhenArrayValueIsNull()
    {
        $this->propertyAccessor = new PropertyAccessor(false, true);
-Original file line number
+Diff line change
@@ -0,0 +1,30 @@
+    <?php
+    /*
+     * This file is part of the Symfony package.
+     *
+     * (c) Fabien Potencier <fabien@symfony.com>
+     *
+     * For the full copyright and license information, please view the LICENSE
+     * file that was distributed with this source code.
+     */
+    namespace Symfony\Component\PropertyAccess\Annotation;
+    /**
+     * Property accessor adder configuration annotation.
+     *
+     * @Annotation
+     * @Target({"METHOD"})
+     *
+     * @author Luis Ramón López <lrlopez@gmail.com>
+     */
+    class Adder
             Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            webmozart
  

      

      

      


        Apr 1, 2016


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      I think this should be named PropertyAdder for more clarity.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            webmozart
  

      

      

      


        Apr 1, 2016


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Btw you should make it possible to omit property when using the annotation:
/**
 * @PropertyAdder("fields")
 */
public function addFieldToList($field)
{
    // ...
}
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  Author


  

  
    
      

      
            lrlopez
  

      

      

      


        Apr 1, 2016


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Nice catch. I didn't add the Property prefix as there was a property used as a parameter. Changing the annotation name it has sense to allow it be omitted.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  Author


  

  
    
      

      
            lrlopez
  

      

      

      


        Apr 1, 2016


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Hmmm... I've doing some experiments. If you omit property in the parameter still works because by default it assigns its value to the first public field in the annotation class. So, no code changes are needed. If we add another parameter, we just have to make sure it is not the first one in the class.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
+    {
+        /**
+         * Associates this method to the setter of this property.
+         *
+         * @var string
+         */
+        public $property;
+    }