Consolidation\OutputFormatters\StructuredData\Xml\XmlSchema

Complexity

Total Complexity

21

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	1	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
A	arrayToXML()	0	7	1
A	addXmlData()	0	10	2
A	addXmlChildren()	0	6	2
A	addXmlDataOrAttribute()	0	10	4
A	getTopLevelElementName()	0	4	1
A	getDefaultElementName()	0	8	2
A	isAttribute()	0	7	3
A	inElementList()	0	7	2
A	singularForm()	0	6	2
A	isAssoc()	0	4	1

<?php

namespace Consolidation\OutputFormatters\StructuredData\Xml;

class XmlSchema implements XmlSchemaInterface
{
    protected $elementList;

    public function __construct($elementList = [])
    {
        $defaultElementList =
        [
            '*' => ['description'],
        ];
        $this->elementList = array_merge_recursive($elementList, $defaultElementList);
    }

    public function arrayToXML($structuredData)
    {
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $topLevelElement = $this->getTopLevelElementName($structuredData);
        $this->addXmlData($dom, $dom, $topLevelElement, $structuredData);
        return $dom;
    }

    protected function addXmlData(\DOMDocument $dom, $xmlParent, $elementName, $structuredData)
    {
        $element = $dom->createElement($elementName);
        $xmlParent->appendChild($element);
        if (!is_array($structuredData)) {
            $element->appendChild($dom->createTextNode($structuredData));
            return;
        }
        $this->addXmlChildren($dom, $element, $elementName, $structuredData);
    }

    protected function addXmlChildren(\DOMDocument $dom, $xmlParent, $elementName, $structuredData)
    {
        foreach ($structuredData as $key => $value) {
            $this->addXmlDataOrAttribute($dom, $xmlParent, $elementName, $key, $value);
        }
    }

    protected function addXmlDataOrAttribute(\DOMDocument $dom, $xmlParent, $elementName, $key, $value)
    {
        $childElementName = $this->getDefaultElementName($elementName);
        $elementName = is_numeric($key) ? $childElementName : $key;
        if (($elementName != $childElementName) && $this->isAttribute($elementName, $key, $value)) {
            $xmlParent->setAttribute($key, $value);
            return;
        }
        $this->addXmlData($dom, $xmlParent, $elementName, $value);
    }

    protected function getTopLevelElementName($structuredData)

The parameter $structuredData is not used and could be removed.

    {
        return 'document';
    }

    protected function getDefaultElementName($parentElementName)
    {
        $singularName = $this->singularForm($parentElementName);
        if (isset($singularName)) {
            return $singularName;
        }
        return 'item';
    }

    protected function isAttribute($parentElementName, $elementName, $value)
    {
        if (!is_string($value)) {
            return false;
        }
        return !$this->inElementList($parentElementName, $elementName) && !$this->inElementList('*', $elementName);
    }

    protected function inElementList($parentElementName, $elementName)
    {
        if (!array_key_exists($parentElementName, $this->elementList)) {
            return false;
        }
        return in_array($elementName, $this->elementList[$parentElementName]);
    }

    protected function singularForm($name)
    {
        if (substr($name, strlen($name) - 1) == "s") {
            return substr($name, 0, strlen($name) - 1);
        }
    }

    protected function isAssoc($data)
    {
        return array_keys($data) == range(0, count($data));
    }
}