feature #625 Use the PropertyAccessor component instead of our custom…

… solution (javiereguiluz)

This PR was squashed before being merged into the master branch (closes #625).

Discussion
----------

Use the PropertyAccessor component instead of our custom solution

Commits
-------

b8d0684 Use the PropertyAccessor component instead of our custom solution

Configuration/Configurator.php

@@ -13,7 +13,6 @@
 
 use Doctrine\ORM\Mapping\ClassMetadata;
 use JavierEguiluz\Bundle\EasyAdminBundle\Reflection\EntityMetadataInspector;
-use JavierEguiluz\Bundle\EasyAdminBundle\Reflection\ClassPropertyReflector;
 
 /**
  * Completes the entities configuration with the information that can only be
@@ -27,7 +26,6 @@ class Configurator
     private $backendConfig = array();
     private $entitiesConfig = array();
     private $inspector;
-    private $reflector;
     private $defaultEntityFields = array();
 
     private $defaultEntityFieldConfiguration = array(
@@ -66,11 +64,10 @@ class Configurator
         'time' => 'time',
     );
 
-    public function __construct(array $backendConfig, EntityMetadataInspector $inspector, ClassPropertyReflector $reflector)
+    public function __construct(array $backendConfig, EntityMetadataInspector $inspector)
     {
         $this->backendConfig = $backendConfig;
         $this->inspector = $inspector;
-        $this->reflector = $reflector;
     }
 
     /**
@@ -122,8 +119,6 @@ public function getEntityConfiguration($entityName)
         $entityConfiguration['new']['fields'] = $this->getFieldsForFormBasedViews('new', $entityConfiguration);
         $entityConfiguration['search']['fields'] = $this->getFieldsForSearchAction($entityConfiguration);
 
-        $entityConfiguration = $this->introspectGettersAndSetters($entityConfiguration);
-
         $entityConfiguration = $this->processFieldTemplates($entityConfiguration);
 
         $this->entitiesConfig[$entityName] = $entityConfiguration;
@@ -441,40 +436,6 @@ private function getFieldFormat($fieldType)
         }
     }
 
-    /**
-     * Introspects the getters and setters for the fields used by all views.
-     * This preprocessing saves a lot of further processing when accessing or
-     * setting the value of the entity properties.
-     *
-     * @param array $entityConfiguration
-     *
-     * @return array
-     */
-    private function introspectGettersAndSetters($entityConfiguration)
-    {
-        foreach (array('new', 'edit', 'list', 'show', 'search') as $view) {
-            $fieldsConfiguration = $entityConfiguration[$view]['fields'];
-
-            foreach ($fieldsConfiguration as $fieldName => $fieldConfiguration) {
-                $getter = $this->reflector->getGetter($entityConfiguration['class'], $fieldName);
-                $fieldConfiguration['getter'] = $getter;
-
-                $setter = $this->reflector->getSetter($entityConfiguration['class'], $fieldName);
-                $fieldConfiguration['setter'] = $setter;
-
-                $isPublic = $this->reflector->isPublic($entityConfiguration['class'], $fieldName);
-                $fieldConfiguration['isPublic'] = $isPublic;
-
-                $fieldConfiguration['isReadable'] = $getter || $isPublic;
-                $fieldConfiguration['isWritable'] = $setter || $isPublic;
-
-                $entityConfiguration[$view]['fields'][$fieldName] = $fieldConfiguration;
-            }
-        }
-
-        return $entityConfiguration;
-    }
-
     /**
      * Determines the template used to render each backend element. This is not
      * trivial because templates can depend on the entity displayed and they

Controller/AdminController.php

@@ -390,11 +390,7 @@ private function updateEntityProperty($entity, $property, $value)
 
         $this->dispatch(EasyAdminEvents::PRE_UPDATE, array('entity' => $entity, 'newValue' => $value));
 
-        if (null !== $setter = $fieldsMetadata[$property]['setter']) {
-            $entity->{$setter}($value);
-        } else {
-            $entity->{$property} = $value;
-        }
+        $this->get('property_accessor')->setValue($entity, $value);
 
         $this->em->persist($entity);
         $this->em->flush();

Resources/config/services.xml

@@ -6,14 +6,14 @@
     <services>
         <service id="easyadmin.twig.extension" class="JavierEguiluz\Bundle\EasyAdminBundle\Twig\EasyAdminTwigExtension" public="false">
             <argument type="service" id="easyadmin.configurator" />
+            <argument type="service" id="property_accessor" />
             <argument>%kernel.debug%</argument>
             <tag name="twig.extension" />
         </service>
 
         <service id="easyadmin.configurator" class="JavierEguiluz\Bundle\EasyAdminBundle\Configuration\Configurator">
             <argument>%easyadmin.config%</argument>
             <argument type="service" id="easyadmin.metadata_inspector" />
-            <argument type="service" id="easyadmin.property_reflector" />
         </service>
 
         <service id="easyadmin.metadata_inspector" class="JavierEguiluz\Bundle\EasyAdminBundle\Reflection\EntityMetadataInspector" public="false">

Tests/Configuration/ConfiguratorTest.php

@@ -21,7 +21,6 @@ class ConfiguratorTest extends CommonPhpUnitTestCase
 {
     private $extension;
     private $inspector;
-    private $reflector;
 
     public function setUp()
     {
@@ -33,9 +32,6 @@ public function setUp()
         $inspectorStub = $this->getMockBuilder('JavierEguiluz\Bundle\EasyAdminBundle\Reflection\EntityMetadataInspector')->disableOriginalConstructor()->getMock();
         $inspectorStub->method('getEntityMetadata')->willReturn($entityMetadataStub);
         $this->inspector = $inspectorStub;
-
-        $reflectorStub = $this->getMockBuilder('JavierEguiluz\Bundle\EasyAdminBundle\Reflection\ClassPropertyReflector')->disableOriginalConstructor()->getMock();
-        $this->reflector = $reflectorStub;
     }
 
     /**
@@ -45,8 +41,10 @@ public function testGetEntityConfiguration($inputFixtureFilepath, $outputFixture
     {
         $backendConfig = Yaml::parse(file_get_contents($inputFixtureFilepath));
         $backendConfig['easy_admin']['entities'] = $this->extension->getEntitiesConfiguration($backendConfig['easy_admin']['entities']);
-        $configurator = new Configurator($backendConfig['easy_admin'], $this->inspector, $this->reflector);
+
+        $configurator = new Configurator($backendConfig['easy_admin'], $this->inspector);
         $configuration = $configurator->getEntityConfiguration('TestEntity');
+
         // Yaml component dumps empty arrays as hashes, fix it to increase configuration readability
         $yamlConfiguration = str_replace('{  }', '[]', Yaml::dump($configuration));
 
@@ -68,7 +66,7 @@ public function provideConfigurationFiles($fixturesDir)
     public function testEmptyConfiguration()
     {
         $backendConfig = array('easy_admin' => null);
-        $configurator = new Configurator($backendConfig, $this->inspector, $this->reflector);
+        $configurator = new Configurator($backendConfig, $this->inspector);
         $configurator->getEntityConfiguration('TestEntity');
     }
 
@@ -79,7 +77,12 @@ public function testEmptyConfiguration()
     public function testAccessingAnUnmanagedEntity()
     {
         $backendConfig = array('easy_admin' => array('entities' => array('AppBundle\\Entity\\TestEntity')));
-        $configurator = new Configurator($backendConfig, $this->inspector, $this->reflector);
+        $configurator = new Configurator($backendConfig, $this->inspector);
         $configurator->getEntityConfiguration('UnmanagedEntity');
     }
 }
+
+
+class TestEntity {
+    // empty class needed for test fixtures
+}

Tests/Configuration/fixtures/input/admin_001.yml

@@ -4,4 +4,4 @@
 # CONFIGURATION
 easy_admin:
     entities:
-        - AppBundle\Entity\TestEntity
+        - JavierEguiluz\Bundle\EasyAdminBundle\Tests\Configuration\TestEntity

Tests/Configuration/fixtures/output/config_001.yml

@@ -1,4 +1,4 @@
-class: AppBundle\Entity\TestEntity
+class: JavierEguiluz\Bundle\EasyAdminBundle\Tests\Configuration\TestEntity
 label: TestEntity
 name: TestEntity
 edit: