JMSSerializerAdapter::__construct() - Code Metrics - Inspection of "Merge pull request #1390 from FriendsOfSymfony/INS..." - FriendsOfSymfony/FOSRestBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8a6eb5...d8eda0 )

by Guilh

created 2016-03-12 18:28 UTC

JMSSerializerAdapter::__construct() A

↳ Parent: JMSSerializerAdapter

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * This file is part of the FOSRestBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\RestBundle\Serializer;

use FOS\RestBundle\Context\Context;
use JMS\Serializer\Context as JMSContext;
use JMS\Serializer\DeserializationContext as JMSDeserializationContext;
use JMS\Serializer\SerializationContext as JMSSerializationContext;
use JMS\Serializer\SerializerInterface;

/**
 * Adapter to plug the JMS serializer into the FOSRestBundle Serializer API.
 *
 * @author Christian Flothmann <[email protected]>
 */
class JMSSerializerAdapter implements Serializer
{
    /**
     * @internal
     */
    const SERIALIZATION = 0;
    /**
     * @internal
     */
    const DESERIALIZATION = 1;

    private $serializer;

    public function __construct(SerializerInterface $serializer)
    {
        $this->serializer = $serializer;
    }

    /**
     * {@inheritdoc}
     */
    public function serialize($data, $format, Context $context)
    {
        $context = $this->convertContext($context, self::SERIALIZATION);

        return $this->serializer->serialize($data, $format, $context);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * {@inheritdoc}
     */
    public function deserialize($data, $type, $format, Context $context)
    {
        $context = $this->convertContext($context, self::DESERIALIZATION);

        return $this->serializer->deserialize($data, $type, $format, $context);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * @param Context $context
     * @param int     $direction {@see self} constants
     *
     * @return JMSContext
     */
    private function convertContext(Context $context, $direction)
    {
        if ($direction === self::SERIALIZATION) {
            $jmsContext = JMSSerializationContext::create();
        } else {
            $jmsContext = JMSDeserializationContext::create();
            $maxDepth = $context->getMaxDepth();
            if (null !== $maxDepth) {
                for ($i = 0; $i < $maxDepth; ++$i) {
                    $jmsContext->increaseDepth();
                }
            }
        }

        foreach ($context->getAttributes() as $key => $value) {
            $jmsContext->attributes->set($key, $value);
        }

        if (null !== $context->getVersion()) {
            $jmsContext->setVersion($context->getVersion());
        }
        $groups = $context->getGroups();
        if (!empty($groups)) {
            $jmsContext->setGroups($context->getGroups());
        }
        if (null !== $context->getMaxDepth()) {
            $jmsContext->enableMaxDepthChecks();
        }
        if (null !== $context->getSerializeNull()) {
            $jmsContext->setSerializeNull($context->getSerializeNull());
        }

        return $jmsContext;
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSRestBundle package.
5		*
6		* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace FOS\RestBundle\Serializer;
13
14		use FOS\RestBundle\Context\Context;
15		use JMS\Serializer\Context as JMSContext;
16		use JMS\Serializer\DeserializationContext as JMSDeserializationContext;
17		use JMS\Serializer\SerializationContext as JMSSerializationContext;
18		use JMS\Serializer\SerializerInterface;
19
20		/**
21		* Adapter to plug the JMS serializer into the FOSRestBundle Serializer API.
22		*
23		* @author Christian Flothmann <[email protected]>
24		*/
25		class JMSSerializerAdapter implements Serializer
26		{
27		/**
28		* @internal
29		*/
30		const SERIALIZATION = 0;
31		/**
32		* @internal
33		*/
34		const DESERIALIZATION = 1;
35
36		private $serializer;
37
38	4	public function __construct(SerializerInterface $serializer)
39		{
40	4	$this->serializer = $serializer;
41	4	}
42
43		/**
44		* {@inheritdoc}
45		*/
46	4	public function serialize($data, $format, Context $context)
47		{
48	4	$context = $this->convertContext($context, self::SERIALIZATION);
49
50	4	return $this->serializer->serialize($data, $format, $context);
		0 ignored issues – show Bug introduced 2016-02-04 16:20 UTC by Report Bug Copy Issue Report It seems like `$context` defined by `$this->convertContext($c...t, self::SERIALIZATION)` on line `48` can also be of type `object<JMS\Serializer\DeserializationContext>`; however, `JMS\Serializer\SerializerInterface::serialize()` does only seem to accept `null\|object<JMS\Serializer\SerializationContext>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
51		}
52
53		/**
54		* {@inheritdoc}
55		*/
56		public function deserialize($data, $type, $format, Context $context)
57		{
58		$context = $this->convertContext($context, self::DESERIALIZATION);
59
60		return $this->serializer->deserialize($data, $type, $format, $context);
		0 ignored issues – show Bug introduced 2016-02-04 16:20 UTC by Report Bug Copy Issue Report It seems like `$context` defined by `$this->convertContext($c... self::DESERIALIZATION)` on line `58` can also be of type `object<JMS\Serializer\SerializationContext>`; however, `JMS\Serializer\SerializerInterface::deserialize()` does only seem to accept `null\|object<JMS\Serializ...DeserializationContext>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
61		}
62
63		/**
64		* @param Context $context
65		* @param int $direction {@see self} constants
66		*
67		* @return JMSContext
68		*/
69	4	private function convertContext(Context $context, $direction)
70		{
71	4	if ($direction === self::SERIALIZATION) {
72	4	$jmsContext = JMSSerializationContext::create();
73	4	} else {
74		$jmsContext = JMSDeserializationContext::create();
75		$maxDepth = $context->getMaxDepth();
76		if (null !== $maxDepth) {
77		for ($i = 0; $i < $maxDepth; ++$i) {
78		$jmsContext->increaseDepth();
79		}
80		}
81		}
82
83	4	foreach ($context->getAttributes() as $key => $value) {
84	4	$jmsContext->attributes->set($key, $value);
85	4	}
86
87	4	if (null !== $context->getVersion()) {
88		$jmsContext->setVersion($context->getVersion());
89		}
90	4	$groups = $context->getGroups();
91	4	if (!empty($groups)) {
92		$jmsContext->setGroups($context->getGroups());
93		}
94	4	if (null !== $context->getMaxDepth()) {
95		$jmsContext->enableMaxDepthChecks();
96		}
97	4	if (null !== $context->getSerializeNull()) {
98	4	$jmsContext->setSerializeNull($context->getSerializeNull());
99	4	}
100
101	4	return $jmsContext;
102		}
103		}
104

FriendsOfSymfony / FOSRestBundle

Push — master ( 8a6eb5...d8eda0 )

JMSSerializerAdapter::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like