XmlSerializer::acceptDataAndAppend() - Code Metrics - Inspection of "Fix MaxDepth issue with embeds, fixes #236" - willdurand/Hateoas - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#237)

by Adrien

created 2016-07-21 11:35 UTC

XmlSerializer::acceptDataAndAppend() A

↳ Parent: XmlSerializer

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	10
Ratio	100 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
dl	10
loc	10
c	1
b	1
f	0
rs	9.4285
cc	2
eloc	5
nc	2
nop	3

<?php

namespace Hateoas\Serializer;

use Hateoas\Model\Embedded;
use Hateoas\Serializer\Metadata\EmbeddedPropertyMetadata;
use Hateoas\Util\ClassUtils;
use JMS\Serializer\SerializationContext;
use JMS\Serializer\XmlSerializationVisitor;
use Metadata\MetadataFactoryInterface;

/**
 * @author Adrien Brault <[email protected]>
 */
class XmlSerializer implements XmlSerializerInterface, JMSSerializerMetadataAwareInterface
{
    /**
     * @var MetadataFactoryInterface
     */
    private $metadataFactory;

    /**
     * {@inheritdoc}
     */
    public function setMetadataFactory(MetadataFactoryInterface $metadataFactory)
    {
        $this->metadataFactory = $metadataFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function serializeLinks(array $links, XmlSerializationVisitor $visitor, SerializationContext $context)
    {
        foreach ($links as $link) {
            $linkNode = $visitor->getDocument()->createElement('link');
            $visitor->getCurrentNode()->appendChild($linkNode);

            $linkNode->setAttribute('rel', $link->getRel());
            $linkNode->setAttribute('href', $link->getHref());

            foreach ($link->getAttributes() as $attributeName => $attributeValue) {
                $linkNode->setAttribute($attributeName, $attributeValue);
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function serializeEmbeddeds(array $embeddeds, XmlSerializationVisitor $visitor, SerializationContext $context)
    {
        foreach ($embeddeds as $embedded) {
            $entryNode = $visitor->getDocument()->createElement($this->getElementName($embedded->getData(), $embedded));

            $visitor->getCurrentNode()->appendChild($entryNode);
            $visitor->setCurrentNode($entryNode);
            $visitor->getCurrentNode()->setAttribute('rel', $embedded->getRel());

            if ($embedded->getData() instanceof \Traversable || is_array($embedded->getData())) {
                foreach ($embedded->getData() as $entry) {
                    $entryNode = $visitor->getDocument()->createElement($this->getElementName($entry));

                    $visitor->getCurrentNode()->appendChild($entryNode);
                    $visitor->setCurrentNode($entryNode);

                    $this->acceptDataAndAppend($entry, $visitor, $context);

                    $visitor->revertCurrentNode();
                }
            } else {
                $this->acceptDataAndAppend($embedded->getData(), $visitor, $context);
            }

            $visitor->revertCurrentNode();
        }
    }

    private function getElementName($data, Embedded $embedded = null)
    {
        $elementName = null;

        if (null !== $embedded) {
            $elementName = $embedded->getXmlElementName();
        }

        if (null == $elementName && is_object($data)) {

            $metadata    = $this->metadataFactory->getMetadataForClass(ClassUtils::getClass($data));
            $elementName = $metadata->xmlRootName;
        }

        return $elementName ?: 'entry';
    }

    private function acceptDataAndAppend($data, XmlSerializationVisitor $visitor, SerializationContext $context)

    {
        $context->pushPropertyMetadata(new EmbeddedPropertyMetadata());

        if (null !== $node = $context->accept($data)) {
            $visitor->getCurrentNode()->appendChild($node);
        }

        $context->popPropertyMetadata();
    }
}


1		<?php
2
3		namespace Hateoas\Serializer;
4
5		use Hateoas\Model\Embedded;
6		use Hateoas\Serializer\Metadata\EmbeddedPropertyMetadata;
7		use Hateoas\Util\ClassUtils;
8		use JMS\Serializer\SerializationContext;
9		use JMS\Serializer\XmlSerializationVisitor;
10		use Metadata\MetadataFactoryInterface;
11
12		/**
13		* @author Adrien Brault <[email protected]>
14		*/
15		class XmlSerializer implements XmlSerializerInterface, JMSSerializerMetadataAwareInterface
16		{
17		/**
18		* @var MetadataFactoryInterface
19		*/
20		private $metadataFactory;
21
22		/**
23		* {@inheritdoc}
24		*/
25		public function setMetadataFactory(MetadataFactoryInterface $metadataFactory)
26		{
27		$this->metadataFactory = $metadataFactory;
28		}
29
30		/**
31		* {@inheritdoc}
32		*/
33		public function serializeLinks(array $links, XmlSerializationVisitor $visitor, SerializationContext $context)
34		{
35		foreach ($links as $link) {
36		$linkNode = $visitor->getDocument()->createElement('link');
37		$visitor->getCurrentNode()->appendChild($linkNode);
38
39		$linkNode->setAttribute('rel', $link->getRel());
40		$linkNode->setAttribute('href', $link->getHref());
41
42		foreach ($link->getAttributes() as $attributeName => $attributeValue) {
43		$linkNode->setAttribute($attributeName, $attributeValue);
44		}
45		}
46		}
47
48		/**
49		* {@inheritdoc}
50		*/
51		public function serializeEmbeddeds(array $embeddeds, XmlSerializationVisitor $visitor, SerializationContext $context)
52		{
53		foreach ($embeddeds as $embedded) {
54		$entryNode = $visitor->getDocument()->createElement($this->getElementName($embedded->getData(), $embedded));
55
56		$visitor->getCurrentNode()->appendChild($entryNode);
57		$visitor->setCurrentNode($entryNode);
58		$visitor->getCurrentNode()->setAttribute('rel', $embedded->getRel());
59
60		if ($embedded->getData() instanceof \Traversable \|\| is_array($embedded->getData())) {
61		foreach ($embedded->getData() as $entry) {
62		$entryNode = $visitor->getDocument()->createElement($this->getElementName($entry));
63
64		$visitor->getCurrentNode()->appendChild($entryNode);
65		$visitor->setCurrentNode($entryNode);
66
67		$this->acceptDataAndAppend($entry, $visitor, $context);
68
69		$visitor->revertCurrentNode();
70		}
71		} else {
72		$this->acceptDataAndAppend($embedded->getData(), $visitor, $context);
73		}
74
75		$visitor->revertCurrentNode();
76		}
77		}
78
79		private function getElementName($data, Embedded $embedded = null)
80		{
81		$elementName = null;
82
83		if (null !== $embedded) {
84		$elementName = $embedded->getXmlElementName();
85		}
86
87		if (null == $elementName && is_object($data)) {
		0 ignored issues – show Bug introduced 2015-12-04 15:24 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$elementName` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `===` instead. Loading history...
88		$metadata = $this->metadataFactory->getMetadataForClass(ClassUtils::getClass($data));
89		$elementName = $metadata->xmlRootName;
90		}
91
92		return $elementName ?: 'entry';
93		}
94
95	View Code Duplication	private function acceptDataAndAppend($data, XmlSerializationVisitor $visitor, SerializationContext $context)
		0 ignored issues – show Duplication introduced 2016-07-20 11:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
96		{
97		$context->pushPropertyMetadata(new EmbeddedPropertyMetadata());
98
99		if (null !== $node = $context->accept($data)) {
100		$visitor->getCurrentNode()->appendChild($node);
101		}
102
103		$context->popPropertyMetadata();
104		}
105		}
106

willdurand / Hateoas

GitHub Access Token became invalid

Pull Request — master (#237)

XmlSerializer::acceptDataAndAppend() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like