apply sonata-project#1276

krewetka · Jan 15, 2014 · b65818a · b65818a
1 parent 5dde52e
commit b65818a
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 15 deletions.
diff --git a/Admin/BaseFieldDescription.php b/Admin/BaseFieldDescription.php
@@ -33,7 +33,10 @@
  *   - link_parameters (o) : add link parameter to the related Admin class when
  *                           the Admin.generateUrl is called
  *   - code : the method name to retrieve the related value
- *   - associated_tostring : the method to retrieve the "string" representation
+ *   - associated_tostring : (deprecated, use associated_property option)
+ *                           the method to retrieve the "string" representation
+ *                           of the collection element.
+ *   - associated_property : property path to retrieve the "string" representation
  *                           of the collection element.
  *
  * Form Field options :

diff --git a/Tests/Twig/Extension/SonataAdminExtensionTest.php b/Tests/Twig/Extension/SonataAdminExtensionTest.php
@@ -530,10 +530,17 @@ public function testRenderRelationElementNoObject()
 
     public function testRenderRelationElementToString()
     {
-        $this->fieldDescription->expects($this->once())
+        $this->fieldDescription->expects($this->exactly(2))
             ->method('getOption')
-            ->with($this->identicalTo('associated_tostring'))
-            ->will($this->returnValue('__toString'));
+            ->will($this->returnCallback(function($value, $default = null) {
+                if ($value == 'associated_property') {
+                    return $default;
+                }
+
+                if ($value == 'associated_tostring') {
+                    return '__toString';
+                }
+            }));
 
        $element = $this->getMock('stdClass', array('__toString'));
        $element->expects($this->any())
@@ -545,10 +552,18 @@ public function testRenderRelationElementToString()
 
     public function testRenderRelationElementCustomToString()
     {
-        $this->fieldDescription->expects($this->any())
+        $this->fieldDescription->expects($this->exactly(2))
             ->method('getOption')
-            ->with($this->identicalTo('associated_tostring'))
-            ->will($this->returnValue('customToString'));
+            ->will($this->returnCallback(function($value, $default = null) {
+                if ($value == 'associated_property') {
+                    return $default;
+                }
+
+                if ($value == 'associated_tostring') {
+                    return 'customToString';
+                }
+            }));
+
 
        $element = $this->getMock('stdClass', array('customToString'));
        $element->expects($this->any())
@@ -560,24 +575,46 @@ public function testRenderRelationElementCustomToString()
 
     public function testRenderRelationElementMethodNotExist()
     {
-        $this->fieldDescription->expects($this->any())
+        $this->fieldDescription->expects($this->exactly(2))
             ->method('getOption')
-            ->with($this->identicalTo('associated_tostring'))
-            ->will($this->returnValue('nonExistedMethod'));
+
+            ->will($this->returnCallback(function($value, $default = null) {
+                if ($value == 'associated_tostring') {
+                    return 'nonExistedMethod';
+                }
+            }));
 
         $element = new \stdClass();
 
         try {
             $this->twigExtension->renderRelationElement($element, $this->fieldDescription);
         } catch (\RuntimeException $e) {
-            $this->assertContains('You must define an `associated_tostring` option or create a `stdClass::__toString` method to the field option "fd_name" from service "xyz".', $e->getMessage());
+            $this->assertContains('You must define an `associated_property` option or create a `stdClass::__toString', $e->getMessage());
 
             return;
         }
 
         $this->fail('Failed asserting that exception of type "\RuntimeException" is thrown.');
     }
 
+    public function testRenderRelationElementWithPropertyPath()
+    {
+        $this->fieldDescription->expects($this->exactly(1))
+            ->method('getOption')
+
+            ->will($this->returnCallback(function($value, $default = null) {
+                if ($value == 'associated_property') {
+                    return 'foo';
+                }
+            }));
+
+        $element = new \stdClass();
+        $element->foo = "bar";
+
+        $this->assertEquals('bar', $this->twigExtension->renderRelationElement($element, $this->fieldDescription));
+
+    }
+
     public function testGetUrlsafeIdentifier()
     {
         $enitity = new \stdClass();

diff --git a/Twig/Extension/SonataAdminExtension.php b/Twig/Extension/SonataAdminExtension.php
@@ -15,6 +15,7 @@
 use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
 use Sonata\AdminBundle\Exception\NoValueException;
 use Sonata\AdminBundle\Admin\Pool;
+use Symfony\Component\PropertyAccess\PropertyAccess;
 
 class SonataAdminExtension extends \Twig_Extension
 {
@@ -208,13 +209,25 @@ public function renderRelationElement($element, FieldDescriptionInterface $field
             return $element;
         }
 
-        $method = $fieldDescription->getOption('associated_tostring', '__toString');
+        $propertyPath = $fieldDescription->getOption('associated_property');
 
-        if (!method_exists($element, $method)) {
-            throw new \RunTimeException(sprintf('You must define an `associated_tostring` option or create a `%s::__toString` method to the field option "%s" from service "%s".', get_class($element), $fieldDescription->getName(), $fieldDescription->getAdmin()->getCode()));
+        if (null === $propertyPath) {
+            // For BC kept associated_tostring option behavior
+            $method = $fieldDescription->getOption('associated_tostring', '__toString');
+
+            if (!method_exists($element, $method)) {
+                throw new \RuntimeException(sprintf(
+                    'You must define an `associated_property` option or create a `%s::__toString` method to the field option %s from service %s is ',
+                    get_class($element),
+                    $fieldDescription->getName(),
+                    $fieldDescription->getAdmin()->getCode()
+                ));
+            }
+
+            return call_user_func(array($element, $method));
         }
 
-        return call_user_func(array($element, $method));
+        return PropertyAccess::createPropertyAccessor()->getValue($element, $propertyPath);
     }
 
     /**