XmlObjectSerializer::serialize() - Code Metrics - Inspection of "Implement objects serialization" - yiisoft/serializer - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 50a6af...21f88b )

by Alexander

created 2020-11-18 13:21 UTC

XmlObjectSerializer::serialize() A

↳ Parent: XmlObjectSerializer

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

declare(strict_types=1);

namespace Yiisoft\Serializer;

use Symfony\Component\Serializer\Encoder\XmlEncoder;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Serializer;

/**
 * XmlObjectSerializer serializes objects in XML format and vice versa.
 */
final class XmlObjectSerializer implements ObjectSerializerInterface
{
    use ObjectSerializerTrait;

    /**
     * @param string $rootTag The name of the root element.
     * @param string $version The XML version.
     * @param string $encoding The XML encoding.
     */
    public function __construct(string $rootTag = 'response', string $version = '1.0', string $encoding = 'UTF-8')
    {
        $this->serializer = new Serializer([new ObjectNormalizer()], [new XmlEncoder([
            XmlEncoder::ROOT_NODE_NAME => $rootTag,
            XmlEncoder::VERSION => $version,
            XmlEncoder::ENCODING => $encoding,
        ])]);
    }

    public function serialize(object $object): string
    {
        return $this->serializer->serialize($object, XmlEncoder::FORMAT);
    }

    public function serializeMultiple(array $objects): string
    {
        $this->checkArrayObjects($objects);
        return $this->serializer->serialize($objects, XmlEncoder::FORMAT);
    }

    public function unserialize(string $value, string $class): object
    {
        $decodedValue = $this->checkAndDecodeData($value, $class, XmlEncoder::FORMAT);
        return $this->denormalizeObject($decodedValue, $class);
    }

    public function unserializeMultiple(string $value, string $class): array
    {
        $decodedValue = $this->checkAndDecodeData($value, $class, XmlEncoder::FORMAT);
        return $this->denormalizeObjects($decodedValue, $class);
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Serializer;
6
7		use Symfony\Component\Serializer\Encoder\XmlEncoder;
8		use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
9		use Symfony\Component\Serializer\Serializer;
10
11		/**
12		* XmlObjectSerializer serializes objects in XML format and vice versa.
13		*/
14		final class XmlObjectSerializer implements ObjectSerializerInterface
15		{
16		use ObjectSerializerTrait;
17
18		/**
19		* @param string $rootTag The name of the root element.
20		* @param string $version The XML version.
21		* @param string $encoding The XML encoding.
22		*/
23	5	public function __construct(string $rootTag = 'response', string $version = '1.0', string $encoding = 'UTF-8')
24		{
25	5	$this->serializer = new Serializer([new ObjectNormalizer()], [new XmlEncoder([
26	5	XmlEncoder::ROOT_NODE_NAME => $rootTag,
27	5	XmlEncoder::VERSION => $version,
28	5	XmlEncoder::ENCODING => $encoding,
29		])]);
30	5	}
31
32	4	public function serialize(object $object): string
33		{
34	4	return $this->serializer->serialize($object, XmlEncoder::FORMAT);
35		}
36
37	1	public function serializeMultiple(array $objects): string
38		{
39	1	$this->checkArrayObjects($objects);
40	1	return $this->serializer->serialize($objects, XmlEncoder::FORMAT);
41		}
42
43	1	public function unserialize(string $value, string $class): object
44		{
45	1	$decodedValue = $this->checkAndDecodeData($value, $class, XmlEncoder::FORMAT);
46	1	return $this->denormalizeObject($decodedValue, $class);
47		}
48
49	1	public function unserializeMultiple(string $value, string $class): array
50		{
51	1	$decodedValue = $this->checkAndDecodeData($value, $class, XmlEncoder::FORMAT);
52	1	return $this->denormalizeObjects($decodedValue, $class);
		0 ignored issues – show Bug Best Practice introduced 2020-11-18 13:14 UTC by Report Bug Copy Issue Report The expression `return $this->denormaliz...($decodedValue, $class)` returns the type `array<mixed,array>` which is incompatible with the return type mandated by `Yiisoft\Serializer\Objec...::unserializeMultiple()` of `array<mixed,object>`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
53		}
54		}
55

yiisoft / serializer

Push — master ( 50a6af...21f88b )

XmlObjectSerializer::serialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like