Allow using @XmlValue together with @Accessor/@AccessType

[localheinz]

Q	A
Bug report?	no
Feature request?	yes
BC Break report?	no
RFC?	no

Steps required to reproduce the problem

1. Use jms/serializer:1.5.0.

2. Have XML which cannot be controlled

<foo bar="40" baz="20">
                    
    https://placekitten.com/200/300
</foo>

3. Have class

<?php

use JMS\Serializer\Annotation as JMS;

class Foo
{
    /**
     * @JMS\Accessor(
     *     getter="getUrl",
     *     setter="setUrl"
     * )
     * @JMS\Type("string")
     * @JMS\XmlValue
     *
     * @var string|null
     */
    private $url;

    public function setUrl(string $url): void
    {
        $this->url = trim($url);
    }

    public function getUrl(): ?string
    {
        return $this->url;
    }
}

4. Deserialize XML into object

$foo = $serializer->deserialize(
    $xml,
    Foo::class,
    'xml'
);

var_dump($foo->getUrl());

Expected Result

string(31) "https://placekitten.com/200/300"

Actual Result

string(58) "

    https://placekitten.com/200/300
"

💡 It's of course possible to solve this using something like

diff --git a/Foo.php b/Foo.php
index f4afea402..7329e3bf2 100644
--- a/backend/Foo.php
+++ b/backend/Foo.php
@@ -25,4 +25,16 @@ class Foo
     {
         return $this->url;
     }
+
+    /**
+     * @JMS\PostDeserialize
+     */
+    public function trimUrl(): void
+    {
+        if (!\is_string($this->url)) {
+            return;
+        }
+
+        $this->url = \trim($this->url);
+    }
 }

but I think it would be nice not having to add another method for this.

What do you think?

[goetas]

Well, in XML all those spaces have a meaning, so trimming them would be a HUGE bc break, and also not compliant to XML specs

[goetas]

adding an option @XmlValue(trim=true) could be an acceptable solution

[localheinz]

@goetas

I'm not asking to trim the values, I'm wondering whether it would be possible to use the @JMS\XmlValue annotation together with @JMS\Accessor or @JMS\AccessType - then modifications can be made in userland code.

[goetas]

So you are saying that @JMS\XmlValue can not be used with @JMS\Accessor? If is to, to me sounds more like a bug than a feature request.... Can you submit a failing test case?

[localheinz]

Looks like this is already covered by tests:

• serializer/tests/Serializer/XmlSerializationTest.php

  Lines 73 to 92 in cb3e167

  	public function testAccessorSetterDeserialization()
  	{
  	/** @var AccessorSetter $object */
  	$object = $this->deserialize(
  	'<?xml version="1.0"?>
  	<AccessorSetter>
  	<element attribute="attribute">element</element>
  	<collection>
  	<entry>collectionEntry</entry>
  	</collection>
  	</AccessorSetter>',
  	'JMS\Serializer\Tests\Fixtures\AccessorSetter'
  	);
  	self::assertInstanceOf('stdClass', $object->getElement());
  	self::assertInstanceOf('JMS\Serializer\Tests\Fixtures\AccessorSetterElement', $object->getElement()->element);
  	self::assertEquals('attribute-different', $object->getElement()->element->getAttribute());
  	self::assertEquals('element-different', $object->getElement()->element->getElement());
  	self::assertEquals(['collectionEntry' => 'collectionEntry'], $object->getCollection());
  	}

• serializer/tests/Fixtures/AccessorSetter.php

  Lines 73 to 80 in cb3e167

  	/**
  	* @Serializer\Type("string")
  	* @Serializer\Accessor(setter="setElementDifferent")
  	* @Serializer\XmlValue
  	*
  	* @var string
  	*/
  	protected $element;

I'll take another look, closing for now!

[localheinz]

Works like a charm, not sure what I was doing wrong!

[goetas]

👍