XmlParserService::setAliases() - Code Metrics - Inspection of "Fix Services directory name case" - Horat1us/php-xml-convertible - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ea6553...a25652 )

by Alexander

created 2017-05-11 15:07 UTC

XmlParserService::setAliases() A

↳ Parent: XmlParserService

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	8
cts	8
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	8
nc	1
nop	1
crap	1

<?php

namespace Horat1us\Services;


use Horat1us\Arrays\Collection;
use Horat1us\XmlAliasKey;
use Horat1us\XmlConvertibleInterface;
use Horat1us\XmlConvertibleObject;

/**
 * Class XmlParserService
 * @package Horat1us\Services
 */
class XmlParserService
{
    /**
     * @var \DOMElement
     */
    protected $element;

    /**
     * @var XmlConvertibleInterface[]
     */
    protected $aliases;

    /**
     * XmlParserService constructor.
     * @param $document
     * @param array $aliases
     */
    public function __construct($document, array $aliases = [])
    {
        $this
            ->setAliases($aliases)
            ->setDocument($document);
    }

    public function __clone()
    {
        $this->element = clone $this->element;
    }

    /**
     * @return XmlConvertibleInterface
     */
    public function convert()
    {
        /** @var XmlConvertibleInterface $nodeObject */
        $nodeObject = Collection::from($this->aliases)
            ->reduce(function (XmlConvertibleInterface $carry, XmlConvertibleInterface $alias, string $key) {
                return $this->getIsAliasMatch($key, $alias) ? clone $alias : $carry;
            }, new XmlConvertibleObject($this->element->nodeName));

        if ($this->element->hasChildNodes()) {
            $this->convertChildren($nodeObject);
        }
        if ($this->element->hasAttributes()) {
            $this->convertAttributes($nodeObject);
        }

        return $nodeObject;
    }

    /**
     * @param XmlConvertibleInterface $object
     * @return $this
     */
    public function convertChildren(XmlConvertibleInterface &$object)
    {
        $children = [];
        $service = clone $this;

        foreach ($this->element->childNodes as $childNode) {
            $service->setDocument($childNode);
            $children[] = $service->convert();
        }
        $object->setXmlChildren($children);

        return $this;
    }

    public function convertAttributes(XmlConvertibleInterface &$object)
    {
        $properties = $object->getXmlProperties();
        /** @var \DOMAttr $attribute */
        foreach ($this->element->attributes as $attribute) {
            if (
                !$object instanceof XmlConvertibleObject
                && !in_array($attribute->name, $properties)
            ) {
                throw new \UnexpectedValueException(
                    get_class($object) . ' must have defined ' . $attribute->name . ' XML property',
                    4
                );
            }
            $object->{$attribute->name} = $attribute->value;
        }
    }

    /**
     * @param \DOMNode|\DOMDocument $document
     * @return $this
     */
    public function setDocument($document)
    {
        if ($document instanceof \DOMDocument) {
            return $this->setDocument($document->firstChild);
        }

        if (!$document instanceof \DOMNode) {
            throw new \InvalidArgumentException("Document must be instance of DOMElement or DOMNode");
        }
        $this->element = $document;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}

        return $this;
    }

    /**
     * @return \DOMElement
     */
    public function getDocument()
    {
        return $this->element;
    }

    /**
     * @param XmlConvertibleInterface[]|string $aliases
     * @return $this
     */
    public function setAliases(array $aliases = [])
    {
        $this->aliases = [];

        Collection::from($aliases)
            ->map(function ($alias) {
                return $this->mapAlias($alias);
            })
            ->forEach(function (XmlConvertibleInterface $alias, string $key) {
                $this->aliases[$this->mapKey($key, $alias)] = $alias;
            });

        return $this;
    }

    /**
     * @return XmlConvertibleInterface[]
     */
    public function getAliases()
    {
        return $this->aliases;
    }

    /**
     * @param string|XmlConvertibleInterface $element
     * @return XmlConvertibleInterface
     */
    protected function mapAlias($element)
    {
        if ($element instanceof XmlConvertibleInterface) {
            return $element;
        }
        if (!is_string($element)) {
            throw new \UnexpectedValueException(
                "All aliases must be instance or class implements " . XmlConvertibleInterface::class
            );
        }

        // Additional type-checking
        return $this->mapAlias(new $element);
    }

    /**
     * @param string|integer $key
     * @param XmlConvertibleInterface $element
     * @return string
     */
    protected function mapKey($key, XmlConvertibleInterface $element): string
    {
        return is_numeric($key)
            ? $element->getXmlElementName()
            : $key;
    }

    /**
     * @param string $key
     * @param XmlConvertibleInterface $element
     * @return bool
     */
    protected function getIsAliasMatch(string $key, XmlConvertibleInterface $element): bool
    {
        if ($this->element->nodeName !== $key) {
            return false;
        }

        return Collection::from($element->getXmlProperties())
            ->filter(function ($property) use ($element) {
                return empty($element->{$property});
            })
            ->reduce(function (bool $carry, $property) use ($element) {
                return $carry && $this->element->attributes->getNamedItem($property) != $element->{$property};
            }, true);
    }
}

1		<?php
2
3		namespace Horat1us\Services;
4
5
6		use Horat1us\Arrays\Collection;
7		use Horat1us\XmlAliasKey;
8		use Horat1us\XmlConvertibleInterface;
9		use Horat1us\XmlConvertibleObject;
10
11		/**
12		* Class XmlParserService
13		* @package Horat1us\Services
14		*/
15		class XmlParserService
16		{
17		/**
18		* @var \DOMElement
19		*/
20		protected $element;
21
22		/**
23		* @var XmlConvertibleInterface[]
24		*/
25		protected $aliases;
26
27		/**
28		* XmlParserService constructor.
29		* @param $document
30		* @param array $aliases
31		*/
32	12	public function __construct($document, array $aliases = [])
33		{
34		$this
35	12	->setAliases($aliases)
36	9	->setDocument($document);
37	9	}
38
39	8	public function __clone()
40		{
41	8	$this->element = clone $this->element;
42	8	}
43
44		/**
45		* @return XmlConvertibleInterface
46		*/
47	9	public function convert()
48		{
49		/** @var XmlConvertibleInterface $nodeObject */
50	9	$nodeObject = Collection::from($this->aliases)
51		->reduce(function (XmlConvertibleInterface $carry, XmlConvertibleInterface $alias, string $key) {
52	9	return $this->getIsAliasMatch($key, $alias) ? clone $alias : $carry;
53	9	}, new XmlConvertibleObject($this->element->nodeName));
54
55	9	if ($this->element->hasChildNodes()) {
56	8	$this->convertChildren($nodeObject);
57		}
58	9	if ($this->element->hasAttributes()) {
59	9	$this->convertAttributes($nodeObject);
60		}
61
62	9	return $nodeObject;
63		}
64
65		/**
66		* @param XmlConvertibleInterface $object
67		* @return $this
68		*/
69	8	public function convertChildren(XmlConvertibleInterface &$object)
70		{
71	8	$children = [];
72	8	$service = clone $this;
73
74	8	foreach ($this->element->childNodes as $childNode) {
75	8	$service->setDocument($childNode);
76	8	$children[] = $service->convert();
77		}
78	8	$object->setXmlChildren($children);
79
80	8	return $this;
81		}
82
83	9	public function convertAttributes(XmlConvertibleInterface &$object)
84		{
85	9	$properties = $object->getXmlProperties();
86		/** @var \DOMAttr $attribute */
87	9	foreach ($this->element->attributes as $attribute) {
88		if (
89	9	!$object instanceof XmlConvertibleObject
90	9	&& !in_array($attribute->name, $properties)
91		) {
92	1	throw new \UnexpectedValueException(
93	1	get_class($object) . ' must have defined ' . $attribute->name . ' XML property',
94	1	4
95		);
96		}
97	9	$object->{$attribute->name} = $attribute->value;
98		}
99	9	}
100
101		/**
102		* @param \DOMNode\|\DOMDocument $document
103		* @return $this
104		*/
105	9	public function setDocument($document)
106		{
107	9	if ($document instanceof \DOMDocument) {
108	7	return $this->setDocument($document->firstChild);
109		}
110
111	9	if (!$document instanceof \DOMNode) {
112		throw new \InvalidArgumentException("Document must be instance of DOMElement or DOMNode");
113		}
114	9	$this->element = $document;
		0 ignored issues – show Documentation Bug introduced 2017-05-11 15:10 UTC by Report Bug Copy Issue Report `$document` is of type `object<DOMNode>`, but the property `$element` was declared to be of type `object<DOMElement>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
115
116	9	return $this;
117		}
118
119		/**
120		* @return \DOMElement
121		*/
122		public function getDocument()
123		{
124		return $this->element;
125		}
126
127		/**
128		* @param XmlConvertibleInterface[]\|string $aliases
129		* @return $this
130		*/
131	12	public function setAliases(array $aliases = [])
132		{
133	12	$this->aliases = [];
134
135	12	Collection::from($aliases)
136		->map(function ($alias) {
137	12	return $this->mapAlias($alias);
138	12	})
139		->forEach(function (XmlConvertibleInterface $alias, string $key) {
140	9	$this->aliases[$this->mapKey($key, $alias)] = $alias;
141	9	});
142
143	9	return $this;
144		}
145
146		/**
147		* @return XmlConvertibleInterface[]
148		*/
149		public function getAliases()
150		{
151		return $this->aliases;
152		}
153
154		/**
155		* @param string\|XmlConvertibleInterface $element
156		* @return XmlConvertibleInterface
157		*/
158	12	protected function mapAlias($element)
159		{
160	12	if ($element instanceof XmlConvertibleInterface) {
161	9	return $element;
162		}
163	12	if (!is_string($element)) {
164	3	throw new \UnexpectedValueException(
165	3	"All aliases must be instance or class implements " . XmlConvertibleInterface::class
166		);
167		}
168
169		// Additional type-checking
170	10	return $this->mapAlias(new $element);
171		}
172
173		/**
174		* @param string\|integer $key
175		* @param XmlConvertibleInterface $element
176		* @return string
177		*/
178	9	protected function mapKey($key, XmlConvertibleInterface $element): string
179		{
180	9	return is_numeric($key)
181		? $element->getXmlElementName()
182	9	: $key;
183		}
184
185		/**
186		* @param string $key
187		* @param XmlConvertibleInterface $element
188		* @return bool
189		*/
190	9	protected function getIsAliasMatch(string $key, XmlConvertibleInterface $element): bool
191		{
192	9	if ($this->element->nodeName !== $key) {
193	7	return false;
194		}
195
196	8	return Collection::from($element->getXmlProperties())
197		->filter(function ($property) use ($element) {
198	6	return empty($element->{$property});
199	8	})
200	8	->reduce(function (bool $carry, $property) use ($element) {
201	6	return $carry && $this->element->attributes->getNamedItem($property) != $element->{$property};
202	8	}, true);
203		}
204		}

Horat1us / php-xml-convertible

Push — master ( ea6553...a25652 )

XmlParserService::setAliases() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like