added encoders

Serializer/Encoder/EncoderInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace JMS\SerializerBundle\Serializer\Encoder;
+
+interface EncoderInterface
+{
+    function encode($data);
+    function decode($data);
+    function supportsEncoding($data);
+    function supportsDecoding($data);
+}

Serializer/Encoder/JsonEncoder.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace JMS\SerializerBundle\Serializer\Encoder;
+
+class JsonEncoder implements EncoderInterface
+{
+    public function encode($data)
+    {
+        return json_encode($data);
+    }
+
+    public function decode($data)
+    {
+        return json_decode($data, true);
+    }
+
+    public function supportsEncoding($data)
+    {
+        return true;
+    }
+
+    public function supportsDecoding($data)
+    {
+        return false;
+    }
+}

Serializer/Encoder/XmlEncoder.php

@@ -0,0 +1,314 @@
+<?php
+
+/*
+ * Portions of this code where received from the Symfony framework under the
+ * MIT license. All other code is Copyright 2011 Johannes M. Schmitt
+ * <schmittjoh@gmail.com> and released under the following license:
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace JMS\SerializerBundle\Serializer\Encoder;
+
+/**
+ * Encodes, and decodes XML data
+ *
+ * @author Jordi Boggiano <j.boggiano@seld.be>
+ * @author John Wards <jwards@whiteoctober.co.uk>
+ * @author Fabian Vogler <fabian@equivalence.ch>
+ */
+class XmlEncoder implements EncoderInterface
+{
+    private $dom;
+    private $version;
+    private $encoding;
+    private $rootNodeName;
+
+    public function __construct($version = '1.0', $encoding = 'utf-8', $rootNodeName = 'response')
+    {
+        $this->version = $version;
+        $this->encoding = $encoding;
+        $this->rootNodeName = $rootNodeName;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function encode($data)
+    {
+        if ($data instanceof \DOMDocument) {
+            $data->encoding = $this->encoding;
+
+            return $data->saveXML();
+        }
+
+        $this->dom = new \DOMDocument($this->version, $this->encoding);
+
+        if (null !== $data && !is_scalar($data)) {
+            $root = $this->dom->createElement($this->rootNodeName);
+            $this->dom->appendChild($root);
+            $this->buildXml($root, $data);
+        } else {
+            $this->appendNode($this->dom, $data, $this->rootNodeName);
+        }
+        return $this->dom->saveXML();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function decode($data)
+    {
+        $xml = simplexml_load_string($data);
+        if (!$xml->count()) {
+            if (!$xml->attributes()) {
+                return (string) $xml;
+            }
+            $data = array();
+            foreach ($xml->attributes() as $attrkey => $attr) {
+                $data['@'.$attrkey] = (string) $attr;
+            }
+            $data['#'] = (string) $xml;
+            return $data;
+        }
+        return $this->parseXml($xml);
+    }
+
+    public function supportsEncoding($data)
+    {
+        return true;
+    }
+
+    public function supportsDecoding($data)
+    {
+        return true;
+    }
+
+    /**
+     * @param DOMNode $node
+     * @param string $val
+     * @return Boolean
+     */
+    final protected function appendXMLString($node, $val)
+    {
+        if (strlen($val) > 0) {
+            $frag = $this->dom->createDocumentFragment();
+            $frag->appendXML($val);
+            $node->appendChild($frag);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param DOMNode $node
+     * @param string $val
+     * @return Boolean
+     */
+    final protected function appendText($node, $val)
+    {
+        $nodeText = $this->dom->createTextNode($val);
+        $node->appendChild($nodeText);
+
+        return true;
+    }
+
+    /**
+     * @param DOMNode $node
+     * @param string $val
+     * @return Boolean
+     */
+    final protected function appendCData($node, $val)
+    {
+        $nodeText = $this->dom->createCDATASection($val);
+        $node->appendChild($nodeText);
+
+        return true;
+    }
+
+    /**
+     * @param DOMNode $node
+     * @param DOMDocumentFragment $fragment
+     * @return Boolean
+     */
+    final protected function appendDocumentFragment($node, $fragment)
+    {
+        if ($fragment instanceof \DOMDocumentFragment) {
+            $node->appendChild($fragment);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Checks the name is a valid xml element name
+     * @param string $name
+     * @return Boolean
+     */
+    final protected function isElementNameValid($name)
+    {
+        return $name &&
+            false === strpos($name, ' ') &&
+            preg_match('#^[\pL_][\pL0-9._-]*$#ui', $name);
+    }
+
+    /**
+     * Parse the input SimpleXmlElement into an array
+     *
+     * @param SimpleXmlElement $node xml to parse
+     * @return array
+     */
+    private function parseXml($node)
+    {
+        $data = array();
+        if ($node->attributes()) {
+            foreach ($node->attributes() as $attrkey => $attr) {
+                $data['@'.$attrkey] = (string) $attr;
+            }
+        }
+        foreach ($node->children() as $key => $subnode) {
+            if ($subnode->count()) {
+                $value = $this->parseXml($subnode);
+            } elseif ($subnode->attributes()) {
+                $value = array();
+                foreach ($subnode->attributes() as $attrkey => $attr) {
+                    $value['@'.$attrkey] = (string) $attr;
+                }
+                $value['#'] = (string) $subnode;
+            } else {
+                $value = (string) $subnode;
+            }
+
+            if ($key === 'item') {
+                if (isset($value['@key'])) {
+                    $data[(string)$value['@key']] = $value['#'];
+                } elseif (isset($data['item'])) {
+                    $tmp = $data['item'];
+                    unset($data['item']);
+                    $data[] = $tmp;
+                    $data[] = $value;
+                }
+            } elseif (key_exists($key, $data)) {
+                if ((false === is_array($data[$key]))  || (false === isset($data[$key][0]))) {
+                    $data[$key] = array($data[$key]);
+                }
+                $data[$key][] = $value;
+            } else {
+                $data[$key] = $value;
+            }
+        }
+        return $data;
+    }
+
+    /**
+     * Parse the data and convert it to DOMElements
+     *
+     * @param DOMNode $parentNode
+     * @param array|object $data data
+     * @return Boolean
+     */
+    private function buildXml($parentNode, $data)
+    {
+        $append = true;
+
+        if (is_array($data) || $data instanceof \Traversable) {
+            foreach ($data as $key => $data) {
+                //Ah this is the magic @ attribute types.
+                if (0 === strpos($key, "@") && is_scalar($data) && $this->isElementNameValid($attributeName = substr($key,1))) {
+                    $parentNode->setAttribute($attributeName, $data);
+                } elseif ($key === '#') {
+                    $append = $this->selectNodeType($parentNode, $data);
+                } elseif (is_array($data) && false === is_numeric($key)) {
+                    /**
+                     * Is this array fully numeric keys?
+                     */
+                    if (ctype_digit(implode('', array_keys($data)))) {
+                        /**
+                         * Create nodes to append to $parentNode based on the $key of this array
+                         * Produces <xml><item>0</item><item>1</item></xml>
+                         * From array("item" => array(0,1));
+                         */
+                        foreach ($data as $subData) {
+                            $append = $this->appendNode($parentNode, $subData, $key);
+                        }
+                    } else {
+                        $append = $this->appendNode($parentNode, $data, $key);
+                    }
+                } elseif (is_numeric($key) || !$this->isElementNameValid($key)) {
+                    $append = $this->appendNode($parentNode, $data, "item", $key);
+                } else {
+                    $append = $this->appendNode($parentNode, $data, $key);
+                }
+            }
+
+            return $append;
+        }
+
+        throw new \UnexpectedValueException('An unexpected value could not be serialized: '.var_export($data, true));
+    }
+
+    /**
+     * Selects the type of node to create and appends it to the parent.
+     *
+     * @param DOMNode      $parentNode
+     * @param array|object $data
+     * @param string       $nodename
+     * @param string       $key
+     * @return void
+     */
+    private function appendNode($parentNode, $data, $nodeName, $key = null)
+    {
+        $node = $this->dom->createElement($nodeName);
+        if (null !== $key) {
+            $node->setAttribute('key', $key);
+        }
+        $appendNode = $this->selectNodeType($node, $data);
+        // we may have decided not to append this node, either in error or if its $nodeName is not valid
+        if ($appendNode) {
+            $parentNode->appendChild($node);
+        }
+        return $appendNode;
+    }
+
+    /**
+     * Tests the value being passed and decide what sort of element to create
+     *
+     * @param DOMNode $node
+     * @param mixed $val
+     * @return Boolean
+     */
+    private function selectNodeType($node, $val)
+    {
+        if (is_array($val)) {
+            return $this->buildXml($node, $val);
+        } elseif ($val instanceof \SimpleXMLElement) {
+            $child = $this->dom->importNode(dom_import_simplexml($val), true);
+            $node->appendChild($child);
+        } elseif ($val instanceof \Traversable) {
+            $this->buildXml($node, $val);
+        } elseif (is_numeric($val)) {
+            return $this->appendText($node, (string) $val);
+        } elseif (is_string($val)) {
+            return $this->appendCData($node, $val);
+        } elseif (is_bool($val)) {
+            return $this->appendText($node, (int) $val);
+        } elseif ($val instanceof \DOMNode) {
+            $child = $this->dom->importNode($val, true);
+            $node->appendChild($child);
+        }
+
+        return true;
+    }
+}