Riesenia\Pohoda\AbstractAgenda

Complexity

Total Complexity

45

Size/Duplication

Total Lines	325
Duplicated Lines	0 %

Test Coverage

Coverage

97.94%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	namespace()	0	3	1
D	addElements()	0	65	19
B	addRefElement()	0	27	8
A	getImportRoot()	0	3	1
A	sanitize()	0	11	1
A	appendNode()	0	12	2
A	resolveOptions()	0	11	2
A	setData()	0	6	2
A	getChildKey()	0	6	3
A	createXML()	0	6	1
A	canImportRecursive()	0	3	1
A	__construct()	0	7	1
A	getChildNamespacePrefix()	0	7	3

<?php

/**
 * This file is part of riesenia/pohoda package.
 *
 * Licensed under the MIT License
 * (c) RIESENIA.com
 */

declare(strict_types=1);

namespace Riesenia\Pohoda;

use Riesenia\Pohoda;
use Riesenia\Pohoda\ValueTransformer\ValueTransformerInterface;
use SimpleXMLElement;

/**
 * Base class for Pohoda objects.
 *
 * @method \void setNamespace(string $namespace)
 * @method \void setNodeName(string $nodeName)
 */
abstract class AbstractAgenda
{
    use Pohoda\Common\OneDirectionalVariablesTrait;
    use Pohoda\Common\DirectionAsResponseTrait;

    /** @var array<string, mixed> */
    protected array $data = [];

    /** @var string[] */
    protected array $refElements = [];

    /** @var string[] */
    protected array $directionalRefElements = [];

    /** @var array<string, Common\ElementAttributes> */
    protected array $elementsAttributesMapper = [];

    /** @var Common\OptionsResolver[] */
    private static array $resolvers = [];

    /**
     * Construct agenda using provided data.
     *
     * @param Common\NamespacesPaths $namespacesPaths
     * @param ValueTransformer\SanitizeEncoding $sanitizeEncoding
     * @param string $companyRegistrationNumber
     * @param bool $resolveOptions
     * @param Common\OptionsResolver\Normalizers\NormalizerFactory $normalizerFactory
     */
    public function __construct(
        protected readonly Common\NamespacesPaths $namespacesPaths,
        protected Pohoda\ValueTransformer\SanitizeEncoding $sanitizeEncoding,
        protected readonly string $companyRegistrationNumber,
        protected bool $resolveOptions = true,
        protected Common\OptionsResolver\Normalizers\NormalizerFactory $normalizerFactory = new Common\OptionsResolver\Normalizers\NormalizerFactory(),
    ) {}

    /**
     * Import root
     *
     * string for xml node, null for not existing one
     *
     * @return string|null
     */
    public function getImportRoot(): ?string
    {
        return null;
    }

    /**
     * Can read data recursively
     *
     * @return bool
     */
    public function canImportRecursive(): bool
    {
        return false;
    }

    /**
     * Set & resolve data options
     * Necessary for late setting when there is more options available
     *
     * @param array<string, mixed> $data
     *
     * @return $this
     */
    public function setData(array $data): self
    {
        // resolve options
        $this->data = $this->resolveOptions ? $this->resolveOptions($data) : $data;

        return $this;
    }

    /**
     * Get XML.
     *
     * @return SimpleXMLElement
     */
    abstract public function getXML(): SimpleXMLElement;

    /**
     * Configure options for options resolver.
     *
     * @param Common\OptionsResolver $resolver
     *
     * @return void
     */
    abstract protected function configureOptions(Common\OptionsResolver $resolver): void;

    /**
     * Create XML.
     *
     * @return SimpleXMLElement
     */
    protected function createXML(): SimpleXMLElement
    {
        $np = $this->namespacesPaths->allNamespaces();
        return new SimpleXMLElement('<?xml version="1.0" encoding="' . $this->sanitizeEncoding->getEncoding() . '"?><root ' . \implode(' ', \array_map(function ($k, $v) {
            return 'xmlns:' . $k . '="' . $v . '"';
        }, \array_keys($np), \array_values($np))) . '></root>');
    }

    /**
     * Get namespace.
     *
     * @param string $short
     *
     * @return string
     */
    protected function namespace(string $short): string
    {
        return $this->namespacesPaths->namespace($short);
    }

    /**
     * Add batch elements.
     *
     * @param SimpleXMLElement $xml
     * @param string[]         $elements
     * @param string|null      $namespace
     *
     * @return void
     */
    protected function addElements(SimpleXMLElement $xml, array $elements, ?string $namespace = null): void
    {
        foreach ($elements as $element) {
            if (!isset($this->data[$element])) {
                continue;
            }

            // ref element
            if (\in_array($element, $this->refElements)) {
                $this->addRefElement($xml, ($namespace ? $namespace . ':' : '') . $element, $this->data[$element], $namespace);
                continue;
            }
            if ($this->useOneDirectionalVariables && \in_array($element, $this->directionalRefElements)) {
                $this->addRefElement($xml, ($namespace ? $namespace . ':' : '') . $element, $this->data[$element], $namespace);
                continue;
            }

            // element attribute
            if (isset($this->elementsAttributesMapper[$element])) {
                $attrs = $this->elementsAttributesMapper[$element];

                // get element
                $attrElement = $namespace ? $xml->children($namespace, true)->{$attrs->attrElement} : $xml->{$attrs->attrElement};

                $sanitized = $this->sanitize($this->data[$element]);
                $attrs->attrNamespace ? $attrElement->addAttribute(
                    $attrs->attrNamespace . ':' . $attrs->attrName,
                    $sanitized,
                    $this->namespace($attrs->attrNamespace),
                )
                    : $attrElement->addAttribute($attrs->attrName, $sanitized);

                continue;
            }

            // Agenda object
            if ($this->data[$element] instanceof self) {
                // set namespace
                if ($namespace && \method_exists($this->data[$element], 'setNamespace')) {
                    $this->data[$element]->setNamespace($namespace);
                }

                // set node name
                if (\method_exists($this->data[$element], 'setNodeName')) {
                    $this->data[$element]->setNodeName($element);
                }

                $this->appendNode($xml, $this->data[$element]->getXML());

                continue;
            }

            // array of Agenda objects
            if (\is_array($this->data[$element])) {
                $child = $namespace ? $xml->addChild($namespace . ':' . $element, '', $this->namespace($namespace)) : $xml->addChild($element);

                foreach ($this->data[$element] as $node) {
                    $this->appendNode($child, $node->getXML());
                }

                continue;
            }

            $sanitized = $this->sanitize($this->data[$element]);
            $namespace ? $xml->addChild($namespace . ':' . $element, $sanitized, $this->namespace($namespace)) : $xml->addChild($element, $sanitized);
        }
    }

    /**
     * Add ref element.
     *
     * @param SimpleXMLElement $xml
     * @param string           $name
     * @param mixed            $value
     * @param string|null      $namespace
     *
     * @return SimpleXMLElement
     */
    protected function addRefElement(SimpleXMLElement $xml, string $name, mixed $value, ?string $namespace = null): SimpleXMLElement
    {
        $node = $namespace ? $xml->addChild($name, '', $this->namespace($namespace)) : $xml->addChild($name);

        if (!\is_array($value)) {
            $value = ['ids' => $value];
        }

        foreach ($value as $key => $value1) {
            if (\is_array($value1)) {
                if (array_is_list($value1)) {
                    foreach ($value1 as $value2) {
                        $node->addChild($namespace . ':' . $key, $this->sanitize($value2), $this->namespace(strval($namespace)));
                    }
                } else {
                    $node = $node->addChild($namespace . ':' . $key, '', $this->namespace(strval($namespace)));

                    foreach ($value1 as $key2 => $value2) {
                        $node->addChild('typ:' . $key2, $this->sanitize($value2), $this->namespace('typ'));
                    }
                }
            } else {
                $node->addChild('typ:' . $key, $this->sanitize($value1), $this->namespace('typ'));
            }
        }

        return $node;
    }

    /**
     * Sanitize value to XML.
     *
     * @param mixed $value
     *
     * @return string
     */
    protected function sanitize(mixed $value): string
    {
        $this->sanitizeEncoding->listingWithEncoding();

        return \htmlspecialchars(
            \array_reduce(
                $this->sanitizeEncoding->getListing()->getTransformers(),
                function (string $value, ValueTransformerInterface $transformer): string {
                    return $transformer->transform($value);
                },
                strval($value),
            ),
        );
    }

    /**
     * Append SimpleXMLElement to another SimpleXMLElement.
     *
     * @param SimpleXMLElement $xml
     * @param SimpleXMLElement $node
     *
     * @return void
     */
    protected function appendNode(SimpleXMLElement $xml, SimpleXMLElement $node): void
    {
        $dom = \dom_import_simplexml($xml);
        $dom2 = \dom_import_simplexml($node);

        if (!$dom->ownerDocument) {
            // @codeCoverageIgnoreStart
            throw new \InvalidArgumentException('Invalid XML.');
        }
        // @codeCoverageIgnoreEnd

        $dom->appendChild($dom->ownerDocument->importNode($dom2, true));
    }

    /**
     * Resolve options.
     *
     * @param array<string,mixed> $data
     *
     * @return array<string,mixed>
     */
    protected function resolveOptions(array $data): array
    {
        $class = \get_class($this);
        $opt = '_' . intval($this->useOneDirectionalVariables);

        if (!isset(self::$resolvers[$class . $opt])) {
            self::$resolvers[$class . $opt] = new Common\OptionsResolver();
            $this->configureOptions(self::$resolvers[$class . $opt]);
        }

        return self::$resolvers[$class . $opt]->resolve($data);
    }

    /**
     * Change key in entry to different one in accordance with import root config
     *
     * @param string $defaultKey
     *
     * @return string
     */
    protected function getChildKey(string $defaultKey): string
    {
        if (!empty($this->getImportRoot()) && $this->directionAsResponse) {

Are you sure the usage of $this->getImportRoot() targeting Riesenia\Pohoda\AbstractAgenda::getImportRoot() seems to always return null.

            return $this->getImportRoot();
        }
        return $defaultKey;
    }

    /**
     * Change namespace prefix to different one in accordance with import root config
     *
     * @param string $defaultPrefix
     *
     * @return string
     */
    protected function getChildNamespacePrefix(string $defaultPrefix): string
    {
        if (!empty($this->getImportRoot()) && $this->directionAsResponse) {

Are you sure the usage of $this->getImportRoot() targeting Riesenia\Pohoda\AbstractAgenda::getImportRoot() seems to always return null.

            list($prefix, ) = explode(':', $this->getImportRoot());
            return $prefix;
        }
        return $defaultPrefix;
    }

}