Added support for using the keys of an array as XML tag.

[Spea]

As discussed in #59 this PR adds the possibility to use the keys of an array as XML tags.

Example:

Currently I only check for numeric keys to avoid problems with naming convention. But when a key looks like "1_foo" an exception is thrown. Possible solutions could be:

• Catch the DOMException and set the tag name back to "entry"
• Use PCRE to check if the key is a valid tag name

What do you think?

[schmittjoh]

What does the Symfony Serializer do here? Can we mirror its behavior for this case? // cc @Seldaek

[Spea]

The symfony seralizer basically uses PCRE to check if an element name is valid -> https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php#L196

[Seldaek]

Great stuff, thanks

[Spea]

@schmittjoh I guess this is a yes from @Seldaek ;) Will adjust it sometime today.

[Spea]

Updated

[schmittjoh]

I think we can use private here as the class is not designed for extending.

[schmittjoh]

How about renaming @XmlArray to @XmlKeyValuePairs?

[Spea]

Yeah sure, @XmlKeyValuePairs makes it more clear what the annoation is used to do. I'll refactor this

[Spea]

Before I forget it. Right now the tag name entry will be used when the tag name is invalid, should I add a key attribute in this case so the key can still be accessed? Another option would be, to make this choosable by the user via an option in the annoataion

[schmittjoh]

Wouldn't an exception be more appropriate as this seems like something that a developer would want to fix, no?

[Spea]

I'm not sure about this, an Exception seems a little bit too "hard" for me, but on the other hand the developer could also be confused when he used an invalid tag name and he can't find it in the generated output.

[Seldaek]

I don't think an exception is appropriate at all. As I said on #59 (comment) - if it is user data that you can't control, it just might break everything in production, which is much worse than just "losing" one key IMO.

[Spea]

Good point, I will keep it as it is right now.

[Spea]

Refactored annotation name and slightly updated doc.

[schmittjoh]

This should be

.. note ::

    When a key ...

to be formatted correctly on the website.

[Spea]

Fixed. Do you want me to squash the commits?

[schmittjoh]

There must be a blank line before and after the .. note :: line.

[schmittjoh]

Yeah, please squash them.

[Spea]

Squashed and fixed.

[schmittjoh]

Thanks, merged!

[schmittjoh]

btw, can you add support for this to the XML and YAML metadata drivers as well?

[Spea]

Sure, will add them tomorrow.

[naroga]

This PR is merged, but using jms/serializer-bundle still gives me <entry>...</entry> instead of the array keys.

Am I doing something wrong? My array is also dinamically generated from user data, and I cannot use objects.

[MConrotte]

+1 Idem to naroga, in xml I have always ... instead of the array keys.