FormatterXml added

Author: klimov-paul

FormatterXml.php

@@ -0,0 +1,112 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\httpclient;
+
+use DOMDocument;
+use DOMElement;
+use DOMText;
+use SimpleXMLElement;
+use yii\base\Arrayable;
+use yii\base\Object;
+use Yii;
+use yii\helpers\StringHelper;
+
+/**
+ * FormatterXml formats HTTP message as XML.
+ *
+ * @author Paul Klimov <klimov.paul@gmail.com>
+ * @since 2.0
+ */
+class FormatterXml extends Object implements FormatterInterface
+{
+    /**
+     * @var string the Content-Type header for the response
+     */
+    public $contentType = 'application/xml';
+    /**
+     * @var string the XML version
+     */
+    public $version = '1.0';
+    /**
+     * @var string the XML encoding. If not set, it will use the value of [[\yii\base\Application::charset]].
+     */
+    public $encoding;
+    /**
+     * @var string the name of the root element.
+     */
+    public $rootTag = 'request';
+
+
+    /**
+     * @inheritdoc
+     */
+    public function format(Request $request)
+    {
+        $contentType = $this->contentType;
+        $charset = $this->encoding === null ? Yii::$app->charset : $this->encoding;
+        if (stripos($contentType, 'charset') === false) {
+            $contentType .= '; charset=' . $charset;
+        }
+        $request->getHeaders()->set('Content-Type', $contentType);
+
+        $data = $request->getData();
+        if ($data !== null) {
+            if ($data instanceof DOMDocument) {
+                $content = $data->saveXML();
+            } elseif ($data instanceof SimpleXMLElement) {
+                $content = $data->saveXML();
+            } else {
+                $dom = new DOMDocument($this->version, $charset);
+                $root = new DOMElement($this->rootTag);
+                $dom->appendChild($root);
+                $this->buildXml($root, $data);
+                $content = $dom->saveXML();
+            }
+            $request->setContent($content);
+        }
+
+        return $request;
+    }
+
+    /**
+     * @param DOMElement $element
+     * @param mixed $data
+     */
+    protected function buildXml($element, $data)
+    {
+        if (is_object($data)) {
+            $child = new DOMElement(StringHelper::basename(get_class($data)));
+            $element->appendChild($child);
+            if ($data instanceof Arrayable) {
+                $this->buildXml($child, $data->toArray());
+            } else {
+                $array = [];
+                foreach ($data as $name => $value) {
+                    $array[$name] = $value;
+                }
+                $this->buildXml($child, $array);
+            }
+        } elseif (is_array($data)) {
+            foreach ($data as $name => $value) {
+                if (is_int($name) && is_object($value)) {
+                    $this->buildXml($element, $value);
+                } elseif (is_array($value) || is_object($value)) {
+                    $child = new DOMElement(is_int($name) ? $this->itemTag : $name);
+                    $element->appendChild($child);
+                    $this->buildXml($child, $value);
+                } else {
+                    $child = new DOMElement(is_int($name) ? $this->itemTag : $name);
+                    $element->appendChild($child);
+                    $child->appendChild(new DOMText((string) $value));
+                }
+            }
+        } else {
+            $element->appendChild(new DOMText((string) $data));
+        }
+    }
+}

Message.php

@@ -21,7 +21,7 @@
  * @property HeaderCollection|array $headers message headers list.
  * @property CookieCollection|Cookie[]|array $cookies message cookies list.
  * @property string $content message raw content.
- * @property array $data message content data.
+ * @property mixed $data message content data.
  * @property string $format message content format.
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
@@ -47,7 +47,7 @@ class Message extends Object
      */
     private $_content;
     /**
-     * @var array content data
+     * @var mixed content data
      */
     private $_data;
     /**
@@ -198,7 +198,7 @@ public function getContent()
 
     /**
      * Sets the data fields, which composes message content.
-     * @param array $data content data fields.
+     * @param mixed $data content data fields.
      * @return $this self reference.
      */
     public function setData($data)
@@ -209,7 +209,7 @@ public function setData($data)
 
     /**
      * Returns the data fields, parsed from raw content.
-     * @return array|null content data fields.
+     * @return mixed content data fields.
      */
     public function getData()
     {

tests/ClientTest.php

@@ -45,7 +45,7 @@ public function dataProviderDefaultFormatters()
             [Client::FORMAT_JSON, FormatterJson::className()],
             [Client::FORMAT_URLENCODED, FormatterUrlEncoded::className()],
             [Client::FORMAT_RAW_URLENCODED, FormatterUrlEncoded::className()],
-            //[Client::FORMAT_XML, FormatterXml::className()],
+            [Client::FORMAT_XML, FormatterXml::className()],
         ];
     }
 

tests/FormatterXmlTest.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace yiiunit\extensions\httpclient;
+
+use DOMDocument;
+use DOMElement;
+use yii\httpclient\FormatterXml;
+use yii\httpclient\Request;
+
+class FormatterXmlTest extends TestCase
+{
+    protected function setUp()
+    {
+        $this->mockApplication();
+    }
+
+    // Tests :
+
+    public function testFormat()
+    {
+        $request = new Request();
+        $data = [
+            'name1' => 'value1',
+            'name2' => 'value2',
+        ];
+        $request->setData($data);
+
+        $formatter = new FormatterXml();
+        $formatter->format($request);
+        $expectedContent = <<<XML
+<?xml version="1.0" encoding="UTF-8"?>
+<request><name1>value1</name1><name2>value2</name2></request>
+XML;
+        $this->assertEqualsWithoutLE($expectedContent, $request->getContent());
+        $this->assertEquals('application/xml; charset=UTF-8', $request->getHeaders()->get('Content-Type'));
+    }
+
+    /**
+     * @depends testFormat
+     */
+    public function testFormatFromDom()
+    {
+        $request = new Request();
+        $data = new DOMDocument('1.0', 'UTF-8');
+        $root = new DOMElement('root');
+        $data->appendChild($root);
+        $request->setData($data);
+
+        $formatter = new FormatterXml();
+        $formatter->format($request);
+        $expectedContent = <<<XML
+<?xml version="1.0" encoding="UTF-8"?>
+<root/>
+XML;
+        $this->assertEqualsWithoutLE($expectedContent, $request->getContent());
+    }
+
+    /**
+     * @depends testFormat
+     */
+    public function testFormatFromSimpleXml()
+    {
+        $request = new Request();
+
+        $xml = <<<XML
+<?xml version="1.0" encoding="UTF-8"?>
+<request><name1>value1</name1><name2>value2</name2></request>
+XML;
+        $simpleXmlElement = simplexml_load_string($xml);
+        $request->setData($simpleXmlElement);
+
+        $formatter = new FormatterXml();
+        $formatter->format($request);
+        $this->assertEqualsWithoutLE($xml, $request->getContent());
+    }
+}

tests/TestCase.php

@@ -60,4 +60,17 @@ protected function destroyApplication()
         Yii::$app = null;
         Yii::$container = new Container();
     }
+
+    /**
+     * Asserting two strings equality ignoring line endings
+     *
+     * @param string $expected
+     * @param string $actual
+     */
+    public function assertEqualsWithoutLE($expected, $actual)
+    {
+        $expected = str_replace(["\r", "\n"], '', $expected);
+        $actual = str_replace(["\r", "\n"], '', $actual);
+        $this->assertEquals($expected, $actual);
+    }
 }