yiisoft / yii-web

src/Data/Formatter/XmlDataResponseFormatter.php

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Web\Data\Formatter;

use DOMDocument;
use DOMElement;
use DOMException;
use DOMText;
use Psr\Http\Message\ResponseInterface;
use Yiisoft\Http\Header;
use Yiisoft\Strings\StringHelper;
use Yiisoft\Yii\Web\Data\DataResponse;
use Yiisoft\Yii\Web\Data\DataResponseFormatterInterface;

final class XmlDataResponseFormatter implements DataResponseFormatterInterface
{
    /**
     * @var string the Content-Type header for the response
     */
    private string $contentType = 'application/xml';
    /**
     * @var string the XML version
     */
    private string $version = '1.0';
    /**
     * @var string the XML encoding.
     */
    private string $encoding = 'UTF-8';
    /**
     * @var string the name of the root element. If set to false, null or is empty then no root tag should be added.
     */
    private string $rootTag = 'response';
    /**
     * @var string the name of the elements that represent the array elements with numeric keys.
     */
    private string $itemTag = 'item';
    /**
     * @var bool whether to interpret objects implementing the [[\Traversable]] interface as arrays.
     * Defaults to `true`.
     */
    private bool $useTraversableAsArray = true;
    /**
     * @var bool if object tags should be added
     */
    private bool $useObjectTags = true;

    public function format(DataResponse $dataResponse): ResponseInterface
    {
        $content = '';
        $data = $dataResponse->getData();
        if ($data !== null) {
            $dom = new DOMDocument($this->version, $this->encoding);
            if (!empty($this->rootTag)) {
                $root = new DOMElement($this->rootTag);

The call to DOMElement::__construct() has too few arguments starting with value.

                $dom->appendChild($root);
                $this->buildXml($root, $data);
            } else {
                $this->buildXml($dom, $data);

$dom of type DOMDocument is incompatible with the type DOMElement expected by parameter $element of Yiisoft\Yii\Web\Data\Formatter\XmlDataResponseFormatter::buildXml().

            }
            $content = $dom->saveXML();
        }
        $response = $dataResponse->getResponse();
        $response->getBody()->write($content);

        return $response->withHeader(Header::CONTENT_TYPE, $this->contentType . '; ' . $this->encoding);
    }

    public function withVersion(string $version): self
    {
        $formatter = clone $this;
        $formatter->version = $version;
        return $formatter;
    }

    public function withEncoding(string $encoding): self
    {
        $formatter = clone $this;
        $formatter->encoding = $encoding;
        return $formatter;
    }

    public function withRootTag(string $rootTag): self
    {
        $formatter = clone $this;
        $formatter->rootTag = $rootTag;
        return $formatter;
    }

    public function withItemTag(string $itemTag): self
    {
        $formatter = clone $this;
        $formatter->itemTag = $itemTag;
        return $formatter;
    }

    public function withUseTraversableAsArray(bool $useTraversableAsArray): self
    {
        $formatter = clone $this;
        $formatter->useTraversableAsArray = $useTraversableAsArray;
        return $formatter;
    }

    public function withUseObjectTags(bool $useObjectTags): self
    {
        $formatter = clone $this;
        $formatter->useObjectTags = $useObjectTags;
        return $formatter;
    }

    public function withContentType(string $contentType): self
    {
        $formatter = clone $this;
        $formatter->contentType = $contentType;
        return $formatter;
    }

    /**
     * @param DOMElement $element
     * @param mixed $data
     */
    private function buildXml($element, $data): void
    {
        if (is_array($data) ||
            ($this->useTraversableAsArray && $data instanceof \Traversable)
        ) {
            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($this->getValidXmlElementName($name));

The call to DOMElement::__construct() has too few arguments starting with value.

                    $element->appendChild($child);
                    $this->buildXml($child, $value);
                } else {
                    $child = new DOMElement($this->getValidXmlElementName($name));
                    $element->appendChild($child);
                    $child->appendChild(new DOMText($this->formatScalarValue($value)));
                }
            }
        } elseif (is_object($data)) {
            if ($this->useObjectTags) {
                $child = new DOMElement(StringHelper::basename(get_class($data)));
                $element->appendChild($child);
            } else {
                $child = $element;
            }
            $array = [];
            foreach ($data as $name => $value) {
                $array[$name] = $value;
            }
            $this->buildXml($child, $array);
        } else {
            $element->appendChild(new DOMText($this->formatScalarValue($data)));
        }
    }

    /**
     * Formats scalar value to use in XML text node.
     *
     * @param int|string|bool|float $value a scalar value.
     * @return string string representation of the value.
     */
    private function formatScalarValue($value): string
    {
        if ($value === true) {
            return 'true';
        }
        if ($value === false) {
            return 'false';
        }
        if (is_float($value)) {
            return StringHelper::floatToString($value);
        }
        return (string)$value;
    }

    /**
     * Returns element name ready to be used in DOMElement if
     * name is not empty, is not int and is valid.
     *
     * Falls back to [[itemTag]] otherwise.
     *
     * @param mixed $name
     * @return string
     */
    private function getValidXmlElementName($name): string
    {
        if (empty($name) || is_int($name) || !$this->isValidXmlName($name)) {
            return $this->itemTag;
        }

        return $name;
    }

    /**
     * Checks if name is valid to be used in XML.
     *
     * @param mixed $name
     * @return bool
     * @see http://stackoverflow.com/questions/2519845/how-to-check-if-string-is-a-valid-xml-element-name/2519943#2519943
     */
    private function isValidXmlName($name): bool
    {
        try {
            new DOMElement($name);

The call to DOMElement::__construct() has too few arguments starting with value.

        } catch (DOMException $e) {
            return false;
        }
        return true;
    }
}