Refactoring object formatting in XmlDataResponseFormatter (#50)

devanych · web-flow · commit dff269a5a208 · 2021-06-10T22:54:03.000+03:00
diff --git a/src/Formatter/XmlDataInterface.php b/src/Formatter/XmlDataInterface.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\DataResponse\Formatter;
+
+/**
+ * XmlFormatDataInterface provides methods for formatting objects {@see XmlDataResponseFormatter} as XML data.
+ */
+interface XmlDataInterface
+{
+    /**
+     * Returns a valid XML tag name {@see https://www.w3.org/TR/REC-xml/#NT-NameStartChar}
+     * to use when formatting an object as XML.
+     *
+     * @return string The XML tag name.
+     */
+    public function xmlTagName(): string;
+
+    /**
+     * Returns an array of data to format as XML.
+     *
+     * The data can be any scalar values, instances of `XmlDataInterface`,
+     * and arrays of any nesting consisting of the above values.
+     *
+     * @return array The data to format as XML.
+     */
+    public function xmlData(): array;
+}
diff --git a/src/Formatter/XmlDataResponseFormatter.php b/src/Formatter/XmlDataResponseFormatter.php
@@ -9,10 +9,9 @@
 use DOMException;
 use DOMText;
 use Psr\Http\Message\ResponseInterface;
-use Traversable;
+use RuntimeException;
 use Yiisoft\DataResponse\ResponseContentTrait;
 use Yiisoft\Strings\NumericHelper;
-use Yiisoft\Strings\StringHelper;
 use Yiisoft\DataResponse\DataResponse;
 use Yiisoft\DataResponse\DataResponseFormatterInterface;
 
@@ -21,8 +20,7 @@
 use function is_float;
 use function is_int;
 use function is_object;
-use function iterator_to_array;
-use function strpos;
+use function sprintf;
 
 final class XmlDataResponseFormatter implements DataResponseFormatterInterface
 {
@@ -51,12 +49,6 @@ final class XmlDataResponseFormatter implements DataResponseFormatterInterface
      */
     private string $rootTag = 'response';
 
-    /**
-     * @var bool If true, the object tags will be formed from the class names,
-     * otherwise the {@see DEFAULT_ITEM_TAG_NAME} value will be used.
-     */
-    private bool $useObjectTags = true;
-
     public function format(DataResponse $dataResponse): ResponseInterface
     {
         if ($dataResponse->hasData()) {
@@ -106,21 +98,6 @@ public function withRootTag(string $rootTag): self
         return $new;
     }
 
-    /**
-     * Returns a new instance with the specified value, whether to use class names as tags or not.
-     *
-     * @param bool $useObjectTags If true, the object tags will be formed from the class names,
-     * otherwise the {@see DEFAULT_ITEM_TAG_NAME} value will be used. Default is true.
-     *
-     * @return self
-     */
-    public function withUseObjectTags(bool $useObjectTags): self
-    {
-        $new = clone $this;
-        $new->useObjectTags = $useObjectTags;
-        return $new;
-    }
-
     /**
      * Builds the data to use in XML.
      *
@@ -134,12 +111,11 @@ private function buildXml(DOMDocument $dom, $element, $data): void
             return;
         }
 
-        if (is_array($data) || $data instanceof Traversable) {
-            $data = $data instanceof Traversable ? iterator_to_array($data) : $data;
+        if (is_array($data)) {
             $dataSize = count($data);
 
             foreach ($data as $name => $value) {
-                if (is_int($name) && is_object($value) && !($value instanceof Traversable)) {
+                if (is_int($name) && is_object($value)) {
                     $this->buildObject($dom, $element, $value, $dataSize > 1 ? $name : null);
                     continue;
                 }
@@ -181,25 +157,22 @@ private function buildXml(DOMDocument $dom, $element, $data): void
      */
     private function buildObject(DOMDocument $dom, $element, object $object, int $key = null): void
     {
-        if ($this->useObjectTags) {
-            $class = get_class($object);
-            $class = strpos($class, 'class@anonymous') === false ? StringHelper::baseName($class) : 'AnonymousClass';
+        if (!($object instanceof XmlDataInterface)) {
+            throw new RuntimeException(sprintf(
+                'The "%s" object must implement the "%s" interface.',
+                get_class($object),
+                XmlDataInterface::class,
+            ));
         }
 
-        $child = $this->safeCreateDomElement($dom, $class ?? self::DEFAULT_ITEM_TAG_NAME);
+        $child = $this->safeCreateDomElement($dom, $object->xmlTagName());
 
         if ($key !== null) {
             $child->setAttribute(self::KEY_ATTRIBUTE_NAME, (string) $key);
         }
 
         $element->appendChild($child);
-        $array = [];
-
-        foreach ($object as $property => $value) {
-            $array[$property] = $value;
-        }
-
-        $this->buildXml($dom, $child, $array);
+        $this->buildXml($dom, $child, $object->xmlData());
     }
 
     /**
diff --git a/tests/Formatter/XmlDataResponseFormatterTest.php b/tests/Formatter/XmlDataResponseFormatterTest.php
